Commit ca973f82 authored by sirjorj's avatar sirjorj

update documentation

parent 8e10c175
......@@ -127,14 +127,48 @@ Assuming the everything was entered correctly and the squads were valid, a game
When the game starts, you are presented with a simple prompt. This is how you issue commands to change the game state. The commands fall into a few basic categories:
==== Helper
These commands do other things like display help, show current game state, or exit.
These commands do things like display help, show current game state, or exit.
|===
| `?` | Show commands
| `S` or `s` | Show current game state
| `qqq` | Quit
| `?` | Show commands
| | Show current game state (just hit enter on an empty prompt)
| `qqq` | Quit
|===
==== Squad Manipulation
==== Game Info
These command set some global information on the overlay.
|===
| `title:[t]` | Sets the stream title to [t]
| `title` | Restores the stream title to its default (as specified in the config file or blank if not configured)
| `i[p]` | Set initiative to player [p] - 1: player1, 2: player2, 0: none
|===
Examples:
|===
| `title:Store Championship - Top 16` | Set the title on top of the overlay to "Store Championship - Top 16"
| `title:` | Set the title to nothing, which removes it from the overlay
| `title` | Restore the title to whatever the config file sets it to
| `i2` | Player 2 has initiative
| `i0` | Don't show initiative
|===
==== Data Lookup
These commands print game data to the console. They do not affect the overlay.
|===
| `p [p]` | Show stats for pilot that matches [p] - If multiple match, a list is printed
| `p [p] [f] [s]` | Show stats for pilot that matches the specified pilot/faction/ship
| `u [u]` | Show stats for upgrade that matches [u] - If multiple match, a list is printed
| `u [t] [u]` | Show stats for upgrade that matches the specified type/upgrade
|===
Examples:
|===
| `p soontir` | Show info about Soontir Fel
| `p bobafett scum firespray31` | Show info about scum Boba Fett
| `u tlt` | Show info about Twin Laser Turret
| `u amd r2d2` | Show info about astromech R2-D2 (as opposed to crew)
|===
==== Game State Manipulation
These commands are for adjusting the players' squads to reflect the game state. They include adding or remove hull or shield, making a ship or upgrade active or inactive, adding or removing an extra munitions token, or flipping an upgrade from one side to the other. The basic syntax of these is:
===== Pilot
......@@ -178,7 +212,7 @@ These commands are for adjusting the players' squads to reflect the game state.
|===
* Multiple actions can be issued to the same/upgrade in one command (`11ssh` will remove 2 shields and 1 hull from player 1, ship 1)
* Multiple commands, separated by spaces, can be entered at one time (`11h 12h` will remove 1 hull from player 1, ships 1 and 2)
* Multiple commands, separated by commas, can be entered at one time (`11h, 12h` will remove 1 hull from player 1, ships 1 and 2)
Examples:
......@@ -191,13 +225,45 @@ Examples:
|`13shha` |Player 1, Ship 3 loses a shield, 2 hull, and is destroyed
|`211a` |Player 2, Ship 1's 1st upgrade is deactivated (fired munition, stealth device lost, glitterstim popped, etc)
|`12A` |Player 1, Ship 2 is deployed (ex. Phantom undocks from Ghost)
|`11s 111a` |Player 1, Ship 1 loses and shield and upgrade 1 is disabled (ex. Stealth Device)
|`11s, 111a` |Player 1, Ship 1 loses and shield and upgrade 1 is disabled (ex. Stealth Device)
|`231x` |Player 2, Ship 3 fires torpedo (upgrade slot 1) and loses Extra Munitions token.
|`111f` |Player 1, Ship 1 flips Pivot Wing (upgrade slot 1) NOTE: 111F would have the same result
|`11h 12h 13h 14h` |Player 1, Ships 1-4 lose 1 hull (bomb detonation)
|`11h,12h,13h,14h` |Player 1, Ships 1-4 lose 1 hull (bomb detonation)
|`113(glitterstim)` |Player 1, Ship 1 replaces upgrade 3 with Glitterstim (assuming upgrade 3 is Illicit)
|===
==== Stat Override
These commands let you manually override the stat numbers for a ship or remove a previously set override.
* *Override:* [PLAYER][SHIP]O[STAT][VALUE]
* *Remove:* [PLAYER][SHIP]o[STAT]
*PLAYER* - Which player has a stat that you want to override? (1 or 2)
*SHIP* - Which ship has a stat that you want to override? (`1` to `number of ships`, counting down)
*O* or *o* - `O` to override a value, `o` to remove the override
*STAT* - What do you want to override? One of the following:
|===
| `sk` | Pilot Skill
| `at` | Attack
| `ag` | Agility
| `hu` | Hull
| `sh` | Shield
|===
*VALUE* - The new value
Examples:
|===
|`11Osk0` | Player1, Ship1 goes to pilot skill 0
|`23Osk9` | Player2, Ship3 goes to pilot skill 9 (Thweek)
|`23osk` | Player2, Ship3 get its pilot skill restored to its proper value
|===
==== Popup
These commands show temporary pop-up info such as dice results.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment