summaryrefslogtreecommitdiff
path: root/docs/module/guide.md
diff options
context:
space:
mode:
authorTor Andersson <tor@ccxvii.net>2025-04-24 12:48:51 +0200
committerTor Andersson <tor@ccxvii.net>2025-04-25 16:06:05 +0200
commited2361980b455d1825d811670f329cbcf5624927 (patch)
treea1e620490bf305635c3a0f22a6f695e22c14ff2f /docs/module/guide.md
parent71a98cbbe0657880cfb1d81962786188b009fc5c (diff)
downloadserver-ed2361980b455d1825d811670f329cbcf5624927.tar.gz
Move docs to Markdown and use markdown renderer in server.
Diffstat (limited to 'docs/module/guide.md')
-rw-r--r--docs/module/guide.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/module/guide.md b/docs/module/guide.md
new file mode 100644
index 0000000..ada195f
--- /dev/null
+++ b/docs/module/guide.md
@@ -0,0 +1,45 @@
+# Module Implementation Guide
+
+## 0. Secure the rights.
+
+All games on RTT are published with the right holders written express permission.
+It's better to secure the rights before spending a lot of time on an implementation,
+in case the publisher says no.
+If you have a game in mind that you want to host on RTT, approach Tor to talk
+about whether a license may be available.
+
+## 1. Create a git project.
+
+TODO
+
+## 2. Setup the required files.
+
+TODO
+
+## 3. Import and prepare the art assets.
+
+Ask Tor to do this for you!
+
+## 4. Board representation.
+
+Design the data representation for the game board state.
+
+Implement enough of the rules to create and setup the initial board game state.
+
+Implement enough of the client to display the initial board game state.
+
+The client doesn't need to be fancy, all we need at this point is to be able to
+present the spaces and pieces at their approximate locations to be able to interact with them.
+Fine tuning the look & feel comes much later.
+
+## 5. Implement the sequence of play and core rules.
+
+Data representation accessors and helper functions.
+
+Main sequence of play.
+
+## 6. Implement events and special cases.
+
+All the hard work.
+
+## 7. Profit!