1
0

Add Serial Version

2025-10-16 01:39:47 +01:00
parent 469947678d
commit 56d8f9005a

70
Serial-Version.md Normal file

@@ -0,0 +1,70 @@
# Introduction
- [X] This version of the project doesn't need WiFi
- [X] The user is content with using a cable between their computer and the microcontroller.
- [X] Sunlight must be within reach of the microcontroller.
# 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.
Python Client: The user will have to run a python3 client, for windows users there is a .exe available.
Lua Server: mGBA's script
## You'll need
- [X] 1 microcontroller of your choice
- [X] 3 jumper wire
- [X] 1 UV light sensor
- [X] Arduino IDE.
- [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
Don't know which microcontroller to get? I'd recommend either an arduino nano or an esp32.
The jumper wires will be male-to-male, male-to-female or female-to-female depending on your needs, make sure you get ones that will suit you.
Don't know which UV light sensor to get? I used a GUVA-S12SD, it works fine.
The total price for all these together shouldn't go over 5$.
# Step 1: Patch the ROM
1. Download boktai's patch here: https://github.com/Prof9/Boktai-Solar-Sensor-Patches
2. Apply patch, you can do that here: https://www.romhacking.net/patch/
# 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.
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"
7. Check for your pinout and change the value of UV_SIGNAL_READ to that GPIO number.
8. Flash the code to the microcontroller.
# Step 3: Lua server
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
# 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
Linux:
1. Start
Open