Glossary
General:
| Word | Explanation | etc |
|---|---|---|
| Boxes | Boxes can be found in each Level and are necessary to reach Level Goals | - |
| Collectible | Items than can be collected by the Player like Spaceshipparts, Health, Gadgets | - |
| Gravity | Forces Players and items to Bottom or Top | - |
| Gravityshift | Gravity can be shifted by Player, both need to press "G" to Vote for Gravityshift | - |
| MayorDom | PlayerCharacter 1 MayorDom - Spaceranger | - |
| Monster | Enemies of the Player, need to be killed | - |
| Moot | PlayerCharacter 2 Moot - Little Slimy Guy | - |
| NPC | Non Player Character | - |
| phaser | game engine, framework for JS | - |
| Riddles | Combination of Activation of triggerplates to open trapdoors to get Spareparts or clear the way | - |
| Spareparts | Parts of the Spaceship needed | - |
| Spaceship(name) | Spaceship of Players, Goal of Game is to find Spareparts and fix it | - |
| Trapdoor | Doors trapping Spareparts inside | - |
| Triggerplates | Can be triggered by boxes or player | - |
| Storyteller Alien | Npc which narrates players through the game and tells the story | - |
| Scene | Entry point for the game | - |
Project Folder:
Server:
Folders
| Word | Explanation | etc |
|---|---|---|
| Map-templates | templates for different areas | - |
| maps | json data maps of all levels | - |
| src | server source code | - |
| src/managers | manager for level/state/maps | - |
src/managers
| Word | Explanation | etc |
|---|---|---|
| LevelManager | responsible for loading/managing levels | - |
| MapManager | loading tile maps from src/maps | - |
| StateManager | responsible for different game states | - |
Client:
Folders:
| Word | Explanation | etc |
|---|---|---|
| public | assets of the game | - |
| public/audio | audiofiles of the game | - |
| public/biome | assets of the level | - |
| public/character | character design | - |
| public/menu | menu elements | - |
| public/overlay | UI Elements | - |
| src | client source code | - |
| src/types | code for ui display data | - |
| src/assets | loading screen gif | - |
| src/components | code for ui-elements | - |
| src/level/ | code for game/level | - |
| src/level/types | collection of types | - |
| src/level/components | code for game interactions | - |
| src/level/entities | code for game objects | - |
| src/level/managers | managers for different tasks | - |
| src/level/overlays | code for overlays | - |
| src/level/scenes | code for game scenes | - |
| src/level/util | code for various calculations | - |
| Word | Explanation | etc |
|---|---|---|
| levelbridge | bridges gap between phaser level and vue | - |
| manager | manager for game states/server connection | - |
| stores | code for saving states | - |
| views | code for menues | - |
| views/in-game | code for ingame menues | - |
| views/start-menu | code for start menues | - |
| test | mocks | - |
Managers
| Word | Expanation | etc |
|---|---|---|
| CameraManager | Responsible for Camera Movement | - |
| EntityManaer | Responsible for creating, managing Entities | - |
| GameManager | Responsible for Gamestate, scenes, server connection | - |
| KeyboardManagger | Responsible for Keyboard Input | - |
| TilemapManager | Responsible for Loading TileMaps | - |
Managers
| Word | Expanation | etc |
|---|---|---|
| CameraManager | Responsible for Camera Movement | - |
| EntityManaer | Responsible for creating, managing Entities | - |
| GameManager | Responsible for Gamestate, scenes, server connection | - |
| KeyboardManagger | Responsible for Keyboard Input | - |
| TilemapManager | Responsible for Loading TileMaps | - |
Client Server Communication:(shared)
Code - shared data between client and server.
Folders:
| Word | Expanation | etc |
|---|---|---|
| src | code for server/client communication | - |
| test | mocks for test | - |
src:
| Word | Explanation | etc |
|---|---|---|
| ClientState.ts | holds Session Data | - |
| constants.ts | initial health of players | - |
| EntityState.ts | shared states for entities | - |
| GameOver.Ts | holds gameOver Results | - |
| GameSave.ts | holds savegame data | - |
| GameState.ts | holds data state for game | - |
| RoomOption.ts | data send by client for joining a room | - |
| Sound.ts | enum for sounds | - |
| Tiledmap.ts | interfaces for tiled data | - |
| UpdateCodes.ts | message codes | - |