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

 MOD NAME:       UTMultiTeam
 AUTHORS:        Infinity Impossible
 VERSION:        0.1 [ALPHA]
 COMPATIBILITY:  UT3 Patch 1.1

----------------------------------------
 Copyright Infinity Impossible, 2007
========================================


RELEASE NOTES:
    This release is an ALPHA. There are bugs, there are features which need to be fixed or changed.
    If you notice something wrong, please let us know and preferably provide screenshots of the issue
    and your game Launch.log file for the running instance the problems occurred in. Thanks for downloading
    the mod and we hope you enjoy playing it!

    To mod authors: the unrealscript packages included with this mod include a fairly generic framework
    for creating games with arbitrary numbers of teams. There should be no dependency from UTMultiTeam 
    on any of the assets in UTMT_Content.upk. If you find that there is, let us know and we will remove 
    them for the next release. See further down this document for more information on using the packages 
    provided.


SPECIAL THANKS TO:
    Lotus: For kindly letting us use his CustomUT team color materials.
    8-4-7-2: For lending me clan rSu's server for testing.
    Epic Games: For keeping it Unreal!


INSTALLATION:
    If you are running UT3 on windows, unzip to "My Documents\My Games\Unreal Tournament 3\UTGame". If you
    are running a different setup, this may need to be extracted to a different place, but you should know
    this if you are running those options anyway ;)


ABOUT:
    UTMultiTeam is a mod which brings classic 3-way and 4-way team deathmatch to UT3. It replaces
    all elements we could think of with multi-team equivalents including weapon skins, player skins,
    the HUD and scoreboards. In future releases, it aims to provide a classic domination gametype
    as well. Deaths from changing team or leaving the game no longer penalise your team as they do in
    normal UT3.


STARTING A GAME:
    A new game can be started from the main menu, or from the command line. If you are running a server,
    the command is ?game=UTMultiTeamContent.UTMultiTeamGame and the following options can be included:

    ?NumTeams=N 
        Start a new game with N teams in it. N may be 2, 3 or 4.

    ?FactionN=FactionName 
        Start a new game with the specified factions. N may be 2, 3 or 4. FactionName is specified as in
        vanilla UT3.


NEW COMMANDS:
    SwitchTeam       
        Moves you on to the next available team (as per the normal UT3 command of the same name)

    ChangeTeam <TeamName>
        TeamName can be "red", "blue", "green" or "gold". Switches you to that team.

    AddGreenBots N
    AddGoldBots N
        Add N green or gold bots to the current game, if you are allowed to be adding bots.


CURRENT LIMITATIONS:
    + Vehicles are not yet team colored, although there is some provision for that in the current version
    + Players vs Bots is not handled at all
    + If you create a sub gametype with more than 4 teams, the team change GUI box in the mid game menu
      will not appear, since it is based upon the message box mechanisms and is only allowed four buttons.
    + The translocator is not yet colored to teams.
    + HUD items for team games such as CTF or WAR that indicate the current status of the flag and such
      will not appear correctly yet
    + Team portaits will not yet be colored to their team. This is a limitation of the methods used to color
      players' skins, since the engine does not take into account materials added to the players' meshes
      after they have been set up initially.
    + No thought has yet been given to the server browser, it may or may not work.


KNOWN BUGS:
    + Redeemer HUD is red for green and gold teams when in flight
    + Regression to the default IronGuard character is fairly common. We know why this is and aim to fix it
      in a future version
    + Pressing escape in the in-game Change Teams dialog box randomly switches the player to a new team 
      instead of cancelling the switch altogether.
    + Spectators see some skins wrongly, including ultra-brite glowstick mode in some cases
    + There is a potential bug whereby skins loaded at the start of the round are not colored correctly
    + Spectators may have trouble switching between players to view using primary fire.
    + When performing a seamless travel between levels and changing NumTeams, some teams may still exist
      after the transition and provide "phantom" HUD elements as well amoung other effects.


PLANNED FEATURES:
    + Announcements for the Green and Gold teams    
    + Team color materials for vehicles
    + Colored translocator
    + Fix regression to the default character so often when changing teams in online play.
    + Better configuration options


MOD AUTHORS:
    If you wish to use this framework to power your own multi-team mods, please let us know if there is
    anything you would like changed or wish was done differently, we might well agree with you! This is 
    a brief overview of the important classes, there is a lot of documentation in the code itself and
    in future we plan to write more comprehensive overview documentation as well.

    UTMultiTeam.u:
        The meat of the mod. Provides hopefully generic classes that can be used for gametypes involving
        more than two teams at once.

        UTMT_TeamGame:
            The game logic class. Take a look at the source for documentation of specific features

        UTMT_TeamInfo:
            Contains information on the colors used by particular teams. 

        UTMT_TeamMaterialTransformer:
            Of interest to those who are interested in the mechanics of the team colorising materials,
            based on Lotus' original material transform code.

        UTMT_UIPanel_Scoreboard:
            Contains the mechanism for providing an arbitrary scoreboard in the mid-game menu.


    UTMultiTeamContent.u:
        This package contains all of the classes that hold a reference to UTMT_Content and exists to
        provide a UTMultiTeam package with no dependencies. Items of interest here include the default
        properties included in the UTMultiTeamGame class and UTMT_TeamHUD_Content class that control
        which scoreboards appear and when.
        
    UTMT_Content.upk:
        Contains, amoungst other things, the material shaders that allow the team colors to be set. Look
        under UTMT_Content.Lotus for these. The MidGameMenu is another item of interest, and if you want
        to add your own scoreboards, duplicate it and take a look at MTDMPanel_3 and MTDMPanel_4. These
        are configurable in unrealscript for appearing when different numbers of teams are set in the game
        from subclasses of UTMT_MultiTeamGame.


RELEASE HISTORY:
    0.1 Alpha
        + Initial release