Package: WMapVote
 Author: }TCP{Wolf aka Mia_The_Chaotic
   Date: May 2003
Contact: ChaosWorx@gmx.net


CONTENTS:
---------------------------
  I. Intro / What is it
 II. Installation
III. Running / Settings
 IV. (In)Compatibility list
  V. LEGAL INFORMATION
 VI. Version history



I. Intro
-------------
Hi, you just grabbed another totally uncool and boring mod from }TCP{Wolf... This time, it's a map voting mod.

NO IT'S NOT AS GOOD AS THE UNREAL TOURNAMENT MAP VOTING!!

Players can vote on (up to 32) maps on the server, and whether or not to skip it. In order for a player to activate voting he has to say "mapvote" (not teamsay).
If no one casts a map vote, the normal map cycle takes place.
It has a lot of restrictions to it, to summarize, you can only do map voting if you are in game, alive and in a normal state. Spectators cannot do map vote...
If you are CheatFlying, dead, or the game already ended, map voting cannot be done anymore. As I said this is not as good as in UT. The Unreal one engine has a lot less possibilities than UT... yet I think this is about as good as it gets...



II. Installation
-----------------
Copy all *.u and *.int files to your Unreal\System directory of your server.

Add the following to your serverpackages and -actors:
ServerPackages=WMapVote
ServerActors=WMapVote.WMapVoteSA



III. Running / Settings
------------------------
In the advanced options, set "Enabled" to "true" in order to start the mod.
Currently settings are stored in the user.ini, try adding this at the end of it:

[WMapVote.WMapVoteSA]
Enabled=True

Note, maps are read out dynamically, so you can use the mod on several servers with each one's own map lists. It will then use the same settings but this is not very critical I think. What you want are your custom map lists per server, and those you can still have.

debug
leave it of unless you want a TERRIBLE lot of extra stuff in your log...

MaxActivate
Maximum number of request a player can try to do mapvotes.
The number of times a player can go into map voting state is limited in order to avoid abuse, because while players do map voting, they are invisible and invulnerable.

SkipPercentage
Percentage of players required for skip. The default value is "0.501" which would mean 50% but one more player than half of them. Allowed values are between zero and one (0.0 to 1.0) "1.0" would 100% meaning ALL players have to agree on skipping to skip.

SkipDelay
Time in seconds to delay the skip.
Once enough players have voted to skip, this is the time in seconds when the skip finally takes place. This gives the remaining players still time to vote for a map, though skipping cannot be cancelled anymore.

StartUpDelay
Time In Seconds before map voting is allowed.
Again a small protection against abuse, as a fast connected player could quickly vote skip immediately. As long as he is alone, his skip will succeed always, possibly denying other players to login at all, thus, time before map voting is allowed should be delayed.

VoteOnlyMaps
You can specify up to 10 maps here to be added



IV. (In)Compatibility list
---------------------------
This mod should work together with all other mods and gamemodes, however I DO NOT GUARANTEE IT!!!

Unreal 224 (server): untested, client: ok
Unreal 225 (server/client): ok
Unreal 226b (server) untested, client: ok

SBABs:
Smartball's Antibot will disable WMapVote currently. But Smartball is informed about how to fix the problem, so the next SBABs will certainly cooperate with this mod.

hb3:
Same problem as with SBABs, however only if you use "spawner.makeitso" to spawn "hb3.hb3". You can replace this spawner with my own Generic Client Spawner and tell it to spawn "hb3.hb3" instead. The Generic Client Spawner will NOT cause the incompatibility problems.

Infiltration - STANDOFF:
Although not tested, I don't think this works well, because you have to be alive to do map voting. Most players will be dead all the time spectating, so map voting will not be possible. And while they are alive their time is too precious...

WFlexMap:
Not tested, should work, however it will behave slightly differently, because with large maplists, you will have 32 totally new maps to vote on after each map change! And don't use the dynamic map selection by playerload, it will not function.



V. LEGAL INFORMATION
---------------------
<put DISCLAIMER here> lol, to make it short: ALL YOUR RISK, don't come whining to me if ANYTHING is damaged or destroyed by using this mod, I am not responsible for ANYTHING that results from using this mod in any way.

You may not decompile the code for whatever reason, you may not reuse the code for your own purposes, you may not hack or change any file associated with this package.

You may give copies to ANYONE on ANY medium FOR NO CHARGE as long as all files of this package remain unchanged.

You may use the package on as many machines as you like.



VI. Version History
---------------------
May 2003: beta 1
  Initional test release
May 2003: beta 2
  - Bugfix: team game not working correctly
  - Enhancement: smooth scrolling through list instead of clicking
  - Enhancement: added VoteOnlyMaps
  - Enhancement: client side message decoding halves "init" sequence time



Enjoy,

}TCP{Wolf aka Mia_The_Chaotic
