about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
index 525915d..558db4f 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,54 @@ If you want to clone from git.emile.space, you can currently do so like this:
 git clone git://git.emile.space/r2wars-web.git
 git clone git://git.emile.space/hefe.git
 ```
+
+## Usage
+
+```
+; CGO_ENABLED=0 SESSION_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa go run ./src --help
+Usage of /var/folders/bt/2db5y4ds5yq2y9m29tt8g5dm0000gn/T/go-build1055665732/b001/exe/src:
+  -databasepath string
+    	The path to the main database (default "./main.db")
+  -h string
+    	The host to listen on (shorthand) (default "127.0.0.1")
+  -host string
+    	The host to listen on (default "127.0.0.1")
+  -logfilepath string
+    	The path to the log file (default "./server.log")
+  -p int
+    	The port to listen on (shorthand) (default 8080)
+  -port int
+    	The port to listen on (default 8080)
+  -sessiondbpath string
+    	The path to the session database (default "./sesions.db")
+  -templates string
+    	The path to the templates used (default "./templates")
+```
+
+## Architecture
+
+There are essentially the following objects which are all linked to each other (using a table joining their ids):
+
+- User
+  - You, the player
+- Bots
+  - The bots to be run within a battle
+- Battles
+  - An arena in which bots can be placed and run. Constraints on what bots can be added are defined here
+- Architectures
+  - The archs supported by r2 in order to be used by bots and battles
+- Bits
+  - The bits (8, 16, 32, 64) supported by r2 in order to be used by bots and battles
+
+## TODO
+
+- [ ] Add user creating battle as default owner
+- [ ] Allow adding other users as owners to battles
+- [x] Implement submitting bots
+- [x] Implement running the battle
+- [x] Add a "start battle now" button
+- [ ] Add a "battle starts at this time" field into the battle
+- [ ] Figure out how time is stored and restored with the db
+- [x] Do some magic to display the current fight backlog with all info
+- [ ] After having added a bot to a battle with the right arch, the arch can be changed
+      When updating the bot, make sure that it is still valid in all currently linked battles