diff options
| author | Tor Andersson <tor@ccxvii.net> | 2024-07-23 13:48:07 +0200 |
|---|---|---|
| committer | Tor Andersson <tor@ccxvii.net> | 2024-07-23 13:48:10 +0200 |
| commit | c52ca4b709a8752d870a9123b46cfd3764c608a7 (patch) | |
| tree | e18ffd7959a22711929a4f385c0d702b66a58d5f /public/docs/index.html | |
| parent | 611b9aa100d1135f04cde572115a5ea1f680ad72 (diff) | |
| download | server-c52ca4b709a8752d870a9123b46cfd3764c608a7.tar.gz | |
Start adding developer documentation.
Diffstat (limited to 'public/docs/index.html')
| -rw-r--r-- | public/docs/index.html | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/public/docs/index.html b/public/docs/index.html new file mode 100644 index 0000000..87dd954 --- /dev/null +++ b/public/docs/index.html @@ -0,0 +1,52 @@ +<!doctype html> +<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 & 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> +--> |