public/docs/install.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<!doctype html>
<title>RTT: Getting Started</title>
<link rel="stylesheet" href="style.css">
<body>
<article>

<h1>
Getting Started
</h1>

<p>
The <i>Rally the Troops</i> software is very simple and has minimal dependencies.
All the data is stored in a single SQLite3 database.
The server runs in a single Node process using the Express.js framework.

<p>
To run an RTT server instance, you will need
the <a href="https://www.sqlite.org/index.html">sqlite3</a> command line tool
and
<a href="https://nodejs.org/en">Node</a>.

<h2>
Install the server
</h2>

<p>
Check out the server repository.

<pre>
git clone https://git.rally-the-troops.com/common/server
</pre>

<p>
In the cloned server directory, install the NPM dependencies:

<pre>
npm install
</pre>

<p>
Initialize the database:

<pre>
sqlite3 db &lt; schema.sql
</pre>

<h2>
Install the modules
</h2>

<p>
Game modules are found in the "public" directory.
They also need to be registered in the database.

<p>
Check out a game module:

<pre>
git clone https://git.rally-the-troops.com/modules/field-cloth-gold public/field-cloth-gold
</pre>

<p>
Register it in the database:

<pre>
sqlite3 db &lt; public/field-cloth-gold/title.sql
</pre>

<h2>
Start the server
</h2>

<pre>
node server.js
</pre>

<p>
Open the browser to <a href="http://localhost:8080/">http://localhost:8080/</a> and create an account.

<p>
The first account created will have administrator privileges.