aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBjornMartens <113104306+BjornMartens@users.noreply.github.com>2023-03-16 09:58:34 +0100
committerGitHub <noreply@github.com>2023-03-16 09:58:34 +0100
commit51ee4672d5f2f734eb40f4312a2aefd2f8c6dc03 (patch)
tree0dcc9164305332e51239be234ce1e3ea7520cfb5 /docs
parent1c0cb0d1cf8c9cb6a11aa404d8c31def1087a586 (diff)
Added top level stm
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/architecture.md b/docs/architecture.md
index cf4440f..3b4a877 100644
--- a/docs/architecture.md
+++ b/docs/architecture.md
@@ -31,6 +31,17 @@ To ensure a smooth and enjoyable gaming experience, it is essential to address a
## STM32
### game engine
+The game engine is designed to run a 2D platformer game. The game engine has to manage all the different game states. To do this it will utilize a finite state machine (FSM). The game engine will also cover de input handling from the player, the game logic for example enemy handling or the powerup handling it will also send out data to the APU (Audio processing unit) so that the right sounds will be played.
+
+FSM is a useful tool for managing game states and transitions. The game has many different states such as: title screen, shop and gameplay state. Each state represents a particular configuration from the with different logic and variables.
+
+The state machine is designed to have the following states:
+1. Initialization: The initialization state will be responsible for initializing all game-related variables and subsystems, including the FPGA-based picture processing unit.
+2. Title Screen: The title screen state will display the game's title screen and wait for user input to start the game or access the options menu.
+3. Options: The options state will allow the user to configure game settings, such as sound and graphics options.
+4. Game Play: The game play state will be responsible for running the game logic and updating the game state.
+5. Game Over: The game over state will display the game over screen and wait for user input to restart the game or return to the title screen.
+
### user input
### PPU communication
### APU communication