ttrts/index.html
2015-01-10 17:43:37 +00:00

229 lines
7.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=640">
<link rel="stylesheet" href="stylesheets/core.css" media="screen">
<link rel="stylesheet" href="stylesheets/mobile.css" media="handheld, only screen and (max-device-width:640px)">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<script type="text/javascript" src="javascripts/modernizr.js"></script>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script type="text/javascript" src="javascripts/headsmart.min.js"></script>
<script type="text/javascript">
$(document).ready(function () {
$('#main_content').headsmart()
})
</script>
<title>TTRTS by mdiluz</title>
</head>
<body>
<a id="forkme_banner" href="https://github.com/mdiluz/ttrts">View on GitHub</a>
<div class="shell">
<header>
<span class="ribbon-outer">
<span class="ribbon-inner">
<h1>TTRTS</h1>
<h2>The Tiny Terminal RTS where the players write their AIs</h2>
</span>
<span class="left-tail"></span>
<span class="right-tail"></span>
</span>
</header>
<section id="downloads">
<span class="inner">
<a href="https://github.com/mdiluz/ttrts/zipball/master" class="zip"><em>download</em> .ZIP</a><a href="https://github.com/mdiluz/ttrts/tarball/master" class="tgz"><em>download</em> .TGZ</a>
</span>
</section>
<span class="banner-fix"></span>
<section id="main_content">
<h1>
<a id="ttrts" class="anchor" href="#ttrts" aria-hidden="true"><span class="octicon octicon-link"></span></a>TTRTS</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>A simple terminal based RTS game that uses text files to communicate game state and unit commands. </p>
<p>TTRTS 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 enjoy designing and playing against their friends.</p>
<hr>
<h2>
<a id="building-ttrts" class="anchor" href="#building-ttrts" aria-hidden="true"><span class="octicon octicon-link"></span></a>Building TTRTS</h2>
<h4>
<a id="requirements" class="anchor" href="#requirements" aria-hidden="true"><span class="octicon octicon-link"></span></a>Requirements</h4>
<ul>
<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>
<li>perl 5.0 or newer - for the launch script</li>
</ul>
<h4>
<a id="to-build" class="anchor" href="#to-build" aria-hidden="true"><span class="octicon octicon-link"></span></a>To Build</h4>
<pre><code>$ git clone https://github.com/mdiluz/ttrts.git
$ cd ttrts
$ ./bootstrap.sh
$ man ttrts # for full usage and guide
</code></pre>
<hr>
<h2>
<a id="development" class="anchor" href="#development" aria-hidden="true"><span class="octicon octicon-link"></span></a>Development</h2>
<ul>
<li>master branch always stores latest stable release</li>
<li>master/{hotfix} branches store in progress hotfixes for the stable branch</li>
<li>dev branch stores in progress development</li>
<li>dev/{feature} branches store features</li>
</ul>
<hr>
<h2>
<a id="changelog" class="anchor" href="#changelog" aria-hidden="true"><span class="octicon octicon-link"></span></a>Changelog</h2>
<h4>
<a id="v040" class="anchor" href="#v040" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.4.0</h4>
<ul>
<li>Updated with network functionality
<ul>
<li>Game can now be hosted with ttrts --server option</li>
<li>Server can be connected to with ttrts --client</li>
</ul>
</li>
<li>Updated command line interface with new launcher script
<ul>
<li>map file must now be specified with --map=FILE </li>
</ul>
</li>
<li>Slight refactor of libraries to account for new run targets</li>
</ul>
<h4>
<a id="v032" class="anchor" href="#v032" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.3.2</h4>
<ul>
<li>Fix bug when loading map files with walls</li>
<li>Fix ttrts on OSX
<ul>
<li>Install man files to correct location</li>
<li>Update usage of sed to be compatible with BSD as well as GNU versions</li>
</ul>
</li>
<li>New maps and renames of old ones</li>
</ul>
<h4>
<a id="v031" class="anchor" href="#v031" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.3.1</h4>
<ul>
<li>Upgraded install target to repository
<ul>
<li>libttrts static library binary in /usr/local/lib</li>
<li>ttrts headers in /usr/local/include/ttrts</li>
<li>bash completion into /etc/bash_completion.d/</li>
<li>man page into /usr/local/man/man6</li>
<li>maps into /usr/share/ttrts/maps</li>
</ul>
</li>
<li>client now supports env variable configuration
<ul>
<li>TTRTS_MAPS for location of map files, defaults to /usr/share/ttrts/maps</li>
<li>TTRTS_GAMES for gameplay directories, defaults to /tmp/</li>
</ul>
</li>
<li>Map files now have proper header</li>
<li>NOTE: This version is compatible with v0.3.0, but old generated mapfiles will need the additional header line added</li>
</ul>
<h4>
<a id="v030" class="anchor" href="#v030" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.3.0</h4>
<ul>
<li>Additional functionality of walls
<ul>
<li>Walls are noted in gamestate file on new "WALL:[X,Y]..." line</li>
<li>Walls are impassable by all movement</li>
</ul>
</li>
<li>Units leave an impassable wall behind after movement</li>
<li>Game can now end if no units are able to move</li>
<li>Various C++ api simplifications</li>
<li>Integration of perl api from <a href="https://github.com/mdiluz/ttrts-players">ttrts-players</a>
</li>
</ul>
<h4>
<a id="v020" class="anchor" href="#v020" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.2.0</h4>
<ul>
<li>All team references changed to player
<ul>
<li>Order file format changed to Player_#<em>Turn</em>#.txt</li>
<li>Unit descriptors now use pl: instead of tm:</li>
</ul>
</li>
<li>Various other C++ api corrections and refactors</li>
</ul>
<h4>
<a id="v010" class="anchor" href="#v010" aria-hidden="true"><span class="octicon octicon-link"></span></a>v0.1.0</h4>
<ul>
<li>First playable version of ttrts</li>
</ul>
<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 the ttrts <a href="source/README.md">README</a> for full usage and game rules</p>
<p>See <a href="https://github.com/mdiluz/ttrts-players">ttrts-players</a> for examples of AIs</p>
</section>
<footer>
<span class="ribbon-outer">
<span class="ribbon-inner">
<p>this project by <a href="https://github.com/mdiluz">mdiluz</a> can be found on <a href="https://github.com/mdiluz/ttrts">GitHub</a></p>
</span>
<span class="left-tail"></span>
<span class="right-tail"></span>
</span>
<p>Generated with <a href="http://pages.github.com">GitHub Pages</a> using Merlot</p>
<span class="octocat"></span>
</footer>
</div>
</body>
</html>