
Name:		ServerMenuMutator
Version:		1

Author:		{DF}Flyboy
		flyboy@dafunhouse.com

For use by:	Server Admins

Description:
------------------
Have you ever wished you could inform the players on your server, of important information, without them having to hunt for your website?
For example, your server rules, your website details, how to play certain gametypes, or anything else you want?

Well, now you can.

This mutator allows admins, to add a personalised, and in colour, tabbed Information Menu on their server.

(see the examples folder for screenshots).

 
Features:	
----------------
1. A coloured ingame information message (with on/off option and variable timer).
2. An editable Menu Title (coloured).
3. Upto 10 Tabbed pages with editable and coloured titles.
4. 13 different colours to choose and use in your text.

----------------------------------------------------------------------------------------------------------------------------------------------------			
				
Installation Instructions:				
------------------------------------
1. Unzip the ServerMenuMutator.zip file.

2. Edit the ServerInfoMutator.ini file to your liking (see Configuration and Notes).
    (Read the example text already present on Pages9 &10 for anidea of how to do it. Or see Note3 to preview the examples)

3. Upload the following files to your UT2004/system directory:
	ServerMenuMutator.u
	ServerMenuMutator.ucl
	ServerMenuMutator.ini
	
4. Add this to the mutators list:

	ServerMenuMutator.ServerMenuMutator
	
5. Add the following line to your UT2004.ini [Engine.GameEngine] section:

	ServerPackages=ServerMenuMutator
	
6.Restart the server.

7.Join the server and type 'mutate info' in the console to see Your Menu.


How it works:
---------------------
As soon as a game starts, a timed message of your choice will appear to players every 60 seconds, informing them what to type, to see your menu. (this is configurable on/off and what time interval you prefer).

Any player or spectator can open the menu, at any time by typing the following in the console:

mutate info	(and only this, it is not configurable!)

They will then be diplayed with Your Personalised menu, which can contain anything you wish.
For Example:
1. News
2. Server Rules
3. Clan Information
4. Gameplay instructions
5. Website details
	
	
CONFIGURATION:
-------------------------------
Open the file ServerMenuMutator.ini and edit the following as required.

The following shows an example for just 1 page setup (You can have upto 10 pages) :
-------------------------------------------
bShowMessage=True
TimedMessage=Type 'mutate info' in the console for information on this server.
MessageTimer=60

Explanation: This is an editable Timed message (in colours) that players will see every 60seconds (or whatever you change 'MessageTimer' to).
NOTE: The 'TimedMessage' in the .ini at setup is also using colour codes.


IMPORTANT: The menu will only open when 'mutate info' is typed, so it's a good idea to keep that somewhere in your message.
-------------------------------------------

MenuTitle=Your Title
Explanation: The Main Title you want displayed on the Menu window (can be in colours).
-------------------------------------------

bShowPage1Tab=False
Explanaition: Choose which pages you wish to be displayed by replacing 'False' with 'True'.
-------------------------------------------

Page1Tab=YourTabName
Explanaition: Give each Tab your own personalised name (can be in colours).
-------------------------------------------

Page1Text=//--Write your Text below....DO NOT REMOVE THIS LINE!!
Page1Text=	

Begin by writing your text on the 2nd line of the Page you wish to have text in (Leave the 1st line untouched as this is never displayed!!).
When you are ready to start a new line in your text, add a new line 'Page1Text=' in the .ini and begin with the 'Line Break' character (shown in Note1). This will make the text start on a new line. 
To have spaces between your lines (for paragraphs etc.), insert 2 'Line Breaks' (or more if you wish).
Add the colour codes from Note2 to make your text multicoloured.
-------------------------------------------


NOTE 1:
-------------
To create a new line or paragraphs, insert the 'Line Break'  character (or copy and paste it from here).

|	=Line Break


NOTE 2:
-------------
You can add colours to all the editable text in the ServerMenuMutator.ini by copying and pasting the following codes in front of the words or letters (or between letters if you want multicoloured words).

Colour codes:

7t	= Blue
@	= Dark Blue
	= White
	= Red
	= Green
@	= Off Green
	= Skin
	= Maroon
	= Gold
	= Yellow
OOO	= Dark grey
	= Cyan
	= Hot Pink

NOTE 3:
-------------
For a quick example, just edit the following lines of the ServerMenuMutator.ini:

bShowTab9=False
bShowTab10=False

Change to:

bShowTab9=True
bShowTab10=True

The text already present can of course be deleted and edited to your choice.

NOTE 4:
-------------
For some reason that I couldn't fix, the menu will always display the last tab added (numerically) when first opened.
So, if you have an important page, ensure it is the last one. 


***************************************************************************************************************I hope this is of some use to you.
Any comments or suggestions, please email me (please be gentle though, this is my first mutator).

{DF}Flyboy
Website:	www.DaFunhouse.com
Email:	flyboy@dafunhouse.com


**************************************************************************************************************
CREDITS:
I must give Credit to jwalstra because I got most of the code for this mutator by sifting through his SA2k4 Sniper Rifle mutator (as well as hours of searching the web for answers).
**************************************************************************************************************













