Change the games folder to maps and add it to the gitignore, updating the USAGE text to reflect this
This commit is contained in:
parent
7cf33ba458
commit
24e17450aa
4 changed files with 104 additions and 7 deletions
56
USAGE.txt
Normal file
56
USAGE.txt
Normal file
|
@ -0,0 +1,56 @@
|
|||
To convert this file to c++ syntax use
|
||||
$ cat USAGE.txt | sed 's/\t/\\t/g' | sed ':a;N;$!ba;s/\n/\\n\n/g' | sed 's/^/"/' | sed 's/$/"/'
|
||||
|
||||
NAME
|
||||
ttrts - Tiny Terminal RTS
|
||||
|
||||
SYNOPSYS
|
||||
ttrts [OPTIONS...] MAPFILE
|
||||
|
||||
DESCRIPTION
|
||||
ttrts is a tiny terminal based RTS where that uses text files as order lists to control it's units.
|
||||
|
||||
This means that any user, program or cat that can read and write to text files can play the game.
|
||||
|
||||
USAGE
|
||||
When invoked, ttrts will set up a full game and output a single file representing the current gamestate into a local directory called ttrts_{GAME_NAME}.
|
||||
|
||||
This file can be read in and interpretted by human, robot, or cat.
|
||||
ttrts will wait for orders files to be placed in it's current working directory.
|
||||
|
||||
File name formats:
|
||||
gamestate Turn_{TURN_NUMBER}.txt
|
||||
orders Turn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt
|
||||
|
||||
Once orders have been set for each player taking part, ttrts consumes order files,
|
||||
calculates new game state and outputs a new file.
|
||||
|
||||
This process repeats until a winner is chosen!
|
||||
|
||||
OPTIONS
|
||||
MAPFILE:
|
||||
File to read in the initial game state from
|
||||
|
||||
GAMESTATE FILE FORMAT
|
||||
Name
|
||||
Turn_{TURN_NUMBER}.txt
|
||||
Contents
|
||||
===== {GAME_NAME} =====
|
||||
SIZE:[{X},{Y}]
|
||||
TURN:{TURN_NUMBER}
|
||||
~~~~
|
||||
UNIT:{UNIT_ID} tm:{TEAM_NUMBER} vs:{VISUAL} dr:{DIRECTION(NESW)} ps:[{X},{Y}]
|
||||
...
|
||||
|
||||
ORDER FILE FORMAT
|
||||
Name
|
||||
Turn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt
|
||||
Contents
|
||||
ORDER:{ORDER_CHAR} id:{UNIT_ID}
|
||||
...
|
||||
|
||||
ORDERS
|
||||
F - Move unit forward one space
|
||||
L/R - Rotate unit left or right
|
||||
A - Attack space in front of unit
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue