mosskoi/Boktai-UV-sensor
1
0
Fork 0
Code Wiki Activity

Update Serial Version

mosskoi
2025-10-19 23:22:58 +01:00
parent 82670421fc
commit 7440df3ea6
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
Serial-Version.md

@@ -7,20 +7,20 @@
# Parts
This project is divided in 4 parts.
Patching your Boktai ROM: As mGBA has already an in-emualtor uv sensor, we'll need the patch to disable that and by-pass a "sensor broken" screen.
Microcontroller code: Where calibration must be made.
Patching your Boktai ROM: As mGBA has already an in-emualtor UV sensor, we'll need the patch to disable that and by-pass a "sensor broken" screen.
Microcontroller code: To capture UV light and send information over to the server.
Python Client: The user will have to run a python3 client, for windows users there is a .exe available.
Lua Server: mGBA's script
Lua Server: mGBA's script that runs a server and converts UV signal to in-game sun level.
## You'll need
- [X] 1 microcontroller of your choice
- [X] 3 jumper wire
- [X] 1 UV light sensor
- [X] 1 USB cable between the computer and the microcontroller
- [X] 1 microcontroller of your choice.
- [X] Jumper wires.
- [X] 1 UV light sensor.
- [X] 1 USB cable between the computer and the microcontroller to flash the software.
- [X] Arduino IDE.
- [X] mGBA
- [X] mGBA.
- [X] python3 if you're on linux, if you're on windows I provide a .exe for you.
- [X] ROM dump of Boktai
- [X] ROM dump of Boktai.
Don't know which microcontroller to get? I'd recommend either an arduino nano or an esp32.
@@ -36,12 +36,12 @@ The total price for all these together shouldn't go over 5$.
# Step 2: Microcontroller
1. With all of them in hand, download the microcontroller source code for this version.
2. You can find information on your GPIOs by looking up "<Microcontroller name> pinout" (if you have a Arduino Nano, you would look up "Arduino nano
3. Once you have connected the UV sensor to the microcontroller, connect it to your PC via a USB cable.
1. Have the microcontroller, jumper wires and UV sensor at hand.
2. Connect them with jumper wires, GND to GND, VCC to power supply, and SIG to your GPIO with analog read of choice.
3. Connect it to your PC via a USB cable.
4. Open Arduino IDE.
5. Open the Source code.
6. Under "Tools" make sure your Board and Serial port are correct, if you your board is not there you'll need to download them on "Board Manager"
6. Under "Tools" make sure your Board and Serial port are correct, if you your board is not there you'll need to download them on "Board Manager".
7. Check for your pinout and change the value of UV_SIGNAL_READ to that GPIO number.
8. Flash the code to the microcontroller.
@@ -49,23 +49,23 @@ The total price for all these together shouldn't go over 5$.
1. Open mGBA
2. Start emulating the patched rom.
3. Under "tools" go to "scripting..."
4. File and load script
5. Select the lua script
3. Under "tools" go to "scripting...".
4. File and load script.
5. Select the lua script.
# Step 4: Python client
This one might differ a bit if you're on linux or windows
Windows:
1. Download the .exe
2. double click it
3. Select the COM port the microcontroller is connected to
1. Download the .exe.
2. double click it.
3. Select the COM port the microcontroller is connected to.
Linux:
1. Install requirements on requirements.txt
2. run `python3 main.py`
3. select the TTY port the microcontroller is connected to
1. Install requirements on requirements.txt.
2. run `python3 main.py`.
3. select the TTY port the microcontroller is connected to.
# Step 5: Enjoy the game
:)