Browse Source

doc: Adding documentation for game example

Matthias Ladkau 3 years ago
parent
commit
a6d5bf7d8d

+ 0 - 14
examples/game/doc/frontend.md

@@ -1,14 +0,0 @@
-frontend.ts
-    Provides the entry start() function. Here we mainly create objects and
-    put them together. After registering the game world, creating a websocket
-    for backend communication and registering the actual player the game is
-    started once the first update is received through the websocket.
-
-game/
-    game-controller.ts - MainGameController - Contains only a communication handler to handle
-    messages from the actual game controller in the backend.
-    
-display/
-    engine.ts - MainDisplayController - Object containing the draw loop which visualises
-    the current state of the game model.
-

BIN
examples/game/doc/game-capture0.mp4


BIN
examples/game/doc/game-capture1.mp4


File diff suppressed because it is too large
+ 55 - 1
examples/game/doc/game.md


BIN
examples/game/doc/screenshot0.png


BIN
examples/game/doc/screenshot1.png


BIN
examples/game/doc/screenshot2.png


+ 0 - 17
examples/game/res/.vscode/launch.json

@@ -1,17 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "ecaldebug",
-            "request": "launch",
-            "name": "Debug ECAL script with ECAL Debug Server",
-            "host": "localhost",
-            "port": 33274,
-            "dir": "${workspaceFolder}",
-            "executeOnEntry": true
-        }
-    ]
-}

+ 7 - 2
examples/game/res/frontend/assets/asset_license.txt

@@ -4,8 +4,13 @@ See: https://opengameart.org/art-search-advanced?keys=space&title=&field_art_tag
 
 Credits:
 
-Background image: Cuzco
 Asteroid images: BlackMoon Design
+Background image: Cuzco
+Background sound: Aquinn
+Explosion sounds: Kenney (Kenney.nl)
+Ship explosion sound: Bart
+Shot sounds: Kenney (Kenney.nl)
 Shot images: Bonsaiheldin
 Ship images: Kenny (Kenney.nl)
-Background sound: aquinn
+Vanish sound: Krial
+