Update the README.md files with newer and more useful information
fixes #4
This commit is contained in:
parent
f6f6d6fafd
commit
98deae237b
4 changed files with 35 additions and 23 deletions
32
README.md
32
README.md
|
@ -1,17 +1,27 @@
|
||||||
# TTRTS
|
# TTRTS
|
||||||
|
*v0.0.1*
|
||||||
*The Tiny Terminal RTS where the players write their AIs*
|
*The Tiny Terminal RTS where the players write their AIs*
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-----------------------------------------------------------
|
||||||
## Introduction
|
## Introduction
|
||||||
A simple terminal based RTS game that uses txt files to communicate game state and unit commands. TTRTS was
|
A simple terminal based RTS game that uses text files to communicate game state and unit commands.
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
TTRTS was is from the ground up designed to be a fun way to practice programming. Any programming language than can handle file I/O can be used to make an AI for TTRTS, and this extensibility allows for any type of programmer to have fun and enjoy designing and playing against their friends.
|
||||||
## Gameplay
|
|
||||||
1. The ttrts client is run from the command line with initial parameters
|
|
||||||
2. The client outputs a gamestate text file
|
|
||||||
3. A player, program or cat reads the state and outputs instructions for their units.
|
|
||||||
4. The client reads in instructions and processes the turn
|
|
||||||
5. If no winner is reached, skip back to step 2
|
|
||||||
6. The game client outputs a final summary file with the winner
|
|
||||||
|
|
||||||
*see [game](source/game) for full game rules*
|
-----------------------------------------------------------
|
||||||
|
## Building TTRTS
|
||||||
|
|
||||||
|
#### Requirements
|
||||||
|
* cmake - our build system uses cmake
|
||||||
|
* Linux/OSX - currently no support for Windows
|
||||||
|
|
||||||
|
#### To Build
|
||||||
|
$ git clone https://github.com/mdiluz/ttrts.git
|
||||||
|
$ cd ttrts
|
||||||
|
$ ./bootstrap.sh
|
||||||
|
$ ./ttrts # To launch binary and display usage
|
||||||
|
|
||||||
|
-----------------------------------------------------------
|
||||||
|
## Further Information
|
||||||
|
|
||||||
|
See [the ttrts binary readme](source/ttrts/README.md) for full usage and game rules
|
||||||
|
|
|
@ -1,17 +1,19 @@
|
||||||
# Targets
|
# Targets
|
||||||
### ttrts
|
### ttrts
|
||||||
Main TTRTS executable , runs from the command line and acts as client
|
Main TTRTS binary, runs from the command line and acts as host for games
|
||||||
|
|
||||||
### ttrts-test
|
### test (ttrts-test)
|
||||||
Test executable, to be compiled and run to test various functionality
|
Test binary, to be compiled and run to test various functionality
|
||||||
|
|
||||||
### ttrts-gen
|
### gen (ttrts-gen)
|
||||||
Binary to generate map example map files
|
Binary to generate example map files
|
||||||
|
|
||||||
# Libraries
|
# Libraries
|
||||||
### game
|
### game
|
||||||
Implementation of the RTS rules and simulation.
|
Implementation of the RTS rules and simulation
|
||||||
|
|
||||||
### maths
|
### maths
|
||||||
simple maths library for 2D calculations and types
|
Simple maths library for 2D calculations and types
|
||||||
|
|
||||||
|
### scripts
|
||||||
|
Directory of scripts used in build process
|
||||||
|
|
|
@ -3,15 +3,15 @@ TTRTS Gameplay
|
||||||
|
|
||||||
The game takes place in a series of simultaneous turns on an arbitrarily sized 2D board.
|
The game takes place in a series of simultaneous turns on an arbitrarily sized 2D board.
|
||||||
|
|
||||||
Each player is in control of a set number of starting units, each turn receives data on the status of the board.
|
Each player is in control of a set number of starting units, and each turn receives data on the status of the board.
|
||||||
|
|
||||||
Each player must then issue a single command to each unit in their control.
|
Each player must then issue a command to each unit in their control.
|
||||||
|
|
||||||
The engine then takes all commands, evaluates all movement first simultaneously, then all other commands.
|
All commands are evaluated simultaniously.
|
||||||
|
|
||||||
All attempted movement to the same square by two or more units will fail.
|
All attempted movement to the same square by two or more units will fail.
|
||||||
|
|
||||||
Friendly fire is enabled by default.
|
Friendly fire is enabled by default.
|
||||||
|
|
||||||
|
A player wins when all opposing units have been destroyed.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
## NAME
|
## NAME
|
||||||
ttrts - Tiny Terminal RTS
|
ttrts - Tiny Terminal RTS v0.0.1
|
||||||
|
|
||||||
## SYNOPSYS
|
## SYNOPSYS
|
||||||
ttrts MAPFILE
|
ttrts MAPFILE
|
||||||
|
|
Loading…
Add table
Reference in a new issue