NAME
    BiaVote -- UT3 Voting Mutator

    Version 0.5.3 BETA
    Release, January 28, 2008

DESCRIPTION
    [BIA]Vote is a Voting Mutator for UT3 which replaces the game's end-game
    voting system and allows for mid-game voting as well as voting on game
    types, etc.

    See the CHANGES section below for release notes.

  Current Features
    *   Replaces the in game voting system.

    *   Can be activated during the game -- configurable key mapping, or via
        the console command "mutate biavote"

    *   Game type Voting -- if a game wins the vote, maps for that game type
        are reloaded and the voting round starts again

    *   Map Voting -- different maplists for different game types

    *   Kick voting -- can be enabled/disabled

    *   Vote to add Bots -- can be enabled/disabled

    *   Configurable vote time limit

    *   Configurable *welcome screen* that will show on server login -- May
        be disabled, enabled to display once per server login or every time
        a new game starts on the server

    *   Configurable for different *game types* that you may define in the
        INI file

    *   Squashes the UT3 MidGameMenu on pre/post map load/server travel --
        MidGameMenu is still accessible

    *   Works with custom game types -- can distinguish between multiple
        *configurable game types* that you define even if they all have the
        same Game Class

    *   Translocator or Hoverboard may be enabled or disabled for any type
        of game on a per-game or per-map basis

    *   Actor Removal -- Remove Items/Actors by group, configurable per game
        -- ex: play UTDeathMatch on a WAR map without any Power Cores.

CHANGES
    BiaVote-0.5.3
        This is a bugfix release, I tried to quash some of the reported
        issues with UI integration.

         * Fixed bug causing the BiaVote menu to display empty lists when
           end-game vote round begins and BiaVote was already displayed.
         * BiaVote-0.5.3 Fixes some of the bugs and annoyances associated
           with integrating with the UT3 menu system.  There are still
           some issues but many were addressed.
         * The "disconnect" button was removed from the BiaVote menu and
           replaced with a "Change Teams" button.  The presense and
           functionality of this button will be configurable in the next
           update (it will respect the game's setting).
         * NOTE: The Maps=( Options=() ) config entries are not yet supported
           please ignore references to this in the README and .INI.
           This will be supported in the next update.

    BiaVote-0.5.1
        This is primarily a stability release. Several reported issues were
        fixed or partially fixed and a few new features were added.

         * Fixed README.txt referring to the wrong name for the mutator
         * Fixed some of the things that may cause "input lockup"
         * Fixed RoundOver being confused with MatchOver in Team Games
         * Fixed AddBots, no capped at NumPlay value
         * Enhanced logic used to determine when voting should end
         * New Feature: Enable/Disable of Hoverboard/Translocator
         * New Feature: Actor Removal, per-game type, by groups
         * New Feature: Strip prefix from Maps when no Title= is given in .ini

    BiaVote-0.3.0
         * Initial release as a Mutator

CONTENTS
    The files contained in the release archive are as follows:

      README.txt
      LICENSE.txt
      Config/UTBiaVote.ini
      CookedPC/BiaVote.u
      CookedPC/BiaVoteMenu.upk

INSTALLATION
    Installation of BiaVote is as simple as copying a few files around.

      Note that BiaVote does not work in single player mode -- If you want to
      try it out you will have to run a LAN game.  To do this,
      simply run "ut3 server DM-Diesel?Mutators=BiaVote.BiaVoteMutator" -- and
      then fire up UT3 and on the server filter, select LAN match.

  Installation Procedure
    1.  Stop your server.

    2.  Copy all of the .u and .upk files to your server's UTGame/CookedPC
        directory.

    3.  Copy "UTBiaVote.ini" to your servers Config directory. Edit it to
        customize it for your server - Instructions are embedded within
        comments.

    4.  Edit your server's startup command line -- see below -- BiaVote's
        mutator should be first in your mutators list.

    5.  Start your server!

  Configuring Your Server Command Line
    The name of the mutator is BiaVote.BiaVoteMutator. You need to include
    it as the first mutator if possible. Note that you do not have to wory
    about adding it as an option in UTBiaVote.ini file, as BiaVote will
    always add its self when restarting a new map, etc.

    If you have multiple mutators, remember to include only a single
    Mutator= option in your command line -- assign it a comma-separated list
    of mutators.

    Examples:

      DM-Deck?NumPlay=5?Mutator=BiaVote.BiaVoteMutator
  
      DM-HeatRay?Mutator=BiaVote.BiaVoteMutator,UTMutator_BigHead,UTMutator_Arena
  
      DM-HeatRay?Game=UTTeamGame?Mutator=BiaVoteMutator?TimeLimit=10?EnableTranslocator=true
  
  UTBiaVote.ini Configuration Hints
    *   You can not enable/disable the translocator or hoverboard with an
        INI setting. Instead you must include the option in the Options=
        member of your Maps=() or Games=() entries. Example:

          Games=( Game=DM, GameClass=UTDeathmatch, Title=DeathMatch, Options="EnableTranslocator=true" )
          Maps=(  Map=DM-Heatray, Games="DM,TDM", Options="EnableTranslocator=false" )
  
    *   Quoting. You do not strictly need to use quotes in the values you
        assign to things in the .INI file. If you always use quotes for
        string values then you will be ok. Note that the UT ini parser will
        try to make arrays of strings out of anything it sees with commas in
        it unless it is quoted, so:

           Maps=( Map=DM-HeatRay, Games=DM,TDM   )  <--- WRONG!
           Maps=( Map=DM-HeatRay, Games="DM,TDM" )  <--- Ok

    *   Options. You may include Options in the Map Name by following the
        map name with a question mark and options. It may be best however to
        use the Options= entry for the map, which is a little cleaner.

PROJECT
    This project is maintained on Google-Code. The project web site is at:

      http://code.google.com/p/ut3-sniper-game

    If you find issues, bugs or wish to make a feature suggestion, please
    drop by the issues list at:

      http://code.google.com/p/ut3-sniper-game/issues/list
  
    Source code access is available via subversion (but the code is really,
    really a mess just now - lol!). If you wish to get involved with the
    coding effort for BiaVote or other planned projects then let me know.

AUTHOR
    [BIA]DarthMushak

    *   http://code.google.com/p/ut3-sniper-game

    *   http://groups.google.com/group/ut3-sniper-game

    *   http://bia-2k4.com

LICENSE
    New BSD License -- see the included LICENSE.TXT file.

    *   http://www.opensource.org/licenses/bsd-license.php

