public/docs/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

<!doctype html>
<meta name="viewport" content="width=device-width">
<title>Documentation</title>
<link rel="stylesheet" href="style.css">
<body>
<article>

<h1>
Documentation
</h1>

<p>
This is the documentation for the <i>Rally the Troops</i> software and website.
Here you will find information both about how to configure and run your own
server instance and how to create new modules.

<h2>For players</h2>

<ul>
<li><a href="tips.html">Tips &amp; tricks.</a>
</ul>

<h2>For developers</h2>

<p>
Before you start to develop a module, you will need to run a local instance of the server.

<ul>
<li><a href="install.html">Installing the server.</a>
<li><a href="production.html">Running a public server.</a>
</ul>

<h2>System overview</h2>

<ul>
<li><a href="architecture.html">Server architecture</a>
<li><a href="database.html">Database schema</a>
<li><a href="module.html">Module architecture</a>
</ul>

<!--
<h2>Module implementation guides</h2>

<ul>
<li><a href="tutorial.html">How to create a module.</a>
<li><a href="rules.html">How to write good rules</a>
<li><a href="client.html">How to write a good client</a>
<li><a href="utils.html">The javascript utility library</a>
<li><a href="events.html">Implementing events using a mini-language</a>
<li><a href="graphics.html">Preparing map, card, and component graphics</a>
<li><a href="fuzzer.html">Using the fuzzer to stress test your rules</a>
</ul>
-->