--------------------------------------------------------------------------------------
x3dfxMapvotev24c
Version 2.4

Programmed by Bonehed316
(with source code provided by BDB for MapVote304)

ReadMe
--------------------------------------------------------------------------------------

Welcome to MapVote -- Please take your time to read the ReadMe, it may help you later.


INDEX
-----

Preface

1. About MapVote
   
    1.1 Purpose
    1.2 Future

2. Installation

    2.1 Setting up a server
    2.2 INI Settings

3. Usage

    3.1 Basics
    3.2 Configuring ExtraMutators
    3.3 Configuring Mutator Buttons
    3.4 Configuring MapVote In Game
    3.5 Custom Game Types

4. Other Stuff

    4.1 Support
-----
Preface
-----

    MapVote was origionally created by BDB, but for our servers, we wanted a MapVote
    that would allow us to vote for Maps and Mutators.  It started out as a few set
    modes that could be voted for, but because of a high number of requests, I have
    added the customizable buttons.  


-----
1. About MapVote
-----

1.1 What is the purpose of MapVote?


    MapVote allows a user to vote for what map will play next.  MapVote tallys 
    the votes and switches the server to the map that won the vote.  This version
    of MapVote expands on base and adds 8 customizable buttons that can be voted
    for, each button can contain a set of mutators.  Not all mutators will work, 
    but most should.  Special game types probably wont, but who knows.


1.2 Future


    Looking at what the future will bring, I have no additional features to add.
    But if bugs crop up, or if some people request something enough, I may be 
    able to add some things.  


-----
2. Installation
-----

2.1 Setting up a server


    First of all we advise any person setting up a MapVote Server to make it a
    Dedicated Server. The reason is that Listen Servers have some minor issues
    and therefore the player setting up the Listen Server may cause problems.

    ### Step 1 ###

    Copy all .u, .int, and .ini files to your System directory.

    ### Step 2 ###

    To set up a dedicated server add the following to your UnrealTournament.ini
    in the tab [Engine.GameEngine]

      ServerPackages=x3dfxMapVotev24c

    To run the server all you have to do is, in DOS:

      ucc server <mapname.unr>?mutator=x3dfxMapVotev24c.x3dfxMapVote

    Once Mapvote is loaded, it should perpetuate itself without having to be
    added to any mutator button.  Adding it could cause problems.


2.2 INI Settings


    All ini settings are found in Mapvote.ini included in this package.  If you
    did not get one, you wont be able to run the mutator.

    The contents of MapVote.ini are well documented in the included ini file, so
    it is recommended you read through them.  Also Included is the BDB ReadMe for
    304, since this package is so heavily based on it.


-----
3. Usage
-----

3.1 Basics

    
    Once MapVote is installed, it works just like regular MapVote.  It even uses
    the same commands, so if you already have a button mapped to bring it up, it
    should operate as normal.  The first match will use whatever mutators were 
    loaded with the server.  After that, which ever mode won, those mutators will
    be used.  The old ones wil be discarded.  You may vote for a Map and a Mode 
    in any order, MapVote will not proceed with the map switch until either 
    everyone has voted for both a Map and a Mode, or voting time expires.  At 
    that point, the votes will tally, and the winners will be applied to the next
    round.  If there is a tie, MapVote will randomly break the tie.  If no one
    has voted at the end of voting time, a Map and a Mode will be randomly chosen,
    with respect to the Map history, and the Modes that are enabled or disabled.  
    In other words, if a Map or Mode cant be voted for, it wont be randomly chosen
    if no one votes.


3.2 Configuring ExtraMutators


    Once MapVote is intalled, the mutators it uses must be configured.  This can
    be done in game, as well, if you know what youre doing (but I dont recommend 
    it).  The in-game feature is mostly for REMOVING mutators.  

    ### Step 1 ###

    Find the ExtraMutators= section of your MapVote.ini file.  In order for it to 
    work properly, you have to add mutators like you would add them to your command 
    line.  x3dfxMapVotev24c adds the ?mutator= automatically, so please dont add it 
    again.

    IMPORTANT:  This section is for adding mutators that will be applied to ALL
        buttons.  

        **Add mutators as Package.Class.
        **Place a comma between mutators.
        **Do NOT space between mutators.
        **Do NOT end the entry with a comma.
        **Do NOT end the entry with a space.

    For Example:  ExtraMutators=BotPack.NoRedeemer,BotPack.NoPowerups

    There is no arbitrary limit to how many can be added here, just use your 
    good judgement.


3.3 Configuring Mutator Buttons


    Once MapVote is installed, the mutators that each button represents must be
    configured.  To do so, simply edit the following portion of your .ini file
    that came with this package.  

        ExtraMutators1 = Mutators assigned to Button1
        ExtraMutators2 = Mutators assigned to Button2
        ExtraMutators3 = Mutators assigned to Button3
        ExtraMutators4 = Mutators assigned to Button4
        ExtraMutators5 = Mutators assigned to Button5
        ExtraMutators6 = Mutators assigned to Button6
        ExtraMutators7 = Mutators assigned to Button7
        ExtraMutators8 = Mutators assigned to Button8

    IMPORTANT:  This section is for adding mutators that will be applied to the
        desired button.  

        **Add mutators as Package.Class.
        **Place a comma between mutators.
        **Do NOT space between mutators.
        **Do NOT end the entry with a comma.
        **Do NOT end the entry with a space.

    For Example:  ExtraMutators=BotPack.NoRedeemer,BotPack.NoPowerups

    This example would add the NoRedeemer and NoPowerups mutators to button
    one ONLY.  If you want your mutator to be for ALL buttons, 
    be sure and add it to the ExtraMutators= section, as described above.

    NOTE:  You MUST name your buttons.  They are pre-named to annoy you, so that
        you will want to rename them.  Naming them in-game is now supported in 
	this version, and is available in the GameTypes window.Be sure and name 
	them something that is easy to understand.  Be sure not to use too many 
	characters, as they may not all fit.

    For Example:  ButtonName1=ZPNW, Relics


3.4 Configuring MapVote In Game


    Once you have the Server set up, and are in game, you may login as admin
    and open MapVote and configure some options.  More of BDB's options are in
    the Admin Tab, and a new Game Types tab is there now, which is used to 
    enable or disable buttons, and define what their mutators are.  It is not
    recommended to change this section unless you know exactly what you are
    doing.  Be sure and save when youre done.  Also be aware that the windows
    do scroll down quite a ways, to reveal more options.  


3.5 Custom Game Types


    Now in x3dfxMapVotev24c it is possible to define up to 4 custom game type
    classes that MapVote will allow to be loaded.  These new options are 
    relevant to this feature:

	CustomGameType1=
	CustomGameType2=
	CustomGameType3=
	CustomGameType4=

    The options above are where you define the Game Type you want to use.  This
    works exactly like OtherGameClass which is already a part of MapVote.  These
    options MUST be assigned by Package.Class.  For example: BotPack.CTFGame
    Do not end the entry with spaces, or with commas, and be sure only one Game
    Type is listed per option.  These options are customizable in-game from the
    Game Types tab, but it is not recommended, unless you know exactly what to 
    place there.

	bCGT1=False
	bCGT2=False
	bCGT3=False
	bCGT4=False

    When MapVote loads, if there is an entry for CustomGameType1, AND if bCGT1 
    is TRUE, then MapVote will load this game type, and place any maps with the
    default Map Prefix (which is assigned by the Game Type) in to the Map list.
    If the Game Type is a Team Game type, mapvote will make sure there is an
    adequate number of players (not including bots) to enable team games to be
    voted for.  This limit can be defined by MinPlayersForTeamGames in the INI
    file.  These options are customizable in-game, from the Admin tab.

	CustomGameTitle1=CustomGameType1
	CustomGameTitle2=CustomGameType2
	CustomGameTitle3=CustomGameType3
	CustomGameTitle4=CustomGameType4

    These options are cosmetic only.  They are what MapVote will announce won
    if a Map with this Game Type wins the vote.  It is not required, but is
    nice to fill in, for instance MonsterHunt or whatever.


-----
4. Other Stuff
-----

4.1 Support


    If you can seek me down, you may ask for help.  Otherwise, be aware that BDB
    is not the creator, and may not be able to help.  You can catch me usually on
    aim, MSN or yahoo (bonehed316 for all), and I may be able to help.  

    