UT2Vote give the admin and the players the ability to vote on many different aspects of the games, way beyond just simple map changes.
//================================================================= // UT2Vote15 - (c) ProAsm 2003 // http://www.unrealza.co.za/proasm // email: firstname.lastname@example.org //================================================================= NB.. Dont forget :-) [Engine.GameEngine] ServerPackages=UT2Vote15 1. Installing UT2Vote15 ==================== UT2Vote now comes as a complete package to the Admin, and needs to be installed correctly for everything to function properly, although if you do not have any extras the default setup should suffice. Just unzip the contents into the UT2003Server\System folder. Most configurations can be done ingame using the AdminMenu although if you like, everything can be done manually in the UT2Vote15.ini file. It is advised that UT2Vote15 starts with the server command as follows: ucc.exe Server DM-Antalus?Game=XGame.xTeamGame?Mutator=UT2Vote15.UT2Vote etc... It is also advised that no other Mutator or anything gets added to the command line as once UT2Vote takes over all the extra will get dumped. If you are using UTSecure it should be installed as a ServerActor and not a Mutator but if you want to install it as a Mutator, then it should get added into the UT2Vote ServerMuts and not the command line, although if you add it to the command line then it must also be added to the ServerMutse See General Configurations about ServerMuts. UT2Vote15 MUST be added to your UT2003.ini ServerPackages= or whatever ini file you use on your server. Remember, you MUST stop the server to do this and cannot just change and upload a new file. [Engine.GameEngine] ServerPackages=UT2Vote15 Please Note... When your server starts UT2Vote will look to see if its in the ServerPackages and if it cannot find itself, it will add itself and then exit the server, so make sure you have a loop startup. UT2Vote Startup Changes UT2Vote now has the intelligence to know whether it started a level or some other means was used. For instance, the Server was just restarted, or an Admin switched a level from WebAdmin, or the Server just timed out for some odd reason and selected some random level, UT2Vote sees this now and will initiate a UT2Vote Level Restart so all the correct parameters and configurations are used as WebAdmin or any other means of a Level Restart normally bypasses all the commandline etc. So if you initiate a Level Restart from WebAdmin, the Level will actually restart twice, once from WebAdmin and a second time from UT2Vote. In this way, the game always has the correct parameters set and that is why it is important that the Server Startup Commandline, the ServerMuts and the ServerLine is setup correctly in UT2Vote15.ini See General Configurations for ServerMuts and ServerLine setup. 2. Explanation of the UT2Vote15.ini file setup: ============================================ As UT2Vote is now a complete package it is devided into several sections: [UT2Vote15.UT2Vote] This section covers the General configurations and effects all games and is universal to the package. [UT2Vote15.UT2VoteGameTypes] This is probably the most important section and much time will be spent setting these up, although UT2Vote15 does come with 80% of the default game configurations already setup for you and any changes can be made in the Admin Menu or done manually here before you start your server. [UT2Vote15.UT2VoteCustomMuts] This is pretty much self explanatory and fairly simple to setup. This part can only be done here in the UT2Vote15.ini file and is not configurable ingame. [UT2Vote15.UT2VoteMapInfo] This section is used mainly internally by UT2Vote and any maps that need Level Timelimits set or maps that you reject from the Maplist goes here. Just a side note, when an Admin brings up the VoteMenu the About button becomes a Reject/Restore button and he can reject or restore maps. [UT2Vote15.UT2VoteKickBan] Again, 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 some on a permanent basis. [UT2Vote15.UT2VoteConfigs] This is for UT2Votes internal flag configurations and any changes you make here will have no effect on the game whatsoever. Sometime though if you have stopped your server and made changes in the UT2Vote15.ini file it might be advisable to delete everything under this heading as in that way things will start off fresh. [UT2Vote15.UT2VoteMapsVoted] This is only information for the Server Admin and will give a list of the all the Voted Maps, in a list from most played to least played. 3. Basic configuration settings ============================ These settings all fall under the heading: [UT2Vote15.UT2Vote] 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 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.. These Admin loose there Adminship when they die. They can of course logout with: Mutate UT2VoteLogout 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 switch your 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. ServerMuts= Please Note.. this has changed from version 1.4 in that ONLY Mutators that will be common to ALL games must go in here. Individual Game Mutators you add in the Game Configurations. Also see Game Configurations on how to identify a ClassName as it is of paramount importance you have it correct. 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. Also make sure the command paramter you set here is not duplicated in the individual game Command= line. For instance you may want all games to have weaponstay as true so you would add here ?WeaponStay=True Then maybe in one of the Games Command= you have ?WeaponStay=False - the second one will get the priority. Every command parameter must start with a ? (question mark). bAllowMuts= bAllowArena= bAllowKick= bAllowGames= 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 little Yes/No VoteCast 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 :) GameEndWait= (Set to 180 as default) This is the time in seconds that UT2Vote waits for a map to be voted for. Should a map not get voted for in the prescribed time, UT2Vote will display a message and switch to the next map on the list or just a random map. GameVoteTime= (Set to 10 as default) This is the time in minutes allowed from the START of a game that players can call a vote. MesgTypeTime= (Set to 40 as default) 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 **** bRandomVote= (Set to True as default) This is an alternate method of voting for UT2Vote. At Game end, the Voting Menu will popup as usual but now all players can make a vote. After a specified time in MenuVoteWait, these votes will be checked. If any item received 33% or more of the votes, UT2Vote will switch to that vote. Otherwise a random vote in the received list will be sent out for a Yes/No vote. This will continue in a Random fashion till all votes a depleted and starts again by sending out the MapVoteMenu to all players again. This new method was decided upon as it give everyone a chance to have their choice voted for. MenuVoteWait= (Set to 45 as default) When using the RandomVote option, this is the time in seconds, the menu will wait before closing and accepting the player votes for considerstion. bPlayerLights= (Set to True as default) This just tells UT2Vote whether players should have shoulder lights on during a DeathMatch game. This has no effect on TeamGames. SkinGlow= Set to 40 as default (UT's default) This can be set between 40 and 254 and effects the brightness of all Player and Bot skins. Best effect is around 100. Any value below 40 will disable this function and force it back to the UT default of 40. bAllowBehind= Set to True as default. When set to True it will allow Players to use 3rd person viewing in the games. BehindView 1 bUseChatLog= (Set to True as default) When set to True, all player typed messages will appear in server log file The format being: UT2Vote_ChatLog: Date:Time - Nickname - Message bAdrenDisable= (Set to False as default) If set to True, No Adrenaline capsules will be available. bNoComboAdren= (Set to False as default) If set to True, all frag and Combo Adrenaline will be disabled. bNoShaking= (Set to True as default) If set to True, the ClientSide option of the world shaking when a weapon is fired will be available. bVoteBeforeGame= If set to True then players can vote before the game starts. Normally only effects a ClanMatch. bWebAdmin= (Set to False as default) If set to true (recommended) then all Mutators in WebAdmin will be hidden as they will not work anyway, also WebAdmin will switch the level via UT2Vote this not dropping UT2Vote as it sometimes does. bHideNames= (Set to False as default) If set to True, then the Player voting for someone to be kicked as well as all the Players voting YES will remain anonymous. bAltRedeem= (Set to True as default) This Redeemer has a special offering here in that during guided flight, it smoothly banks in all directions. It also offers a primary Rocket fire as well as two secondary (Alt) firing modes toggled with the Strafe keys. The two firing modes being a powerfull rapid Linkgun weapon and secondary, it drops powerfull Grenades. The Forward and Backward keys will also reduce or accelerate the Misiles Speed. bAltRocket= (Set to False as default) If set to True, the RocketLauncher offers a Grenade mode. Normally the RL will behave as normal except to enable this Grenade mode, one needs to tap the AltFire 4 times within a second. A Message *** RL in Grenade Mode *** will appear on the clients display. Now when holding down the AltFire and then the PrimaryFire - 3 Grenades will now be shot out. Tapping the AltFire 4 times again will toggle the RL back to normal mode with a message: *** RL in Normal Mode *** Please note that this setting can only be done in the UT2Vote15.ini file 4. Game configuration settings =========================== UT2Vote now gives all the setup power to the Admin and lets him/her decide how many games, what configurations and what Mutators etc, each individual game should have. In the UT2Vote15.ini file you will see a heading: [UT2Vote15.UT2VoteGameTypes] Here every game, whether default or custom will be setup all in one line and can be individually configured. Actually only the initial creation needs to be done here and the rest can be done with the ingame AdminMenu. UT2Vote is supplied with the 5 default Games and when creating another Game entry, just copy and paste any one of them then go and change the necessary configurations. There are a few that need to be done in the UT2Vote15.ini file before you setup the rest in the AdminMenu, although you can do the whole lot here if you so wish. Here I will give an example of how to create a new Game and go through each setting in detail. A typical GameType configuration looks like this: (all in one line) GameType=(GameName="Capture the Flag",AllowVote=True,RequiredPlayers=2, MapLimits=0,ServerName="None",UseMapList=False,DefaultMap="CTF-Chrome", MapPrefix="CTF",GameClass="XGame.xCTFGame",Mutators="None", Commands="?GoalScore=5?TimeLimit=20?MinPlayers=2?MaxPlayers=16?MaxSpectators=2 ?Translocator=True?Weaponstay=True?BalanceTeams=True?ForceRespawn=False ?PlayersMustBeReady=False?Difficulty=5?GameStats=False?NumBots=3") So lets say we have just copied and pasted that line and want to change it to DeathBall. GameName="" This is one of the most important entries you make as a lot depends on the GameName. The actual length of the GameName depends on how many games you can fit into UT2Vote... let me explain. The way in which UT2Vote sends the information to the client is different to most. UT2Vote can send a maximum of 440 characters to the Clients GameMenu so.... Lets take a name like "Capture the Flag" which has 16 characters. So if all the games had 16 characters that would be 440 / (16 + 1) the + 1 is the comma that seperates each game. This means UT2Vote can handle 25 games. Any others would be dumped. Fortunately most games have short names and you can call it what you like. Please Note: no commas or fullstops are allowed in a GameName. So in our example GameName="Death Ball" Please Note: There are 5 identical games currently configured for InstaGib. These games are here so you can change them to whatever you want as far as Mutators, GameName etc is concerned, so you can in this way configure a Default game as you want. AllowVote= Self explanatory, if set to True then it will appear in the GamesMenu and players can vote for it. If however it is set to false, UT2Vote will completely ignore it as if it does not even exist. In our example AllowVote=True RequiredPlayers= Here you stipulate the minumum number of Yes votes required for this game to be played. in our example lets say RequiredPlayers=4 as DeathBall is boring with only 2 players. MapLimits= For the want of a better name, but this is the number of Levels that go by before any Map can be vcoted for again in this game. 0 means its always available on every level. In our example lets make it MapLimits=1 ServerName="" This is the Servername you want to appear in the UTBrowser or any browser for that matter and is usefull for when this gametype is playing as it identifies what game is being played. If it is just "" or "None" then it wont get used. In our example we will call it ServerName="ProAsm's Deathball Game" UseMapList= If set to False, then UT2Vote will use all the maps in the Maps folder otherwise if set to True, UT2Vote will use the maps found in this games default maplist. Just make sure you have selected some maps in the mapslist which can be done from WebAdmin or directly in your UT2003.ini file. In our case we set it to UseMapList=False DefaultMap="" This is very important especially if this becomes your DefaultGameClass. Here you set the name of a default map that UT2Vote will use if this gametype is selected to do an auto defaultgame switch. In our example we use DefaultMap="DB-Cube" MapPrefix="" Without this the MapVoteMenu will CRASH and display all sorts of garbage so make sure its correct and in uppercase. In our example it will be MapPrefix="DB" GameClass="" Here I'm going to spend a bit of time here as this confuses many Admin as they often end up putting all sorts of garbage in here. Its only a pity that Modders don't mention there Game or Mutator ClassNames in their Readme files.... such a pity Some things to remember about a ClassName is it will ALWAYS be 2 names seperated by a period. The best way to find a Game, Mod or Mutators ClassName is to look in the INT file that comes with that Mod. [Public] Object=(Class=Class,MetaClass=Engine.GameInfo,Name=DeathBall.DB_Deathball,Description="") What you are interested in, in all cases is the part between the Name= and the very next ',' comma. In this case it is DeathBall.DB_Deathball It is of paramount importance that you have this ClassName correct else you will not only crash UT2Vote but you will without a doubt crash your whole server as well, so if you are not 100% sure, either write to the author of the Mod or just dump the mod. In our example it will be GameClass="DeathBall.DB_Deathball" Mutators="" Here you enter the Mutators ClassNames you want specifically with this game. If you have more than 1 seperate them with a comma. Please Note.. nowhere ever do you enter UT2Vote in as a Mutator anywhere as it will see to that itself. If you dont want any Mutators with this game leave it as "" or "None" In our example lets leave it as Mutators="None" Commands="" Now comes the juicy part as here you setup all the game parameters you want and they are all self explanatory, but we will go through them just incase some of you are still new at startup commands. GoalScore= This is the fraglimit, goals or the number of flags needed to win the game. TimeLimit= This is the max timelimit allowed for the game. If set to 0, the game will continue till the GoalScore is reached. MinPlayers= This mainly refers to Bots on a server. If set to 2 means if there is only one player, he will play with a Bot. When a second player joins the game, the Bot will leave and the players carry on. If set to 0, no Bots will be allowed. MaxPlayers= The total number of players allowed on a server. MaxSpectators= The total number of Spectators allowed on a server. Translocator= Set to True or False, depends if this game uses the Translocator or not. If True the Translocator will be used. WeaponStay= Set to True or False, if set to False this game will have its weapons dissapear when picked up and respawned a while later. BalanceTeams= Set to True or False, if True and a Team type game, UT2003 will try and balance the teams equally otherwise the players need to do it manually themselves which is sometimes better as UT always screws it up :) ForceRespawn= Set to True or False, if True then when a player dies he will immediately be respawn. PlayersMustBeReady= Set to True or False, if True then everyone needs to click their Fire button to indicate they are ready before a game can start. Difficulty= Set between 1 and 7, this is the skill level that the Bots will play at. GameStats= Set to True or False, self explanatory, but if you want Bots on your server, set it to False. NumBots= This only effects a local Instant Action game and has no effect on a server. It is basically the number of Bots you want to play with. Extras There are several other commands you can just add on to the end if you like, but just remember to seperate each one with a ? (question mark) and keep them within the "" (quotes). All these commands are available for the Admin in the UT2Vote AdminMenu to change at any time he/she wishes. 5. Mutator configuration settings ============================== In the UT2Vote15.ini file you will see a heading: [UT2Vote15.UT2VoteCustomMuts] To add Custom made Mutators to UT2Vote you need to copy and paste the example given and just change necessary parameters. Here I will give an example of the Sniper Arena Mutator. After copying and pasting you will have: Mutator=(FriendlyName="None",AllowVote=False,MutClassName="None.None",Voted=False) FriendlyName="None" First you enter a Friendly name for the Mutator - keep it as short as possible as it has to fit in the Menu. In our case we call it FriendlyName="Sniper Arena" AllowVote= Self explanatory, if set to True then it will appear in the CustomMutator Menu and players can vote for it. If however it is set to false, UT2Vote will completely ignore it as if it does not even exist. In our example AllowVote=True MutClassName="None.None" As I did in the Game Configurations, I will repeat it here. Here I'm going to spend a bit of time here as this confuses many Admin as they often end up putting all sorts of garbage in here. Its only a pity that Modders don't mention there Game or Mutator ClassNames in their Readme files.... such a pity Some things to remember about a ClassName is it will ALWAYS be 2 names seperated by a period. The best way to find a Game, Mod or Mutators ClassName is to look in the INT file that comes with that Mod. [Public] Object=(Name=SniperArena.MutSniperArena,Class=Class,MetaClass=Engine.Mutator,Description="Whatever") What you are interested in, in all cases is the part between the Name= and the very next ',' comma. In this case it is SniperArena.MutSniperArena It is of paramount importance that you have this ClassName correct else you will not only crash UT2Vote but you will without a doubt crash your whole server as well, so if you are not 100% sure, either write to the author of the Mod or just dump the mod. In our example it will be MutGameClass="SniperArena.MutSniperArena" Voted=False Please leave this alone, as it is used internally by UT2Vote as an indication whether it has been voted for or not. Serverpackages Just a reminder here, that whatever Mutator you add here MUST be declared in your ServerPackages= in your UT2003.ini file. Everytime this Mutator is voted for, UT2Vote will look in the ServerPackages and if it cannot find it, UT2Vote will abort the vote and inform the player that the Mutator is not registered in the ServerPackages and to contact the Admin. 6. Other bits of information ========================= [UT2Vote15.UT2VoteMapInfo] In here the Admin will see 2 types of Map information but cannot do anything with them except delete them if he needs to. RejectMap=(MapName="DM-Antalus") When an Admin brings up the VoteMenu the About button becomes a Reject/Restore button and he can reject or restore maps. These maps end up here VotedMap=(MapName="DM-Antalus",LevelCount=2) If a game has a MapLimit set to it, once that map has been voted for and accepted it ends up here until its LevelCount has count down to 0 [UT2Vote15.UT2VoteKickBan] 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. BanPlayer=(NickName="Whatever",UniqueID="4230fjj7a6cafda49fed3f4200fa97kk",IPaddrs="22.214.171.124",Period="Y03") To do this change whatever the Period= says, to Period="Y00" 7. Client configuration settings ============================= In the User.ini file you will see the following and are all available in the ClientMenu: [UT2Vote15.UT2VoteClient] bDefineSetup=True bUseHudCounter=False bResetWhenDead=False bHudCountUp=True bUseGameTime=False bUseElapsed=False bNoWorldShake=True bNoWeaponNames=True bDisplayTime=False bSeeThruHudDM=False bDefineSetup= This is not user configurable and is used internally. bUseHudCounter= This the client can set to True if he/she wants the Hud Counter enabled. bResetWhenDead= If the client wants his/her Counter reset when they are killed. bHudCountUp= This is whether the client wants his/her Counter counting up or counting down. The HudCounter counts from 00 to 99 or the other way round and then restarts. These Keybinds can be added by the Client if he/she so wishes: Pressing this key will then reset the HudCounter. ResetHudTimer This number can be anything from 00 - 99 and the counter will count either up or down from that number. ResetHudTimer Number bUseGameTime= An alternate oprion to the HudCounter. Setting this to True will enable display of either Remaining or Elapsed time. bUseElapsed= Setting this to True will enable Elapsed time over Remaining time. bNoWorldShake= If enabled ServerSide the the Client will have this option to stop the world shaking when firing. bNoWeaponNames= This is already available by UT2003 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. bDisplayTime= Setting this to True will enable the display of the PC local time. bSeeThruHudDM= When this is set to True, in DeathMatch games your Hud will be transparent. KeyBinding This item only appears in the ClientMenu and here by clicking on it the Player can set a keybind for activated the UT2VoteMenu on any key he/she wishes to. Spectator Mode Click this button to switch to spectator mode. A Note on MapList Command Lines =============================== UT2Vote now recognises Commandlines added to a map in a MapList in UT2003.ini [XInterface.MapListDeathMatch] MapNum=0 Maps=DM-Antalus?Mutator=UnrealGame.MutLowGrav?Translocator=False Maps=DM-Asbestos?Mutator=XGame.MutInstagib If UseMapList=True in the GameType then the following is available to Admin. Mutate UT2VoteLogin Password Mutate UT2VoteMapList Add Mapname Mutator=XGame.MutInstaGib,UnrealGame.MutLowGrav?MaxPlayers=6 If the map already exists in the MapList the commandline will be replaced with this one. If the map does not exist, the new map and commandline will be added to the maplist. A note of caution. Mutators MUST come first then the other ?Commands Mutate UT2VoteMapList Remove Mapname This will remove the map and its commands if any from the MapList. Mutate UT2VoteMapList Show Mapname This will display the map and its commands in the console (if the map exists) IF A MUTATOR IS ADDED IN THE MAPLIST THEN IT MUST COME FIRST IN THE STRING. Maps=DM-Antalus?Mutator=UnrealGame.MutLowGrav,XGame.MutQuadJump?Translocator=False?WeaponStay=True NB.. The MapList commands will take top priority so if you have a same command elsewhere like ServerMuts or the Game Commandstring, it will be ignored.
There are no comments yet. Be the first!