================================================================
=          UT Global Login & UT Global Login Advanced          =
=             by )DoE(-AnthraX & ViRioN  2004               =
================================================================

1) What is UTGL/UTGLA?
----------------------

	- First of all, I'd like to say: Please read this document,
	I've made it quite simple to read and it will save you AND me
	a lot of trouble if you just take a 5 mins break to read this
	stuff.

	- UTGL was started as an attempt to stop fakenickers 
	ruining the fun on public servers. UTGL itself is just a login
	system that can be used by every serveradmin, but as you will
	see, UTGL can be very useful for unrealscript coders too.
	Eg: I made another mod called UTGL Advanced (a UTGL addon) that
	will greatly extend the functionality of UTGL on your server
	(will be explained later)
	
2) How does it work?
--------------------

	- UTGL consists of two parts:
	1) A dedicated UT Server, connected to the internet with the
	   UTGL serveractor running on it
	2) A masterserver, which is a webserver with registration/
	   login/ban scripts running on it.
	   ( http://utgl.unrealadmin.org )
	   
	- When a player tries to join a server with UTGL running on it,
	a login window will show up. The player is now asked to enter
	his UTGL Login and Pass OR if he/she doesn't have a UTGL account
	yet, then this player can press the "register button" which will
	take him/her to the registration page. As soon as the login/pass
	are entered, the player can press enter or press the login button,
	now the login and pass will be saved in the user.ini and a login
	request will be sent to the UT Server. The UT Server now connects
	with the masterserver and checks 3 things:
		1) Is it a valid UTGL Account
		2) Does the player have admin rights on this server
			(only if bUseExtras is set to true in the config file)
		3) Isn't the player banned on this server/on the network
			(only if bUseExtras is set to true in the config file)
	Once these checks are done, the masterserver will reply to the UT
	server, the reply will be parsed and the login window will dissapear.
	If the player fails to login within 30 seconds, he will be kicked from
	the server.
	
3) About the adminrights
------------------------

	- Getting adminrights on a certain server is easy. You have to install
	UTGL on it and boot the server, the first player that logs in trough
	this UT Server will be granted admin rights.
	
	- These adminrights can only be used (for the moment) if you use UTGL
	Advanced on your server. If UTGLA is running, any player with adminrights
	will be able to start the adminwindow by typing "mutate aw" in his console
	
	- Working with the adminwindow is quite simple. You can do the following
	things with it:
		1) Make a warning window popup at the screen of the player you
		selected. This is useful to warn the player for assrunning/laming/...
		without starting a flame-war on the server. (use the "warn" button)
		2) Putting the player you selected on the next team.
		(use the "swap" button)
		3) Kick the player you selected and make the reason appear in
		his console (use the "kick" button)
		4) Ban the player's login from this server (use the "ban" button)
		5) Ban the player's login from all servers you have admin rights
		to (will be explained later - use the "network ban" button)
		6) Mute a player so he can't send textmessages anymore

4) About banning
----------------

	- There are three types of bans that can be used during beta-testing:
	"Local bans", "Network bans" and "Listed Network bans".
	
	- Local bans:
	  By pressing the "ban" button in the adminwindow the player's login will
	  be sent to the masterserver. The masterserver will now store this ban in
	  the banlist of the server that sent the ban.
	  
	- Network bans:
	  By pressing the "network ban" button in the adminwindow the player's login
	  will be sent to the masterserver. The masterserver will now look up which
	  admin has sent the ban request and on which servers this admin has admin
	  rights, now the masterserver will store the ban in the database and the
	  banned player won't be able to join any server that is under the command of
	  the admin that banned him. This is similar to the "GSP Ban"-function of
	  "UTAN" (cfr. http://utan.unrealadmin.org )
	   
	- Listed Networkbans:
	  You cannot manually "listed networkban" a player. This function is implemented
	  to stop cheaters. At the moment any player caught with a helios hook by UTDC
	  will get a listed networkban. Once a player gets a listed networkban, he will
	  get a standard networkban but his ban will also be exposed in a cheaters list.
	  
	- Removing/Editing/Viewing bans, Login tracking, ...:
	  Stuff like this can all be done trough the masterserver, point your webbrowser
	  to http://utgl.unrealadmin.org and login. Then you can click the "my servers"
	  link which will allow you to manage your servers.

5) About UTGLA:
---------------

	- UTGLA was originally a part of UTGL but I've split up the package to allow
	other coders to use UTGL without having to use all of the UTGLA functions.
	
	I haven't said much about UTGLA yet although it's functionality is quite great:
		1) UTGLA contains the UTGL adminfunctions (adminwindow/banning/...)
		2) UTGLA contains a special scoreboard for the following gametypes:
			- Deathmatch
			- Domination
			- Capture the flag
			- Assault
			- Last man standing
			- Bunnytrack
			- Every mod that has the same scoreboard as TDM
		  These scoreboards will show Netspeed, packetloss, efficiency, accuracy
		  (even in NW!), Frags Per Hour, Login, Mute-status, clickboard.
		3) UTGLA contains a special hud for rocketarena. The rocketarena mod
		is well written but it isn't flexible at all, it's almost impossible to
		make something rocketarena-compatible, that's why I'm using a hud that
		will draw all logins to the screen instead of a scoreboard.
		4) UTGLA allows you to whois a player ("mutate whois <playernick>" in your
		console) so you can see all nicks he has played with using the same login.
		5) UTGLA also contains several minor functions that could be useful for
		other coders (eg. SuperWebAdmin by Rush is compatible with UTGLA :))
	
7) Installation instructions
----------------------------

	- First unzip all .u files to the system folder of your server.
	- Now shut down your server, open the UT.ini file and add these lines under
		[Engine.GameEngine] :
		ServerActors=UTGLv10b.GLActor
		ServerPackages=UTGLv10b
		ServerPackages=UTGLConfigv10
		
	if you want to use UTGLA too, then add this under it:
		ServerActors=UTGLAv03d.GLAServerActor
		ServerPackages=UTGLAv03d
		
	then you move to the end of the ini file and add these lines:
	
		[UTGLv10b.GLMutator]
		webIP=utgl.unrealadmin.org
		webPort=80
		webTimeout=10
		webPath=/check.php
		webInfoPath=/getmatchinfo.php
		regURL=utgl.unrealadmin.org
		bDisableInTournament=false/true     # Do you want to enable logins during tournament?
		bUseExtras=false/true               # Use Adminrights/banning or not?
		bBroadcastEvents=false/true         # Broadcast playerlogins/kicks/bans?
	
	if you want to use UTGLA too, then add these too:
		
		[UTGLAv03d.GLAMutator]
		webIP=utgl.unrealadmin.org
		webTimeout=10
		webPort=80
		webBanPath=/ban.php
		webMOTDPath=/motd.php
		webWhoisPath=/whois.php
		webLogin=xxx                        # Only for use with SuperWebAdmin
		webPass=xxx                         # Only for use with SuperWebAdmin
		
	Now reboot the server and be sure that you are the first one to login on the new server.
	If you don't login first, you WON'T be granted admin rights.	
	
		
8) Changes History
------------------
	
	* UTGL:
		- v1.0b:
			* [Fixed] some timeout errors (which caused double/triple logins)
		- v1.0: First official release
	
	* UTGLA:
		- Beta v0.3d:
			* [Fixed] Netspeed didn't show correctly
			* [Fixed] Some code optimisations
			* [Changed] Bunnytrack board is just a custom version of the regular CTF board now
		- Beta v0.3c:
			* Failed attempt to fix a netspeed bug
		- Beta v0.3b:
			* [Fixed] Accessed none's in serverlog
			* [Fixed] Some more minor stuff
		- Beta v0.3: First official release
		
	
9) Feedback/Suggestions/Support
-------------------------------

	- The UTGL team consists of two people at the moment:
		1) AnthraX : Unrealscript coder
		2) ViRioN  : PHP/SQL coder + website admin	

	- For all your questions, contact us on the UTGL forum @ http://www.unrealadmin.org
	
10) Copyrights
--------------

	- As UTGL/UTGLA contains quite a lot of code that no other mods have at this moment,
	I understand that some people would like to use some of it. At the moment you're not
	allowed to do that as UTGL/UTGLA isn't finished yet.
	
11) People I'd like to thank
----------------------------

	- Oc3lot                 : for making the nice logo
	- Rush                   : for betatesting/feedback
	- Azazel/Unrealadmin     : for hosting our masterserver
	

		
	
	

