summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTor Andersson <tor@ccxvii.net>2021-05-01 00:48:35 +0200
committerTor Andersson <tor@ccxvii.net>2021-05-01 00:48:35 +0200
commit1fd89b76bc9b1e1b78af5ca74cdc3d5764a3e4ab (patch)
treec1e143a5a05f6f64de66e0f60a003f1d8bbe95f7
downloadserver-1fd89b76bc9b1e1b78af5ca74cdc3d5764a3e4ab.tar.gz
Add README and LICENSE.
-rw-r--r--LICENSE25
-rw-r--r--NOTES.md41
-rw-r--r--README.md9
3 files changed, 75 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..78803fc
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,25 @@
+PLEASE NOTE:
+
+The ISC License applies to the Software implementing the game platform on the
+website rally-the-troops.com.
+
+All specific game titles appearing within the Software are published on
+rally-the-troops.com with permission from their respective designers and/or
+publishers. The ISC License does NOT apply to any rights associated with such
+game titles.
+
+ISC License
+
+Copyright 2021 Tor Andersson
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/NOTES.md b/NOTES.md
new file mode 100644
index 0000000..3851d51
--- /dev/null
+++ b/NOTES.md
@@ -0,0 +1,41 @@
+## Setting up the server
+
+All data is stored in an SQLite3 database.
+
+The server and game rules are implemented in Javascript.
+The game state is stored in the database as a JSON blob.
+The server runs on Node with the Express.js and Socket.io frameworks.
+
+Redirect port 80 and 443 to 8080 and 80443:
+
+```
+sudo iptables -A PREROUTING -t nat -p tcp --dport 80 -j REDIRECT --to-ports 8080
+sudo iptables -A PREROUTING -t nat -p tcp --dport 443 -j REDIRECT --to-ports 8443
+```
+
+Create SSL certificate with Let's Encrypt certbot, or self-signed with OpenSSL:
+
+```
+openssl req -nodes -new -x509 -keyout key.pem -out cert.pem
+```
+
+## Resources
+
+Icons are sourced from various places:
+
+* https://game-icons.net/
+* https://commons.wikimedia.org/wiki/Main_Page
+
+Fonts:
+
+* https://github.com/adobe-fonts/source-sans
+* https://github.com/adobe-fonts/source-serif
+* https://www.google.com/get/noto/
+
+Image processing software:
+
+* https://github.com/google/guetzli/
+* https://github.com/svg/svgo
+* http://optipng.sourceforge.net/
+* http://potrace.sourceforge.net/
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94a1ec6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Rally the Troops!
+
+## About
+
+Rally the Troops! is an open source website for playing historical games.
+All titles are published on rally-the-troops.com with permission from their
+respective designers and/or publishers. If you intend to use any title for your
+own use or on a different website, please contact the applicable designer
+and/or publisher for any necessary permissions.