aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorUnavailableDev <69792062+UnavailableDev@users.noreply.github.com>2023-02-15 20:10:13 +0100
committerGitHub <noreply@github.com>2023-02-15 20:10:13 +0100
commit09ac5d8997c0f8cefeb1f4fc695b65785c04e79d (patch)
tree04b4b32d2649657b673f85cfeba628c321db0c63 /docs
parent138cf645be7433022beead33025f8714e35c054f (diff)
parent34a685b5e1db516f09951a3e8f281103db4a8ab3 (diff)
Merge pull request #9 from Flenk008/patch-3
Update architecture.md
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/architecture.md b/docs/architecture.md
index ea07cdc..055d228 100644
--- a/docs/architecture.md
+++ b/docs/architecture.md
@@ -10,6 +10,35 @@ Important notes:
# Game controllers
+## Input
+The playable character has 4 actions that it can perform:
+- movement on the x-axis (left / right)
+- jump
+- ability / use
+To perform these action there will be 4 buttons for the user to use.
+
+A joystick is not needed for the movement because the movement is not complex, so button fulfill this.
+The layout will be as follows:
+
+![image](https://user-images.githubusercontent.com/17066065/219126294-b3fe11eb-e216-433a-9317-38f3e2ca4743.png)
+
+## Input handling:
+The hardware consist out of a microcontroller and a FPGA.
+The microcontroller will process the game logic.
+For this reason the input will be handled by the microcontroller as this will improve playability (stated in research).
+
+The controller will have four buttons, so 4 data pins are needed on the microcontroller plus a ground and 3.3V or 5V pin.
+In total there are 6 pins needed.
+If the game is going to be played by 2 person, there are 4 more data pins needed so 8 data pins for both controllers.
+For data transfer between STM32 and FPHA there are 4 pins needed at maximum (SPI for instance).
+The STM32 will be used and most STM32 boards have enough I/O pins for our needs.
+The STM32 F030 and F091 provided by AVANS both have 15 digital pins and 6 analog pins.
+The buttons will be connected as follows:
+
+![image](https://user-images.githubusercontent.com/17066065/219113354-cbda7776-bc95-4d1f-8eb9-364f7d4f1b8d.png)
+
+To implement the input in the game, the input should be ckecked at the start of each game cycle. In this case there are no interupts needed.
+
# STM32 software
# PPU