
**************************************************
*Operation: Midnight Assault by karr and IVfluids*
**************************************************

INDEX

[1] About Operation: Midnight Assault
[2] Concepts
[3] Admin Commands
    (A) Time of Day
    (B) Values
    (C) Properties
    (D) Light Settings
    (E)Examples of Admin Commands:
[4] Client Commands
[5] Installation
    (A) File Tree
    (B) Server Actor Setup
    (C) Server Mutator Setup
[6] Known Issues
[7] Credits



[1]About 'Operation: Midnight Assault':
***************************************

  Just for reference in this ReadMe, we will be referring to 'Operation: Midnight Assault' as 'OPMA' for simplicities sake.

  This mutator/mod is meant to change maps from their normal lighting and settings to nighttime operations and it will also
  add weather effects into the nighttime settings of this mutator.  This almost makes the maps you have into 2 different
  versions without having to have two different versions of the map, twice the fun for half the hard-drive space.

  Almost every aspect of OPMA is configurable so the server admin can set it to his specific tastes.  Or you may use the 
  default settings that are provided if you feel overwhelmed by all the options.

[2]Concepts:
************

  NightVision:
  ------------
    Now it has a real use and it has been completely redone so that you may see in the dark better but it does come at 
    the cost of having a limited range.  

  GlowSticks: 
  -----------
    You may purchase them in the BuyMenu for $25 a piece.  You get five free ones every round which you may choose to save
    or sell.  These items are very handy for camping doors or other bottleneck areas.

  Default Battery:
  ----------------
    A battery with an adequate charge that is used to power your FlashLight and NightVision.  When the battery is drained,
    it will turn off your electronic items and begin to recharge.  You may also recharge it by turning your electronic
    equipment off.

  ExtraLife Battery:
  ------------------
    The big brother of the Default Battery.  Has a longer charge time but will cost you $300.

  HUD Icons:
  ----------
    You can see what items you are using, monitor your batteries charge, and view how many GlowSticks you have left in your
    inventory. Located in the area right above your Ammo Display.  When you are dead, you can see these icons as the person 
    you are viewing uses them.

  Extra Items in Buymenu:
  -----------------------
    The extra items that may be purchased in PerfectDarkII may be bought in the standard Tactical Ops BuyMenu.

  Weather Effects:
  ----------------
    Rain, Thunder and Lightning OH MY!  Rain and Thunder sounds and effects.  Lightning not only lights up the land and sky
    for brief periods, you may also be struck by it and take damage.

  SkyBox:
  -------
    Our very own SkyBox takes the place of the original SkyBox in the map and we added many pretty stars in it for your 
    viewing pleasure.

  Time of Day:
  ------------
    The Time of Day Mode toggles between 4 preconfigured and fully configurable OPMA day states that will by picked
    according to the server time.



[3]Admin Commands:
******************
  
  These commands work in both SinglePlayer and MultiPlayer

  admin set MidNightAssault.MA_Mutator <Property> <Value>

  (A)Time of Day:

     TimeOfDay <True/False>
     //Default Property is False

     When set to True, the server will pick one of the 4 Day states (Morning, Day, Evening, Night) according to their
     Starting hours. Each contain their own set of settings described below. If TimeOdDay is False, the server will always
     be in Night Mode, and thus the settings for Night will be used.


  (B)Values (Probability):

     Most of the Settings come in a Probability form (x/100), so that the setting has a random chance of being 'On' in
     the game.

     Example:

     Always Off = 0
     Always on  = 100
     Half on    = 50

     So, setting a value to 30 means it will have a thirty percent chance that the particular property it is assigned to 
     will be 'On'.


  (C)Properties:

     Each Day State Contains a set of the values of (C) and (D). It is preferable to change them using the INI, but you can
     do so aswell by using an admin command :

     admin set MidnightAssault.MA_Mutator DayState (Property=Value)                                  (see examples below)

     Probability_Enabled <0-100>
       //Chance that OPMA will run on map change (setting this to 0 disables PD)
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_LevelBrightness <0-100>
       //Sets the random chance that AmbientLight will display in the map when OPMA is running
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_LightBrightness <0-100>
       //Sets the random chance that Light will display in the map when OPMA is running
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_NightVision <0-100>
       //Sets the random chance that you will be able to use and purchase NightVision on the map while OPMA is running
       //Default property is 100% for Night - 0% for Morning, Evening, Night

     Probability_FlashLight <0-100>
       //Sets the random chance that you will be able to use FlashLight on the map while OPMA is running
       //Default property is 100% for Morning, Day, Evening, Night

     Probability_GlowSticks <0-100>
       //Sets the random chance that you will be able to use GlowSticks on the map while OPMA is running
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_UseBattery <0-100>
       //Sets the random chance that you will have limited battery life in the map while OPMA is running
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_ExtraBattery <0-100>
       //Sets the random chance that you will be able to purchase and use a battery with a larger charge capacity while OPMA 
         is running
       //Default property is 100% for Morning, Evening, Night - 0% for Day

     Probability_Rain <0-100>
       //Sets the random chance that it will be raining while OPMA is running
       //Default property is 50% for Night - 35% for Morning, Evening - 0% for Day

     Probability_Thunder <0-100>
       //Sets the random chance that Thunder and Lightning effects will happen while OPMA is running and it is Raining
       //Default property is 50% for Night - 35% for Morning, Evening - 0% for Day

     StartingHour <0-23>
       //For use with TimeOfDay setting to specify at what time a State will start. StartingHour of 0 is midnight.
       //Default property is 6 for Morning - 9 for Day - 19 for Evening - 22 for Night
     

  (D)Light Settings in the Map:

     Light_Intensity <value> (Percentage)
       //Adjusts the Light Brightness (from lightsources)
       //Value: 100 is normal, 50 is two times less, 150 is stronger

     Level_AmbientBrightness <0-255>
       //Ambient Lighting adjustment (non-directional light)

     Light_Hue <0-255>
       //For Light and Ambient Light

     Light_Saturation <0-255>
       //For Light and Ambient Light
     

  (E)Examples of Admin Commands:
 
    admin set MidnightAssault.MA_Mutator Night (Probability_Rain=25)
       //Set a Probability of Rain to 25% for the Night

     admin set MidnightAssault.MA_Mutator Evening (Probability_Enabled=0)
       //Disable The Evening Mode (a perfectly normal game, withouth OPMA running)

     admin set MidnightAssault.MA_Mutator Morning (Light_Intensity=50)
       //Make the lights 2 times weaker in the Morning

     admin set MidnightAssault.MA_Mutator Day (Light_Intensity=50)
       //Make the lights 2 times weaker in the Morning



[4]Client Commands:
*******************

  s_kNightVision
    //Turns your NightVision On/Off, you can set this in your Tactical Ops Binding Preferences also

  s_kFlashlight
    //Turns your FlashLight On/Off, you can set this in your Tactical Ops Binding Preferences also

  GlowStick
    //This is the command to toss your GlowSticks around in the map

  ToggleRain
    //If your framerates suffer or your just plain old lame, you can turn rain off on the client end



[5]Installation:
****************

  (A)File Tree:

     MATex.utx is placed in main Textures directory
     MidnightAssault.u is placed in main System directory
     MidnightAssault.int is placed in main System directory (this file is not required if running as a ServerActor)
     

  (B)Run as ServerActor ini SetUp:

     ServerActors=MidnightAssault.MA_ServerActor
     ServerPackages=MATex
     ServerPackages=MidnightAssault


  (C)Run as ServerMutator ini SetUp:

     ServerPackages=MATex
     ServerPackages=MidNightAssault


Known Issues:
*************

  We recommend you run your server with GhostCam disabled.  Sometimes, clients MAY experience keyboard lockups if they ghost
  to the ceiling of a map while it is raining (RainGenerator falling out of world on some maps).

  RainGenerator may cause hits in framerates on some systems.  This can be disabled on the client's end as stated above 
  in Client Commands.

  Maps with extra tall ceilings in the buildings may experience some rain inside them (due to positioning of the
  RainGenerator over the player meshes).

  Unlit textures could not be forced to 'False', so you will still see them as unlit textures in maps.



[7]Credits:
***********

karr: Lead Coding & Ideas

IVfluids: BetaTesting & Ideas

m&m aka Chris_S: Logo Art


                                    //////////   ///////////         ///////   /////   ///////
                                  ////    ////   ////    ////  //    //// // // ////  //// ///
                                ////      ////  ////    ////        ////  //// ////  ////  ///
                               ////      ////  ////    ////        ////   //  ////  ////   ///
                              ////      ////  ////    ////        ////       ////  ///////////
                             ////      ////  ///////////         ////       ////  ////     ///
                            ////      ////  /////               ////       ////  ////      ///
                            ////    ////   ////           //   ////       ////  ////       ///
                            //////////   /////               /////      ///// /////       ////