ttrts/README.md

30 lines
1.2 KiB
Markdown
Raw Normal View History

2014-12-20 17:31:13 +00:00
# TTRTS v0.1.0
2014-12-16 13:12:53 +00:00
*The Tiny Terminal RTS where the players write their AIs*
-----------------------------------------------------------
2014-12-16 13:12:53 +00:00
## Introduction
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.
-----------------------------------------------------------
## Building TTRTS
#### Requirements
* cmake - our build system uses cmake
2014-12-20 17:47:10 +00:00
* Linux/OSX - currently no support for Windows, tracked with [Issue #9](https://github.com/mdiluz/ttrts/issues/9)
#### 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
See [my ttrts-players repository](https://github.com/mdiluz/ttrts-players) for examples of players