Create gh-pages branch via GitHub
This commit is contained in:
Marc Di Luzio
parent
67420151ae
commit
5931643ab8
2 changed files with 34 additions and 74 deletions
104
index.html
104
index.html
|
|
@ -46,91 +46,51 @@
|
|||
|
||||
|
||||
<section id="main_content">
|
||||
<h1>
|
||||
<a id="ttrts-v010" class="anchor" href="#ttrts-v010" aria-hidden="true"><span class="octicon octicon-link"></span></a>TTRTS v0.1.0</h1>
|
||||
|
||||
<p><em>The Tiny Terminal RTS where the players write their AIs</em></p>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2>
|
||||
<a id="introduction" class="anchor" href="#introduction" aria-hidden="true"><span class="octicon octicon-link"></span></a>Introduction</h2>
|
||||
|
||||
<p>We aim to create a simple terminal based rts where a user can program an AI to control their army</p>
|
||||
<p>A simple terminal based RTS game that uses text files to communicate game state and unit commands. </p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2>
|
||||
<a id="gameplay" class="anchor" href="#gameplay" aria-hidden="true"><span class="octicon octicon-link"></span></a>Gameplay</h2>
|
||||
<a id="building-ttrts" class="anchor" href="#building-ttrts" aria-hidden="true"><span class="octicon octicon-link"></span></a>Building TTRTS</h2>
|
||||
|
||||
<ol>
|
||||
<li>ttrts clients are run from the command line</li>
|
||||
<li>ttrts-server is launched from the command line </li>
|
||||
<li>clients will connect to server and confirm initial board state
|
||||
|
||||
<ol>
|
||||
<li>clients output a text file with game data for this turn</li>
|
||||
<li>a player, or program, reads the game data file and outputs an instructions file</li>
|
||||
<li>clients read the instructions file, simulates the turn </li>
|
||||
<li>game state is verified between clients and server</li>
|
||||
<li>repeat until an end state is reached</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li>once game is finished, host and clients disconnect and a winner is notified</li>
|
||||
</ol>
|
||||
|
||||
<p><em>see <a href="game">game</a> for full game rules</em></p>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2>
|
||||
<a id="source" class="anchor" href="#source" aria-hidden="true"><span class="octicon octicon-link"></span></a>Source</h2>
|
||||
|
||||
<h3>
|
||||
<a id="targets" class="anchor" href="#targets" aria-hidden="true"><span class="octicon octicon-link"></span></a>Targets</h3>
|
||||
|
||||
<h5>
|
||||
<a id="ttrts" class="anchor" href="#ttrts" aria-hidden="true"><span class="octicon octicon-link"></span></a>ttrts</h5>
|
||||
|
||||
<p>Main TTRTS executable , runs from the command line and acts as client</p>
|
||||
|
||||
<h5>
|
||||
<a id="ttrts-server" class="anchor" href="#ttrts-server" aria-hidden="true"><span class="octicon octicon-link"></span></a>ttrts-server</h5>
|
||||
|
||||
<p>TTRTS server executable, runs from the command line acting as server</p>
|
||||
|
||||
<h5>
|
||||
<a id="player" class="anchor" href="#player" aria-hidden="true"><span class="octicon octicon-link"></span></a>player</h5>
|
||||
|
||||
<p>Custom player AI code, this should contain examples and test code to help newcomers begin their journey</p>
|
||||
|
||||
<h5>
|
||||
<a id="ttrts-test" class="anchor" href="#ttrts-test" aria-hidden="true"><span class="octicon octicon-link"></span></a>ttrts-test</h5>
|
||||
|
||||
<p>Test executable, to be compiled and run to test various functionality</p>
|
||||
|
||||
<h3>
|
||||
<a id="libraries" class="anchor" href="#libraries" aria-hidden="true"><span class="octicon octicon-link"></span></a>Libraries</h3>
|
||||
|
||||
<h5>
|
||||
<a id="game" class="anchor" href="#game" aria-hidden="true"><span class="octicon octicon-link"></span></a>game</h5>
|
||||
|
||||
<p>Implementation of the RTS rules and simulation. <a href="game">game</a> has full information on it's implementation.</p>
|
||||
|
||||
<h5>
|
||||
<a id="net" class="anchor" href="#net" aria-hidden="true"><span class="octicon octicon-link"></span></a>net</h5>
|
||||
|
||||
<p>Net code for hosting the server and communicating with clients</p>
|
||||
|
||||
<h5>
|
||||
<a id="ui" class="anchor" href="#ui" aria-hidden="true"><span class="octicon octicon-link"></span></a>ui</h5>
|
||||
|
||||
<p>Wrapper for user interface for the terminal, this only really needs three stages</p>
|
||||
<h4>
|
||||
<a id="requirements" class="anchor" href="#requirements" aria-hidden="true"><span class="octicon octicon-link"></span></a>Requirements</h4>
|
||||
|
||||
<ul>
|
||||
<li>Initialise the game with settings and connect the clients</li>
|
||||
<li>Run the game simulation to it's conclusion</li>
|
||||
<li>Display the game result</li>
|
||||
<li>ASCII Colour wrapper for separate teams </li>
|
||||
<li>cmake - our build system uses cmake</li>
|
||||
<li>Linux/OSX - currently no support for Windows, tracked with <a href="https://github.com/mdiluz/ttrts/issues/9">Issue #9</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h5>
|
||||
<a id="maths" class="anchor" href="#maths" aria-hidden="true"><span class="octicon octicon-link"></span></a>maths</h5>
|
||||
<h4>
|
||||
<a id="to-build" class="anchor" href="#to-build" aria-hidden="true"><span class="octicon octicon-link"></span></a>To Build</h4>
|
||||
|
||||
<p>simple maths library for 2D calculations and types</p>
|
||||
<pre><code>$ git clone https://github.com/mdiluz/ttrts.git
|
||||
$ cd ttrts
|
||||
$ ./bootstrap.sh
|
||||
$ ./ttrts # To launch binary and display usage
|
||||
</code></pre>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2>
|
||||
<a id="further-information" class="anchor" href="#further-information" aria-hidden="true"><span class="octicon octicon-link"></span></a>Further Information</h2>
|
||||
|
||||
<p>See <a href="source/ttrts/README.md">the ttrts binary readme</a> for full usage and game rules</p>
|
||||
|
||||
<p>See <a href="https://github.com/mdiluz/ttrts-players">my ttrts-players repository</a> for examples of players</p>
|
||||
</section>
|
||||
|
||||
<footer>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{"name":"TTRTS","tagline":"The Tiny Terminal RTS where the players write their AIs","body":"## Introduction\r\nWe aim to create a simple terminal based rts where a user can program an AI to control their army\r\n\r\n------------------------------------------------------------------------------------\r\n## Gameplay\r\n1. ttrts clients are run from the command line\r\n2. ttrts-server is launched from the command line \r\n3. clients will connect to server and confirm initial board state\r\n 1. clients output a text file with game data for this turn\r\n 2. a player, or program, reads the game data file and outputs an instructions file\r\n 3. clients read the instructions file, simulates the turn \r\n 4. game state is verified between clients and server\r\n 5. repeat until an end state is reached\r\n4. once game is finished, host and clients disconnect and a winner is notified\r\n\r\n*see [game](game) for full game rules*\r\n\r\n------------------------------------------------------------------------------------\r\n## Source\r\n\r\n\r\n### Targets\r\n##### ttrts\r\nMain TTRTS executable , runs from the command line and acts as client\r\n\r\n##### ttrts-server\r\nTTRTS server executable, runs from the command line acting as server\r\n\r\n##### player\r\nCustom player AI code, this should contain examples and test code to help newcomers begin their journey\r\n\r\n##### ttrts-test\r\nTest executable, to be compiled and run to test various functionality\r\n\r\n### Libraries\r\n##### game\r\nImplementation of the RTS rules and simulation. [game](game) has full information on it's implementation.\r\n\r\n##### net\r\nNet code for hosting the server and communicating with clients\r\n\r\n##### ui\r\nWrapper for user interface for the terminal, this only really needs three stages\r\n* Initialise the game with settings and connect the clients\r\n* Run the game simulation to it's conclusion\r\n* Display the game result\r\n* ASCII Colour wrapper for separate teams \r\n\r\n##### maths\r\nsimple maths library for 2D calculations and types","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
|
||||
{"name":"TTRTS","tagline":"The Tiny Terminal RTS where the players write their AIs","body":"# TTRTS v0.1.0\r\n\r\n*The Tiny Terminal RTS where the players write their AIs*\r\n\r\n-----------------------------------------------------------\r\n## Introduction\r\nA simple terminal based RTS game that uses text files to communicate game state and unit commands. \r\n\r\nTTRTS 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.\r\n\r\n-----------------------------------------------------------\r\n## Building TTRTS\r\n\r\n#### Requirements\r\n* cmake - our build system uses cmake\r\n* Linux/OSX - currently no support for Windows, tracked with [Issue #9](https://github.com/mdiluz/ttrts/issues/9)\r\n\r\n#### To Build\r\n $ git clone https://github.com/mdiluz/ttrts.git\r\n $ cd ttrts\r\n $ ./bootstrap.sh\r\n $ ./ttrts # To launch binary and display usage\r\n \r\n-----------------------------------------------------------\r\n## Further Information\r\n\r\nSee [the ttrts binary readme](source/ttrts/README.md) for full usage and game rules\r\n\r\nSee [my ttrts-players repository](https://github.com/mdiluz/ttrts-players) for examples of players","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
|
||||
Loading…
Add table
Reference in a new issue