coldboot

***********************************************
| ADMIRALZEECH'S TIERED GROUPS MOD - FA EDITION
***********************************************

This mod splits grouping into 2 layers - 5 Battalions, with 5 Squads
each.  It also contains some handy functions for manipulating groups.

Note: This mod cannot be used at the same time as Goom's Advanced
Groups mod.

----------------
|Overview

Instead of 10 groups as normal, now you have 5 Battalions, each with 5
Squads.

Detailed keylist is below, but generally:

Keys 6-0 selects the Battalion Keys 1-5 selects the Squad

-----------------
|Onscreen Display

On the top right of your screen, above your ACU avatar, is the Tiered
Groups display.  It shows your currently selected Battalion and Squad
in the format:

Battalion : Squad

You will always have a current Battalion.  However, sometimes you wont
have a current Squad, in which case the Squad indicator will show "X"


-----------------------
| Key and Function List

[1]-[5]
- Select all units in Squad 1-5. Factories will not be
selected.

- Pressing multiple times will select each unit in the
squad one by one.  To select the whole squad again, clear your
selection by left clicking on some empty space, or select another
squad and then switch back.

- This will deselect your currently selected units regardless of
whether the desired Squad has any units or not.


[Ctrl + 1-5]
- Make selected units be the desired Squad under the
current Battalion. They will be removed from their old squad.  (Units
can only belong to one squad at a time in this mod.)


[Shift + 1-5]
- Appends currently selected units into the desired
squad.  The selection will remain unchanged.


[Ctrl + Shift + 1-5]
- Adds the desired squad to the current selection. It's the same as
Shift + 1-0 in the normal game.


[6]-[0]
- Selects all units in Squads 1-4 of the specified
battalion. Squad 5 is a special squad, and will not be selected. (See
Tips below)


[Shift + 6-0]
- Changes the current Battalion without changing your
selected units. Handy if you've selected some units and want to add
them to a different Battalion.


[Y]
- Makes selected units be the current Battalion, sorted by type.
Performs the same thing as below, but on the current Battalion.

[Ctrl + 6-0]
- Makes selected units be the desired Battalion.  Each type of unit
will go into a seperate Squad, from 1 to 4.  Units will be grouped by
tech level and unit ID.  So lower tech units will be in the lower
squad numbers, and higher tech units will be in the higher squad
numbers.  (Units will be removed from their old squads. Squads 1-4 in
the desired Battalion will be cleared. Squad 5 will be unaffected.)


[Shift + Y]
- Makes selected units be the current Battalion, divided evenly.
Performs the same thing as below, but on the current Battalion.

[Ctrl + Shift + 6-0]
- Makes selected units be the desired Battalion.
Units will be divided evenly between Squads 1 to 4.  Different types
of units will be evenly divided between Squads.  (Units will be
removed from their old squads.  Squads 1-4 in the desired Battalion
will be cleared. Squad 5 will be unaffected.)


[G]
- Filters current selection to only those that belong to the
current battalion.  Useful if you want to select all members of a
battalion in a particular area, just shift-dragbox everything in the
area and hit G.

[Shift + G]
- Selects factories in the the current squad. If there is no current
squad, it will select factories in squad 5.

[Ctrl + G]
- Removed selected units from any squads.


( Shift + [ )
- Sets all selected units to HOLD FIRE.
Might be handy in conjunction with Cascade Fire Mode, see below.


-----------------------
| CASCADE FIRE MODE

( ] )
(ie. the right bracket key)
- Cascade Fire mode. An experimental feature, dunno if its useful.

- Basically it takes the CURRENT BATTALION, and sets all units to HOLD
FIRE.   Then, after one second, the first squad is set to FIRE GROUND,
after 2s, the second squad is set to FIRE GROUND, etc.

- It's intended to be used for T2 PDs, Arty, etc.  Just divide them up
  into 4 squads, hit ], and each squad will fire one after the other, rather
  than everything firing at once (and possibly overkilling targets)

- Normal ] = 1 sec delay
- Shift + ] = 2 sec delay
- Ctrl + ] = 5 sec delay


-----------------------
| Tips and notes

So basically you divide up your groups into Battalions and Squads. For
example, you could have Squad 1 to have Tanks, Squad 2 to have Mobile
Artillery, and Squad 3 to have Mobile Shields.

You can then have multiple Battalions of this type of
structure. Eg. Battalions 6 and 7.


Assigning a factory to a Battalion:Squad works the same way as normal
SupCom. All units it produces will be also assigned to that
Battalion:Squad.


Note that Squad 5 is special.  Pressing a Battalion button will only
select Squads 1-4 of that Battalion.  Also, the auto-fill-Battalion
keys (Y, Shift-Y, Ctrl + 6-0, etc) wont touch Squad 5.

This is handy so that you can assign factories to Squad 5.  All units
it produces will also be assigned to Squad 5, and then you can easily
select them with the "5" key and assign them to other squads, or use
Auto-Fill without affecting the factory.

You could also use Squad 5 for units you dont want to move together
with the rest of the battalion (eg. non combat units, scouts, AA) or
for temporarily gathering a lot of different units so you can select
each type and assign them to different Squads.


Another handy feature is, when you have a Squad selected, pressing the
Squad number key again will allow you to scroll through the units in
the squad one-by-one.

So, for example, you can have all your missiles in one Squad, and then
by repeated pressing the Squad number key, you can select and fire
them each at different targets individually.

Another handy use is to double-click all your Metal Extractors and
then assign them to a Squad.  You can then upgrade them one by one
using this feature.


Finally, I added the Y and Shift-Y keys after finding that
Ctrl+Shift+6 etc was too much of a reach for my fingers. I've left
those original bindings for Auto-Fill Battalion in, but you should
probably try to use Y and Shift-Y versions instead.


Hmm, however, I dont use groups much in SupCom normally, so far I've
only used the features of this mod in select circumstances.  We'll see
what happens once I get used to it :/

-----------------
| Changelist

I've removed the V / Ctrl-V swap since Goom has released his mod "GUI"
that allows for user-edited hotkeys.

------------------
| The End

This mod is mainly for my own comfort and use, so it's provided "As
is".  However, if you have a feature request and have a good reason
for it, tell me and I'll think about it.

Of course, Bug Reports are always welcome.


Special thanks to Goom for letting me use his Advanced Groups mod as a
starting point, and for providing lots of help along the way.

This mod was written using EmacsW32, together with lua-mode.el

Bye-Be!
-AdmiralZeech