diff --git a/index.html b/index.html index 48a2aa0..801b011 100644 --- a/index.html +++ b/index.html @@ -46,91 +46,51 @@
-

+

+TTRTS v0.1.0

+ +

The Tiny Terminal RTS where the players write their AIs

+ +
+ +

Introduction

-

We aim to create a simple terminal based rts where a user can program an AI to control their army

+

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

+Building TTRTS -
    -
  1. ttrts clients are run from the command line
  2. -
  3. ttrts-server is launched from the command line
  4. -
  5. clients will connect to server and confirm initial board state - -
      -
    1. clients output a text file with game data for this turn
    2. -
    3. a player, or program, reads the game data file and outputs an instructions file
    4. -
    5. clients read the instructions file, simulates the turn
    6. -
    7. game state is verified between clients and server
    8. -
    9. repeat until an end state is reached
    10. -
    -
  6. -
  7. once game is finished, host and clients disconnect and a winner is notified
  8. -
- -

see game for full game rules

- -
- -

-Source

- -

-Targets

- -
-ttrts
- -

Main TTRTS executable , runs from the command line and acts as client

- -
-ttrts-server
- -

TTRTS server executable, runs from the command line acting as server

- -
-player
- -

Custom player AI code, this should contain examples and test code to help newcomers begin their journey

- -
-ttrts-test
- -

Test executable, to be compiled and run to test various functionality

- -

-Libraries

- -
-game
- -

Implementation of the RTS rules and simulation. game has full information on it's implementation.

- -
-net
- -

Net code for hosting the server and communicating with clients

- -
-ui
- -

Wrapper for user interface for the terminal, this only really needs three stages

+

+Requirements

-
-maths
+

+To Build

-

simple maths library for 2D calculations and types

+
$ 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 for full usage and game rules

+ +

See my ttrts-players repository for examples of players