mdiluz/ttrts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update usage and gitignore to not exlude code folders

Browse source
This commit is contained in:
Marc Di Luzio 2014-12-16 13:33:11 +00:00
parent 24e17450aa
commit dbfd932a64
3 changed files with 81 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

7
.gitignore vendored
View file

@ -1,6 +1,5 @@
build build/
maps maps/
ttrts
*.user *.user
*.sublime* *.sublime*
.idea *.idea

26
USAGE.txt
View file

@ -8,22 +8,24 @@ SYNOPSYS
ttrts [OPTIONS...] MAPFILE ttrts [OPTIONS...] MAPFILE
DESCRIPTION DESCRIPTION
ttrts is a tiny terminal based RTS where that uses text files as order lists to control it's units. 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. This means that any user, program or cat that can read
and write to text files can play the game.
USAGE 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}. 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. This file can be read in and interpretted by human, robot
ttrts will wait for orders files to be placed in it's current working directory. or cat. ttrts will wait for orders files to be placed in
it's current working directory.
File name formats: Once orders have been set for each player taking part
gamestate Turn_{TURN_NUMBER}.txt ttrts will calculate the new game state and output a new
orders Turn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt gamestate file for the next turn.
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! This process repeats until a winner is chosen!
@ -39,7 +41,7 @@ GAMESTATE FILE FORMAT
SIZE:[{X},{Y}] SIZE:[{X},{Y}]
TURN:{TURN_NUMBER} TURN:{TURN_NUMBER}
~~~~ ~~~~
UNIT:{UNIT_ID} tm:{TEAM_NUMBER} vs:{VISUAL} dr:{DIRECTION(NESW)} ps:[{X},{Y}] UNIT:{ID} tm:{TEAM} vs:{VIS} dr:{DIR(NESW)} ps:[{X},{Y}]
... ...
ORDER FILE FORMAT ORDER FILE FORMAT

44
source/ttrts/main.cpp
View file

@ -14,22 +14,24 @@ static const char* sk_usage =
"\tttrts [OPTIONS...] MAPFILE\n" "\tttrts [OPTIONS...] MAPFILE\n"
"\n" "\n"
"DESCRIPTION\n" "DESCRIPTION\n"
"\tttrts is a tiny terminal based RTS where that uses text files as order lists to control it's units.\n" "\tttrts is a tiny terminal based RTS where that uses text\n"
"\tfiles as order lists to control it's units.\n"
"\n" "\n"
"\tThis means that any user, program or cat that can read and write to text files can play the game.\n" "\tThis means that any user, program or cat that can read\n"
"\tand write to text files can play the game.\n"
"\n" "\n"
"USAGE\n" "USAGE\n"
"\tWhen 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}.\n" "\tWhen invoked, ttrts will set up a full game and output a\n"
"\tsingle file representing the current gamestate into a \n"
"\tlocal directory called ttrts_{GAME_NAME}.\n"
"\n" "\n"
"\tThis file can be read in and interpretted by human, robot, or cat.\n" "\tThis file can be read in and interpretted by human, robot\n"
"\tttrts will wait for orders files to be placed in it's current working directory.\n" "\tor cat. ttrts will wait for orders files to be placed in \n"
"\tit's current working directory.\n"
"\n" "\n"
"\tFile name formats:\n" "\tOnce orders have been set for each player taking part \n"
"\t gamestate Turn_{TURN_NUMBER}.txt\n" "\tttrts will calculate the new game state and output a new \n"
"\t orders Turn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt\n" "\tgamestate file for the next turn.\n"
"\n"
"\tOnce orders have been set for each player taking part, ttrts consumes order files,\n"
"\tcalculates new game state and outputs a new file.\n"
"\n" "\n"
"\tThis process repeats until a winner is chosen!\n" "\tThis process repeats until a winner is chosen!\n"
"\n" "\n"
@ -39,21 +41,21 @@ static const char* sk_usage =
"\n" "\n"
"GAMESTATE FILE FORMAT\n" "GAMESTATE FILE FORMAT\n"
"\tName\n" "\tName\n"
"\t\tTurn_{TURN_NUMBER}.txt\n" "\t Turn_{TURN_NUMBER}.txt\n"
"\tContents\n" "\tContents\n"
"\t\t===== {GAME_NAME} =====\n" "\t ===== {GAME_NAME} =====\n"
"\t\tSIZE:[{X},{Y}]\n" "\t SIZE:[{X},{Y}]\n"
"\t\tTURN:{TURN_NUMBER}\n" "\t TURN:{TURN_NUMBER}\n"
"\t\t~~~~\n" "\t ~~~~\n"
"\t\tUNIT:{UNIT_ID} tm:{TEAM_NUMBER} vs:{VISUAL} dr:{DIRECTION(NESW)} ps:[{X},{Y}]\n" "\t UNIT:{ID} tm:{TEAM} vs:{VIS} dr:{DIR(NESW)} ps:[{X},{Y}]\n"
"\t\t...\n" "\t ...\n"
"\n" "\n"
"ORDER FILE FORMAT\n" "ORDER FILE FORMAT\n"
"\tName\n" "\tName\n"
"\t\tTurn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt\n" "\t Turn_{TURN_NUMBER}_Team_{TEAM_NUMBER}.txt\n"
"\tContents\n" "\tContents\n"
"\t\tORDER:{ORDER_CHAR} id:{UNIT_ID}\n" "\t ORDER:{ORDER_CHAR} id:{UNIT_ID}\n"
"\t\t...\n" "\t ...\n"
"\n" "\n"
"ORDERS\n" "ORDERS\n"
"\tF - Move unit forward one space\n" "\tF - Move unit forward one space\n"