From c52ca4b709a8752d870a9123b46cfd3764c608a7 Mon Sep 17 00:00:00 2001 From: Tor Andersson Date: Tue, 23 Jul 2024 13:48:07 +0200 Subject: Start adding developer documentation. --- public/docs/install.html | 82 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 public/docs/install.html (limited to 'public/docs/install.html') diff --git a/public/docs/install.html b/public/docs/install.html new file mode 100644 index 0000000..a448db8 --- /dev/null +++ b/public/docs/install.html @@ -0,0 +1,82 @@ + +RTT: Getting Started + + +
+ +

+Getting Started +

+ +

+The Rally the Troops 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. + +

+To run an RTT server instance, you will need +the sqlite3 command line tool +and +Node. + +

+Install the server +

+ +

+Check out the server repository. + +

+git clone https://git.rally-the-troops.com/common/server
+
+ +

+In the cloned server directory, install the NPM dependencies: + +

+npm install
+
+ +

+Initialize the database: + +

+sqlite3 db < schema.sql
+
+ +

+Install the modules +

+ +

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

+Check out a game module: + +

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

+Register it in the database: + +

+sqlite3 db < public/field-cloth-gold/title.sql
+
+ +

+Start the server +

+ +
+node server.js
+
+ +

+Open the browser to http://localhost:8080/ and create an account. + +

+The first account created will have administrator privileges. + -- cgit v1.2.3