diff options
author | Tor Andersson <tor@ccxvii.net> | 2025-04-24 12:48:51 +0200 |
---|---|---|
committer | Tor Andersson <tor@ccxvii.net> | 2025-04-25 16:06:05 +0200 |
commit | ed2361980b455d1825d811670f329cbcf5624927 (patch) | |
tree | a1e620490bf305635c3a0f22a6f695e22c14ff2f /public/docs/install.html | |
parent | 71a98cbbe0657880cfb1d81962786188b009fc5c (diff) | |
download | server-ed2361980b455d1825d811670f329cbcf5624927.tar.gz |
Move docs to Markdown and use markdown renderer in server.
Diffstat (limited to 'public/docs/install.html')
-rw-r--r-- | public/docs/install.html | 84 |
1 files changed, 0 insertions, 84 deletions
diff --git a/public/docs/install.html b/public/docs/install.html deleted file mode 100644 index 1b1bc2b..0000000 --- a/public/docs/install.html +++ /dev/null @@ -1,84 +0,0 @@ -<!doctype html> -<meta name="viewport" content="width=device-width"> -<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: - -<xmp> -sqlite3 db < schema.sql -</xmp> - -<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: - -<xmp> -sqlite3 db < public/field-cloth-gold/title.sql -</xmp> - -<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. - |