Merge pull request #28 from fhoedemakers/Development

Themed borders added

Author: fhoedemakers

CHANGELOG.md

@@ -7,6 +7,12 @@
 
 [See setup section in in Pico-infoNesPlus readme how to install and wire up](https://github.com/fhoedemakers/pico-infonesPlus#pico-setup)
 
+# v0.21 Release Notes
+
+- In-game hotkeys are now consistent with the other emulators. 
+- On RP2350 based boards: Themed borders/bezels are shown in-game. For this you need the latest [metadata pack](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/SMSPlusMetadata.zip) from the releases section. Download and unzip it's contents to the root of the SD card.
+- Support for [Retro-bit 8 button Genesis-USB](https://www.retro-bit.com/controllers/genesis/#usb). 
+
 # v0.20 Release Notes
 
 - Added support for [Adafruit Fruit Jam](https://www.adafruit.com/product/6200):  
@@ -137,7 +143,7 @@ For the latest two player PCB 2.0, you need:
 | Board | Binary | Readme |
 |:--|:--|:--|
 | Waveshare RP2040-Zero | [picosmsPlus_WaveShareRP2040ZeroWithPCB_arm.uf2](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/picosmsPlus_WaveShareRP2040ZeroWithPCB_arm.uf2) | [Readme](README.md#pcb-with-waveshare-rp2040rp2350-zero) |
-| Waveshare RP2350-Zero | [picosmsPlus_WaveShareRP2350PiZero_arm_piousb.uf2](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/picosmsPlus_WaveShareRP2350PiZero_arm_piousb.uf2) | [Readme](https://github.com/fhoedemakers/pico-infonesPlus/blob/main/README.md#pcb-with-waveshare-rp2040rp2350-zero) |
+| Waveshare RP2350-Zero | [picosmsPlus_WaveShareRP2350ZeroWithPCB_arm.uf2](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/picosmsplus_WaveShareRP2350ZeroWithPCB_arm.uf2) | [Readme](README.md#pcb-with-waveshare-rp2040rp2350-zero) |
 
 PCB: [Gerber_PicoNES_Mini_PCB_v2.0.zip](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/Gerber_PicoNES_Mini_PCB_v2.0.zip)
 
@@ -171,7 +177,13 @@ PCB: [Gerber_PicoNES_Micro_v1.2.zip](https://github.com/fhoedemakers/pico-smsplu
 - Metadata: [SMSPlusMetadata.zip](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/SMSPlusMetadata.zip)
 
 
-Extract the zip file to the root folder of the SD card. Select a game in the menu and press START to show more information and box art. Works for most official released games. Screensaver shows floating random cover art.
+Extract the zip file to the root folder of the SD card. Select a game in the menu and press START to show more information and box art. Works for most official released games. Screensaver shows floating random cover art. Works for RP2040 and RP2350.
+Extra on RP2350: when a game is loaded a themed bezel/border is shown.
+
+
+
+
+
 
 
 

CMakeLists.txt

@@ -37,6 +37,8 @@ add_executable(${projectname}
     splash.cpp
     DefaultSS444.c
     DefaultSS555.c
+    EmuOverlay444.c
+    EmuOverlay555.c
 )
 
 pico_set_program_name(${projectname} "${projectname}")

EmuOverlay444.c

@@ -1,13 +1,16 @@
 
-# pico-smsplus
+# pico-smsplus, A Sega Master System and Game Gear emulator for RP2040/RP2350 based boards.
 
 This software is a port of [SmsPlus](https://segaretro.org/SMS_Plus), a Sega Master System and Game Gear emulator for RP2040/RP2350 based microcontroller boards like the RaspberryPi Pico and Pico 2. Sound and video are ouput over HDMI.
 The code for HDMI output is based on [Shuichi Takano's Pico-InfoNes project](https://github.com/shuichitakano/pico-infones) which in turn is based on [PicoDVI](https://github.com/Wren6991/PicoDVI).
 
-Put your Master System (.sms) and Game Gear (.gg) rom files on a FAT32 formatted SD card. You can organize the roms in directories. A menu is displayed on which you can select the rom to play.
+Create a FAT32 or exFAT formatted SD card and copy your Master System (.sms) and/or Game Gear (.gg) roms and optional [metadata](#using-metadata) on to it.
+You can organize the roms in directories. A menu is displayed on which you can select the rom to play.
 
 Supports two controllers for two player Master System games. [See "about two player games" below for specifics and limitations](#about-two-player-games) 
 
+See the [releases](https://github.com/fhoedemakers/pico-smsplus/releases/latest) page for the supported RP2040/RP2350 boards.
+
 ***
 
 ## Video
@@ -16,13 +19,12 @@ Click on image below to see a demo video.
 [![Video](https://img.youtube.com/vi/__E8h2Ay3g8/0.jpg)](https://www.youtube.com/watch?v=__E8h2Ay3g8)
 
 ***
-## Not perfect
+## RP2040 notes
 
-**There are still some issues to be fixed. The emulator runs decently well, especially on the Pico 2/RP2350. On the Pico/RP2040, Some games may not run at full speed or at all. (afterburner).**
+**The emulator works very well on the Pico 2/RP2350. On the Pico/RP2040, some games may not run at full speed or at all. (like afterburner).**
 
 >[!WARNING] 
 > On Pico/RP2040, some games show red flashing between screens. This can be occasionally or severe depending on the game. If you are sensitive for this, or experience health issues while playing those games, please stop playing immediately.
-> Runs much better on Pico 2/RP2350.
 
 ***
 
@@ -45,7 +47,7 @@ Click on image below to see a demo video.
 
 The binary specific for your config can be downloaded from the [releases](https://github.com/fhoedemakers/pico-smsplus/releases/latest) page.
 
-You need a FAT32 formatted SD card to put your .sms and .gg roms on.
+You need a FAT32 or exFAT formatted SD card to put your .sms and .gg roms on.
 
 >[!NOTE]
 > For detailed instructions how to setup specific configurations, see the [Pico-InfonesPlus sister project](https://github.com/fhoedemakers/pico-infonesPlus).
@@ -69,11 +71,11 @@ These boards already contain an RP2040 cpu, a separate Raspberry Pi Pico is not
 
 ## Other RP2350 based boards
 
-- [Adafruit Metro RP2350](https://www.adafruit.com/product/6003) or [Adafruit Metro RP2350 with PSRAM](https://www.adafruit.com/product/6267)
 
+- [Adafruit Fruit Jam](https://www.adafruit.com/product/6200)
+- [Adafruit Metro RP2350](https://www.adafruit.com/product/6003) or [Adafruit Metro RP2350 with PSRAM](https://www.adafruit.com/product/6267)
 - [Pimoroni Pico Plus 2](https://shop.pimoroni.com/products/pimoroni-pico-plus-2?variant=42092668289107)
-
-  Use the breadboard config for this. Should also work on the Pimoroni Pico DV Demo base, but currently untested. This board does not fit the PCB because of the SP/CE connector on back of the board.
+  Use the breadboard config or Pimoroni Pico DV Demo base. This board does not fit the PCB because of the SP/CE connector on back of the board.
   The PSRAM on the board is used in stead of flash to load the roms from SD.
 
 ## Waveshare RP2040 & RP2350 Zero
@@ -89,6 +91,7 @@ The following controllers are supported.
 - SONY DUALSHOCK 4
 - SONY DualSense
 - Xinput type controllers (Xbox)
+- [Retro-bit 8 button Genesis-USB](https://www.retro-bit.com/controllers/genesis/#usb). 
 - and more...
 
 Also original NES and WII-classic controllers are supported in some configurations. 
@@ -113,78 +116,79 @@ The emulator supports two player games using two NES controllers or an USB gamec
 
 ***
 
-## Menu Usage
+# Gamepad and keyboard usage
+Below the button mapping for different controllers. You can also use a USB-keyboard.
+|     | (S)NES | Genesis | XInput | Dual Shock/Sense |
+| --- | ------ | ------- | ------ | ---------------- |
+| Button1 | B (*) |    A    |   A    |    X             |
+| Button2 | A  |    B    |   B    |   Circle         |
+| Select  | select | Mode or C | Select | Select     |
+
+(*) On SNES USB-controller press Y once to activate the B-button.
+
+## In menu
 Gamepad buttons:
 - UP/DOWN: Next/previous item in the menu.
 - LEFT/RIGHT: next/previous page.
-- A (Circle): Open folder/flash and start game.
-- B (X): Back to parent folder.
-- START: Starts game currently loaded in flash.
+- Button2 : Open folder/flash and start game.
+- Button1 : Back to parent folder.
+- START: Show metadata and box art (when available). 
 
 The colors in the menu can be changed and saved:
   - Select + Up/Down changes the foreground color.
   - Select + Left/Right changes the background color.
-  - Select + A saves the colors. Screen will flicker when saved.
-  - Select + B resets the colors to default. (Black on white)
-
-
-## Emulator (in game)
-Gamepad buttons:
-- SELECT + START: Resets back to the SD Card menu. Game saves (when available) are saved to the SD card.
-- SELECT + UP/SELECT + DOWN: switches screen modes.
-- SELECT + A/B: toggle rapid-fire.
-- START + A : Toggle framerate display.
-- SELECT + LEFT: Switch audio output to the connected speakers on the line-out jack of the Pimoroni Pico DV Demo Base. The speaker setting will be remembered when the emulator is restarted.
+  - Select + Button2 saves the colors. Screen will flicker when saved.
+  - Select + Button1 resets the colors to default. (Black on white)
 
-When using an USB-Keyboard:
-- Cursor keys: Up, Down, left, right
-- Z: Back to parent folder
-- X: Open Folder/flash and start a game
-- S: Starts game currently loaded in flash.
-- A: acts as the select button.
 
 ## Emulator (in game)
 Gamepad buttons:
 - SELECT + START, Xbox button: Resets back to the SD Card menu. Game saves are saved to the SD card.
 - SELECT + UP/SELECT + DOWN: switches screen modes.
-- SELECT + A/B: toggle rapid-fire.
-- START + A : Toggle framerate display
-- SELECT + LEFT: Switch audio output to the connected speakers on the line-out jack of the Pimoroni Pico DV Demo Base. The speaker setting will be remembered when the emulator is restarted.
-
-When using a Genesis Mini controller, press C for SELECT.
-
-When using an USB-Keyboard
-- Cursor keys: up, down, left, right
-- A: Select
-- S: Start
-- Z: B
-- X: A
-
->[!NOTE]
-> The standard NES style layout is used for all controller types. So when using XInput controllers, B and A are swapped.
+- START + Button2 : Toggle framerate display
+- **Pimoroni Pico DV Demo Base only**: SELECT + LEFT: Switch audio output to the connected speakers on the line-out jack of the Pimoroni Pico DV Demo Base. The speaker setting will be remembered when the emulator is restarted.
+- **Fruit Jam Only** 
+  - pushbutton 1 (on board): Mute audio of built-in speaker. Audio is still outputted to the audio jack.
+  - SELECT + UP: Toggle scanlines. 
+  - pushbutton 2 (on board) or SELECT + RIGHT: Toggles the VU meter on or off. (NeoPixel LEDs light up in sync with the music rhythm)
+- **Genesis Mini Controller**: When using a Genesis Mini 3 button controller, press C for SELECT. On the 8-button Genesis controllers, MODE acts as SELECT.
+- **USB-keyboard**: When using an USB-Keyboard
+  - Cursor keys: up, down, left, right
+  - A: Select
+  - S: Start
+  - Z: Button2
+  - X: Button1
+
+## Using metadata.
+
+<img alt="Screenshot 2025-10-19 14-57-45" src="https://github.com/user-attachments/assets/da91016f-093b-4b96-8d8e-5a0f37cf2506" />
+
+Download the metadata pack from the [releases page](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/SMSPlusMetadata.zip) It contains box art, game info and themed borders/bezels for many games. The metadata is used in the menu to show box art and game info when a rom is selected.  When the screensaver is started, random box art is shown. Extra on RP2350 boards: When in-game, themed borders/bezels are shown around the game screen.
+
+- Download pack [here](https://github.com/fhoedemakers/pico-smsplus/releases/latest/download/SMSPlusMetadata.zip).  
+  - Extract the zip contents to the **root of the SD card**.  
+  - In the menu:  
+    - Highlight a game and press **START** → show cover art and metadata.  
+    - Press **SELECT** → show full game description.  
+    - Press **Button1** → return to menu.  
+    - Press **START** or **Button2** → start the game.
+  - **RP2350-only**: In-game: A themed bezel is shown:
+
+| Master System | Game Gear | 
+| ------------- | --------  |
+| <img width="320" alt="Screenshot 2025-10-19 14-57-33" src="https://github.com/user-attachments/assets/19db1e45-0cda-442f-ac1a-3b54b7ccfa84" /> | <img width="320" alt="Screenshot 2025-10-21 17-04-42" src="https://github.com/user-attachments/assets/8f9bed95-fea8-4ce8-aa1c-edcbeacb1945" /> |
 
 
 ***
 
 ## Building from source
 
-When using Visual Studio code, make sure to build in Release or RelWithDbinfo mode, as the emulator is too slow in the other modes.
-
-Build shell scripts are available:
+Use the bld.sh script to build the project. Build using Ubuntu Linux or WSL on Windows. See the Pico SDK installation instructions on how to set up the build environment.
 
-- build.sh : Builds .uf2 for the Pimoroni DV Deno Base
-- build_alternate.sh: For the PCB or breadboard variant
-- build_feather_dvi.sh: For the Adafruit feather
-- build_ws_rp2040_pizero.sh: For the Wavehare device
+Use ./bld.sh --h for options.
 
-Make sure they are executable by running `chmod +x build*.sh` in the terminal.
-
-The _debug.sh scripts can be use to create a debug build for each system.
+The resulting .uf2 file will be in the releases/ folder. Copy it to the Pico when in bootloader mode.
 
 ***
 
-## Things to do (if possible):
-
-- [ ] Improve performance
-- [ ] Save states