UT2Vote50
                                 (c) ProAsm 2005
                              [email protected]

http://www.unreal.co.za/proasm


Team
                           Socke  PoW      Imaginos
                           sh0V3L frogger  hmishima
                           CvRoy  Mephisto tuco
                           Nikki  De$tiNy  Yakomo

Other UT2Vote50 information.

UT2Vote_Public_Forum
 German_Admin_Forum
 Detailed_Manual_in_German_and_English
Download_GameMake3_for_UT2Vote50


================================================================================

Index
              Installation        Ini_file_settings
              Clientside_settings Clan_Setup
              ServerPackages      Adding_extra_Games_and_Mutators
              Changes_in_5.0













Installation


NB. Dont forget in the UT2004.ini file to add...

[Engine.GameEngine]
ServerPackages=UT2Vote50
 The following files need to go in the UT2004 System folder:
UT2Vote50.u
UT2Vote50.int
UT2Vote50.ucl
UT2Vote50.ini

UT2Vote50 needs to be added as the only Mutator in your Server startup
commandline as UT2Vote handles all the mutators once it is loaded, so its best
to not have any commands in start up except multihome if needed or specifying
ini= or as some server companys insist maxplayers= as UT2Vote takes over the
command options.

Single Server
ucc server CTF-Maul?Game=xGame.xCTFGame?Mutator=UT2Vote50.UT2VoteX etc..


Multi Servers
ucc server CTF-Maul?Game=xGame.xCTFGame?Mutator=UT2Vote50.UT2VoteXMulti etc..

The Multiserver system will create new configs in the Server.ini file or the
configs can be copied and pasted from the UT2VoteXMulti.txt file.
You also need to add UT2Vote50 as a Serverpackage in the servers UT2004.ini file
although UT2Vote50 will add itself now if it cannot find itself in the
Serverpackages.
[Engine.GameEngine]
ServerPackages=UT2Vote50

Brief Setup
UT2Vote requires this information to be entered at the following places:
ServerMuts=
Mutators that will be common to ALL games must go in here.
For example:
ServerMuts=ServerBots.ServerBots,UnrealGame.MutLowGrav,XGame.MutNoAdrenaline
Note: A Mutators ClassName can be found in the .ucl file supplied with the
mutator.
ServerLine=
Any commandline commands that you need for all games should go here, for
example:
ServerLine=?AdminName=Admin?AdminPassword=xxxxx?Translocator=True
Any commands entered here will take priority and over ride the GameType
Commands=
VoteAdminPass=<
This is the Main Admin password and will give this Admin full rights to
accessing anything in UT2Vote.
ClanAdminPass=
This password is for Clan Leaders who can setup the server for a dedicated
ClanMatch.
This Admin will not have access to the general Admin settings of the server.
GamePassword=
If the Games on your server requires ALL players to logon with a Game Password,
that password should be entered here.
DefaultGame=
Whatever you choose to be your Server DefaultGame needs to be entered here.
If you leave it blank, UT2Vote will enter the game from which your Server first
starts up in.
Example:
DefaultGame=XGame.xDeathMatch
When players have all left your server and it is not in a default state, UT2Vote
will switch your server to this Default Game State.
DefServername=
Enter the name of your server here. Although UT2Vote can change this ingame,
should there be an error, it will default back to this name.
You are now ready to startup your Server.
Once your server is running, join the Game and login as Admin:

Mutate UT2VoteLogin(the VoteAdminPass)
Press the Map Menu Hotkey (normally set on the ScrolLock and/or Home Key) and
once the menu is up, click on the Admin button and you will start seeing the
world at your fingertips.
NB.. Almaost all Admin changes will need a level restart.
                                  Back_to_Top









                            The UT2Vote50.ini file


              Ini file information and configurations


              Select a Setting Header

                               UT2VoteConfigs
                               UT2VoteVoting
                               UT2VoteIniOnly
                               UT2VoteGameTypes
                               UT2VoteMutators
                               UT2VotePackages
                               UT2VoteMapCheck
                               UT2VoteGameSwitch
                               UT2VoteNewMaps
                               UT2VoteKickBan
                               UT2VoteMapInfo
                               UT2VoteMapsVoted
                               UT2VoteMessages
                               UT2VoteClanSetup
                                  Back_to_Top
================================================================================













 [UT2Vote50.UT2VoteConfigs]

VoteAdminPass=
This password will give this Admin the same powers as the ServerAdmin.
In other words he/she will have access to anything and everything at any time and can login in with:
Mutate UT2VoteLogin password

Please Note... all the following settings are available ingame in the Admin Menu

ClanAdminPass=
 This password will give this Admin the powers to only setup a game for a Clan Match.
Here he will be able to select the GameSetup Menu and do the necessary configurations for a match -
again:
Mutate UT2VoteLogin password

NB.. Admin no longer loose there Adminship when they die.
Logging out as Admin
Mutate UT2VoteLogout

GamePassword=
 This password is the general Game Password which all players will need to logon onto your Server.
As there was much confusion in version 1.6 about this password it was decided to have a special
dedicated place for it.

DefaultGame=
 This is whatever you want your server to be as the default game and UT2Vote will set this up for
you.
Whatever game you are running the very first time you start UT2Vote it will use that name as your
default.
This can be changed at any time by you logging on as Main or Server Admin then calling up the Admin
Menu:

You will see a checkbox (Set as Default Game) - just tick it and hit submit.
Basically now what happens is every 2 minutes UT2Vote checks your server to see how it differs from
the default.
If there are no players on the server and a voted mutator is running and its not the default game,
it will switchyour server back to the default game and remove all voted Mutators and Arenas etc.
When the server switches back to DefaultGame automatically, it will always switch to its Default Map
which is setup in its appropriate GameType - see Game Configurations.

DefServerName=
 Here you enter a default name for your Server.
Sometimes with Clans changing the server name or a game with a servername that may have an illegal
character in it, UT2Vote will then revert back to the DefServerName.

ServerMuts=
 Mutators that will be common to all games should go in here.
If you have more than 1 Mutator, seperate them with a comma.
Please note also that the ServerMuts must only have Mutators in it.
If you have extra commandline parameters they must go in the ServerLine= - see next item.

ServerLine=
 All commandline paramaters (ie. ?AdminPassword=Whatever) that are common to all games must go here.
Any command you have here will over ride a Game command as the ServerLine has higher priority.
Every command parameter must start with a ? (question mark).

bAllowMuts=
bAllowArena=
bAllowGames=
bAllowKick=

 Setting these to True or False specifies whether they can be votable or not. Defaulted as True.

bNoVotePopup=
 Defaulted to False, but setting it to True will disable the MapVoteMenu poping up at Game End and
instead it will just momentarily display a < Mutate UT2VoteMenu to Vote > for the players
information.

bDoGamePopup=
 Defaulted to False, but setting it to True will force the Map Menu window to popup anytime during a
game when someone decides to make a vote. Having this set to True can be very annoying to the game,
but some prefer it that way :)

bShowBotsKick
 If set to True the Bots will appear in the Kick Menu and can be voted out the game.

bAllowBehind=
 When set to True it will allow Players to use 3rd person viewing in the games. BehindView 1

bVoteWhenDead=
 If set to True, then players can vote before the Game starts and while they are dead.

bNoRestart=
 If set to True, players will not be able to vote for a Restart at Game end.

bWebAdmin=
 If set to True, then then all Mutators and non UT2Vote Games will not be seen in WebAdmin.
This is a safegaurd against Mutator clashing but should only be set to True if UT2Vote50.UT2VoteX
is set in the server startup commandline.

bHideNames=
 If set to True, then when a player makes a kickvote his nickname will remain anonymous and so will
the players that voted Yes.

bAltSwitch=
 With the many mutators now available and adding them all to the commandline sometimes causes UT2004
to lockup duting level changes. This function will eliminate this problem

bMutAlone=
 Will allow a single player on your server to switch Mutators

bArenaAlone=
 Will allow a single player on your server to switch Arenas

bAlwaysKick=
 During the Game and once the Voting timelimit has expired and the play calls for the normal
VoteMenu, the KickVote menu will pop up instead.

bDisDemoRec=
 This will disable UT3Vote Admins from starting a Demo recording.

bColorSkins=
 A DeathMatch game will use team color skins.

bMinMaxMaps
 If this is set to True then the game will only show those maps the are suitable for the current
number of players as defined in the:
[UT2Vote50.UT2VoteMapCheck]
CheckMap=(MapName="DM-Smallmap",MinPlayers=0,MaxPlayers=4)
CheckMap=(MapName="CTF-Hugemap",MinPlayers=10,MaxPlayers=50)

bDisAllVoting
 If this is set to True then Players will not be able to vote anything.
Only Admins will have access.

bDisServAdmin=False
 If set to True, the ServerAdmin will not be allowed to configure UT2Vote menus.

bDisOpinion=False
 If set to True, the map Opinion button will be disabled in the Map Menu.

bDisAdminMesg=False
 If set to True, the Admin Message button will be disabled in the Map Menu.

bClanServName
 If set to False, then Clans cannot change the Servername in the Setup Menu.

bUseChatLog=
 When set to True, all player typed messages will appear in server log file
The format being:
UT2Vote_ChatLog: Date:Time - Nickname - Message

bUseChatMap
 If set to True, then the ChatLogs will be appended to MapNames rather than one big log.

bUseChatIDs=
 Will allows the players Unique ID to be logged in the Chatlog

bSwitchDefMap
 If set to True, then after 3 minutes if there is no players on a server it will switch to the
DefaultMap.

bUseRandomMap=False
 If set to True, then when a vote times out and the vote fails, UT2Vote will choose a Random map
from the Server maps folder or List instead of the Default map.

bUseUniqueID
 If set to False, then UT2Vote will track players by their normal Player IDs rather than their CD-
Key IDs
This is usefull for LAN games where several players use the same CD-Key.

MesgTypeTime=
 Many players have complained on how the popup menu interrupts their Say messages at the end of the
Game.
Basically what happens now is UT2Vote will first look to see that everyone has finished typing their
messages before poping up the VoteMenu. In other words if anyone is typing a message when its time
to popup the Menu, UT2Vote will send that person a message:
**** Finish your message - Voting Time ****
UT2Vote will now wait another 10 seconds before it checks again.
Everytime it checks for someone typing it will also check the TypeTime you set above and if this
TypeTime has expired, the VoteMenu will popup regardless of who is still typing and send those
people a message:
**** Sorry - Time Up ****


                                          Back_to_Headers
====================================================================================================





 [UT2Vote50.UT2VoteVoting]

 bChangeVote=
 This allows players to change their vote once during a voting session.

VoteMinTime=30
 The total amount of time allowed before Voting timeout for 2 Players.

VoteMaxTime=120
 The maximum Voting time allowed regardless how many players are on the server.

VoteStepTime=7
 The additional time allowed for every Player that joins the Server after the VoteMinTime.

VoteIdleTime=15
 After everyone has Voted, this is idle time waited for someone to change there vote.
If no further votes are made the VoteMaxTime will be forced and the vote will be decided.
If however someone makes a vote a further Idle Time will be set.

GameVoteLimit
 The number of votes a player can make during a game.

GameVoteTime=
 This is the time in minutes allowed from the START of a game that players can call a vote.

VotePercent=
 This is the accepted percentage to pass a vote ONLY during game voting.


                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteIniOnly]

NB.. The following settings are Ini file settings only and fall under the heading:

 bStandardServer=True
 This will enable your server to be displayed as a Standard Server

bDisplayRec
 If set to True it will display when a Demo recording starts.

bSortOpinion
 If set to True, this will display the Voted maps in Opinion order rather than Voted order.

bCheckMaps
 If set to True, this will look through a players maplist to see if he has all the server maps.
Those maps he does not have will not be displayed in his Map List.

bDisMapCon
 If set to True, then when a Map Menu is called, the clients Console will not be cancelled.

bUseGameName
 If set to True, then the GameName used in the GameType string will be displayed in the Games
ScoreBoard.

bNoClientWarn
 If set to True, a Players not receive a warning notice when logging onto UT2Vote the first time and
their client settings have not been done.

DefaultSwitch
 This is the time in minutes from 0 to 9 that the server checks whether there are any players on the
server and if not, switches to the Default Game and also if bSwitchDefMap=True to switch to the
Default Map.
If DefaultSwitch=0 then this option will be disabled.

BanMinLevs=
 The minimum amount of levels players can be kick banned for.

BanMaxLevs=
 The mmaximum amount of levels players can be kick banned for.

bDetectUTComp=False
 If set to True, then some things will be disabled in UT2Vote.

bAdminAtEnd=False
 If set to True, then the UT2Vote Admin will be allowed at GameEnd during a voting process.

bSortMutsList=True
 This will sort the ini files Mutator list alphabetically.

bNoPlayerMute=False
 This will disable muting of players by the VoteAdmin.

MapCheckSpecs=False
 When using the [UT2Vote50.UT2VoteMapCheck] and this is True, Spectators will be added to the
MaxPlayer count.

bSortGameList=False
 This will sort the ini files GameList alphabetically.

bUseChatIcons=True
 This will enable a UT2Vote chaticon.

MapListSort=0
0 = Alphabetical A - Z listings.
1 = Alphabetical Z - A listings.
2 = As in list - best if UseMapList=True
3 = Random selection on each level.


WaitForLevel=90
 The time UT2Vote will wait for a level changeover before initiating a restart.

MaxPlayersIsp=32
 The number represented here is the Maximum number of Players and ISP will allow for any Game.
For those that do not have a server through an ISP just leave it as 32


                                          Back_to_Headers
====================================================================================================





 [UT2Vote50.UT2VotePackages]
 Packages=(MutClassName="Whatever.MutWhatever",ServerPackages="Whatever,Whatnext")

 Mutators that are votable or that you have added to various GameTypes can be placed here.
Mutators will now only be pushed to the client when the Mutator is selected or voted for.
This saves each client having to download a multitude of mutators everytime they join your Server.
A Mutator can also have several ServerPackages and they can just be added to the above
ServerPackages= and must be seperated with a comma.
All Mutators that appear in the ServerMuts= MUST be declared in the UT2004.ini ServerPackages=


                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteMapCheck]
 CheckMap=(MapName="DM-Smallmap",MinPlayers=0,MaxPlayers=4)
CheckMap=(MapName="CTF-Hugemap",MinPlayers=10,MaxPlayers=50)


If bMinMaxMaps=True then only these maps will show in the Map Menu depending on the number of
Players currently on the server.
In the above example, if your server has less than 5 players then only maps where MaxPlayers= is
less than 5 would display.
On the other hand, you would need more than 9 Players and less than 50 for the second example to
show.
NB. It is possible to have no maps showing so be carefull when defining the maps in this section


                                          Back_to_Headers
====================================================================================================





 [UT2Vote50.UT2VoteGameSwitch]
 SwitchToGame=(SwitchHour=12,ClassName="XGame.xDeathMatch",DoSwitch=True)
SwitchToGame=(SwitchHour=15,ClassName="XGame.xCTFGame",DoSwitch=True)

 At 12:00 if DoSwitch=True then XGame.xDeathMatch will become your DefaultGame and the server will
switch to it 3 minutes later if there are no players on the server.
The same will happen with xCTFGame at 15:00
You can have up to 16 GameSwitches per day.


                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteNewMaps]
 NewMap=(MapName="DM-Whatever")
 Admin can add mapnames here which will display in the NewMaps Menu.
Normally only the latest maps on the server should go here.
NB... Make sure the spelling is correct as these maps are voteable by players.


                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteKickBan]
 BanPlayer=
(NickName="Whatever",UniqueID="4230fdb7a6cafda49fed3f4200fa97cc",IPaddrs="123.123.123.123",Levels=5)
 This section is used internally and stores all the information from Players that have been kicked
off, or voted off your server.
The only time you will set anything manually here is if you want to ban someone on a permanent basis
by setting Levels=111

                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteMapInfo]

This is used internally by UT2Vote

                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteMapsVoted]

This is used internally by UT2Vote

                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteClanSetup]

This is used internally by UT2Vote for Clanmatch Setup configurations

                                          Back_to_Headers
====================================================================================================





[UT2Vote50.UT2VoteMessages]

This is used internally by UT2Vote for storing messages sent to the Admin from players.

                                          Back_to_Headers
====================================================================================================










                                   UT2Vote50

Clientside configuration settings

In the User.ini file you will see the followingand are all available in the
ClientMenu

 [UT2Vote50.UT2VoteClient]
bDefineSetup=True
bNoWeaponNames=True
bEndScoreBoard=False
bShowSpectators=True
bEndGameShot=False
bNoAnnouncer=False
bDisableHomeKey=False
bDisplayTime=False
bAnnounceHoly=False
AnnouncerType=2

 bDefineSetup=
This is not user configurable and is used internally.

bNoWeaponNames=
This is already available by UT2004 but needs adding for it to function.
This just basically forces the issue a bit.
When the player switches between weapons the big colored nametag wont appear.

bEndScoreBoard=
When this is set to True, the game end ScoreBoard will be forced onto your
screen.

bShowSpectators=
When this is set to True, up to 8 Spectators will be displayed in the
ScoreBoard.

bEndGameShot=
If set to True, an endgame Screenshot will be taken.

bNoAnnouncer=
When this is set to True, all countdown Announcers will be disabledt.

bDisableHomeKey
When this is set to True, the Homekey hotkey will be disabled.

bDisplayTime=
If True, this will display the local time in the Hud near the bottom.

bAnnounceHoly=
When this is set to True, the announcer will say HolySh*t after voting count
down.

AnnouncerType=
Can select up to 6 Announcers.

================================================================================

Other Client Options

VoteMenu KeyBind
Click this button to set a keybind for activating UT2VoteMenu on any key you
wish.

ClanReady KeyBind
Click this button to set a keybind for activating Ready at the end of a Clan
Warmup.

Spectator Mode
Click this button to switch to spectator mode.

Demo
Click this button to start a Clientside Demo of the current game.

                                  Back_to_Top
================================================================================








                                   UT2Vote50

Clan Setup

 Setup
The Setup Menu can now be used regardless what Game is currently being played.

Voting
Voting for Clan Matches has been removed completely as its basically never used
and with the new Majority vote system does not work too well for Clans.

ClanPassword
If the ClanPassword is now omitted, the GamePassword will be used if there is
one.

Games
Up to 3 Games can now be pre-setup for a Clan match.

Overtime
There is now an option which will end a Game if the Teams have Tied.

Server Name
Clan Admin have the option of setting a custom Server Name for the match.
However there is a bClanServName=True in the IniOnly section and if set to False
the Server Name option will be disabled and the normal -[ClanMatch] added to the
current Servername.
NB.. The Server Name option will only work if a Password is set.

Clan Names
Clans can now enter their Clan Names and these will be displayed for the
screenshot at the end of the match instead of the normal Blue Team and Red Team.

Mutators
Clan Admin now have the option to add Mutators to their matches for each
seperate Game played.

Client Menu
Except during a Warmup, Clans will have access to the Client Menu if the Map
Menu is called.

DeathMatch
When a Game starts UT2Vote will check if its a Clan Match and if it is, it will
check if its a Team Type Game and not a DeathMatch Game, and if its a DeathMatch
Game, the game will Abort with a message and go onto the next Game or reset the
Game back to its default state.
This now also a Clan=False option in the GameType string so that ClanAdmin
cannot see a DeathMatch type game in the Clan Setup

End Map
When this button is clicked by the Clan Admin, the current map will be canceled,
all scores cancelled and the match will switch to the next map if there is one,
end the match or else reset back to default.

End Match
As before - this will end the Match and reset the game back to its default
state.

Swap Teams
Should Teams wish to swop colors for a particular Map, it has to be done with
this button else the scoring system will loose track and award the wrong points
to the wrong Team. Teams will swap instantly with this button.

Warmup Display
This will now permanently be displayed during a Warmup regardless whether in Hud
or ScoreBoard and also ONLY during a Clan Warmup will the ScrollLock key be
Hardwired for a Ready State and the display will be: << Warmup Period - Press
ScrollLock when Ready >>
Players can ofcourse still use their Home or whatever key is bound to
UT2VoteMenu.

                                  Back_to_Top
================================================================================








                                   UT2Vote50

Changes in 5.0

bDisOpinion
Fixed the bug where the Admin could not disable the Opinion vote.

Client logon
If a new version of UT2Vote is encountered, the logon delay message has been
enhanced.

bNoPlayerMute
This has been added incase and Admin does not want players muted.
It also doubles up to help disable the BroadcastHandler incase of problems (see
below)

BroadcastHandler
The Zound50 BroadcastHandler is now being used in UT2Vote also to keep the 2
mods compatible with each other.

MapCheckSpecs
Added MapCheckSpecs in IniOnly section.
When using the [UT2Vote50.UT2VoteMapCheck] and this is True, Spectators will be
added to the MaxPlayer count.

bUseChatIcons
When set to True, A Chaticon will appear over a players head when chatting.

UT2VoteGameSwitch
Fixed where this function was not working.

CancelVote
Added this button in Map Menu for Admin.

Clear All
Added this button in Clan Sertup Menu for Admin to clear all current setups if
he made a mistake.

Clan Warmup
This now auto cancels in Onslaught and VCTF.

CancelVote
Added this button in Map Menu for Admin.

                                  Back_to_Top
================================================================================








                                                  UT2Vote50

Adding extra Games and Mutators

 Adding extra Games

[UT2Vote50.UT2VoteGameTypes]

Please Note:
The GameType= strings supplied with UT2Vote must under no circumstances be removed or duplicated in any way.
If an Admin wishes to duplicate a GameType with extra Mutators etc, then he/she needs to use GameMake3 which
is specially designed to do this job in UT2Vote50.

http://www.unreal.co.za/files/other/GameMake3Setup.zip


Should an Admin not wish the Players to see or vote for any of these games, simply set HideVote=True in the
string.

GameType=(GameName="Capture the
Flag",HideVote=False,Clan=True,RequiredPlayers=2,MapLimits=0,ServerName="None",UseMapList=False,
                    DefaultMap="CTF-
Chrome",MapPrefix="CTF",AltMapPrefix="",GameClass="XGame.xCTFGame",Mutators="",Commands="?GoalScore=5
                   
?TimeLimit=20?MinPlayers=2?MaxPlayers=17?MaxSpectators=2?Translocator=True?Weaponstay=True?BalanceTeams=True?
                   
ForceRespawn=False?PlayersMustBeReady=False?Difficulty=5?GameStats=False?GameSpeed=1.00?FF=0?NumBots=3")

 Adding extra Mutators

 [UT2Vote50.UT2VoteMutators]

Just copy and paste more strings here but be very carefull about the correct MutClassName representing your
Mutator.
These Mutators will also show in the Mutator Menu if HideVote=False
Mutator=(FriendlyName="Whatever ",HideVote=False,MutClassName="Whatever.MyMut",Voted=False)

                                                 Back_to_Top
=============================================================================================================






[download file as is] (last changed: Sun, 17 Apr 2005 07:42:46 -0500)