--- Sonic Robo Blast 2 - Retro Monitors Addon for 2.2.13+ ---

This text document serves as a guide for setting up these monitors to behave 
like they did in specific versions of SRB2.

If you plan to use anything from this PK3, please do not include this document. 
Additionally, everything in the SOC, Maps, and Level Select Pictures folders are 
not required for these assets to work in a different mod.

*** IMPORTANT NOTES REGARDING SHIELDS ***

Two shields present in previous versions of SRB2, specifically the Inferno shield 
and Liquid shield, have been replaced with the Flame shield and Bubble shield, 
respectively. The Elemental shield from 1.01-1.08 has been replaced with the 
Bubble shield, due to being functionally identical to 1.09's Liquid shield (it 
protects against water damage, but not fire damage).

There are a few Lua scripts included that attempt to replicate the look and 
behavior of the old shields, those being the scripts outside of the subfolders 
within "RetroMonitors". All of these can be omitted if you simply want to use the 
modern variants of the shields. You may also check the "Extra" flag on any of the 
shield monitors to disable the "era-swapped" shields.

Each Lua script contains the following:

TGFShield.lua - TGF Shield object
FDShieldOrb.lua - Final Demo Shield object
21PityShield.lua - 2.1 Pity Shield object
21ArmageddonShield.lua - 2.1 Armageedon Shield object
21ForceShield.lua - 2.1 Force Shield object
ShieldEra.lua - "Era-swapped" shields code (handles what shield you get depending on the monitor's era)
20ForceReflect.lua - 2.0 Force Shield reflection code (reflects projectiles off of a player with a 2.0 Force Shield)
FDInfernoShield.lua - Final Demo Inferno Shield code (spawns Elemental Shield flames while spindashing)

By default, the pre-2.1 Attraction Shield will use SRB2 The Past's "FD Gold" 
skin color, or FrivolousAqua's "Legacy Gold" skin color from the "Legacy Palettes" 
addon, if either are loaded in the game. This makes the shield's color look more 
accurate to how it looked in 2.0 and below. However, it can be left out if desired, 
using the vanilla game's "Gold" skin color instead.

-- 2.1 MONITORS --

Unlike in 2.2, the console command "matchboxes" will affect how these monitors 
spawn in the Race gametype instead of "competitionboxes". The S3K shield 
monitors have been omitted since they were not officially part of the monitor 
roster in 2.1.

It is also important to note that these ports use the modern explosion sprite 
instead of the 2.1 sprite to conserve on object freeslots.

-- FINAL DEMO / 2.0 MONITORS --

Setting the map Thing's parameter alters the respawning behavior, as well as 
what each shield monitor gives the player. The extra life monitors will not 
display the player's 1-up sprite below the 1.09 era.

** Parameter 0 - 2.0 Era **

Each monitor can be given a weighted strong or weak respawn randomization based 
on the flags checked. Monitor toggles are set as Off, Low, Medium, or High (0, 
1-3, 4-6, and 7-9, respectively).

Blue Shield		= Force Shield
Green Shield	= Elemental Shield
Yellow Shield	= Attraction Shield
White Shield	= Whirlwind Shield
Red Shield		= Armageddon Shield

** Parameter 1 - 1.09-1.09.4 Era **

Monitor respawn randomization is based on the "tv_" console variables. The 
silver ring's respawn randomization is mapped to "tv_recycler". The variable 
"tv_eggman" does nothing, because its respawn randomization was disabled in this 
era. Monitor toggles behave similar to the 2.0 era.

Blue Shield		= Liquid Shield
White Shield	= Whirlwind Shield
Yellow Shield	= Attraction Shield
Red Shield		= Inferno Shield
Black Shield	= Armageddon Shield

** Parameter 2 - 1.08 Era **

The randomization is functionally similar to the 1.09-1.09.4. The same applies 
to the monitor toggles.

Blue Shield		= Pity Shield
Green Shield	= "Elemental" Shield
Yellow Shield	= Attraction Shield
Red Shield		= Inferno Shield
Black Shield	= Armageddon Shield

** Parameter 3 - 2K3-1.04 Era **

Both the randomization and monitor toggles are similar to the 1.08 era, except 
monitors can respawn as Eggman monitors and there are only two values for each 
monitor toggle: "Yes" and "No".

Blue Shield		= Pity Shield
Green Shield	= "Elemental" Shield
Yellow Shield	= Attraction Shield
Red Shield		= Inferno Shield
Black Shield	= Armageddon Shield

** Parameter 4 - 1.1 Era **

Basically the same as the 2.0 monitors, except with the Armageddon Shield is black.

Blue Shield		= Force Shield
Green Shield	= Elemental Shield
Yellow Shield	= Attraction Shield
White Shield	= Whirlwind Shield
Black Shield	= Armageddon Shield

-- DEMO MONITORS --

These are entirely different beasts compared to their Final Demo counterparts. 
The Demo monitors aren't affected by the player's multiplayer monitor settings 
since there were none in Demo 4.35 and below.

Also, for some reason, they give you their power-up instantly when in a netgame 
or a multiplayer game.

-- TGF MONITORS --

These work similarly to the Demo monitors in that they can't be altered by the 
player's multiplayer settings. They can be destroyed without needing to spin 
into them, imitiating their behavior from the TGF era. Also, the time power-up 
will not give the player a time boost outside of a Special Stage.
