release 2.11.4

DirtBagXon · Jan 10, 2025 · fc34a26 · fc34a26
1 parent b353e17
commit fc34a26
Show file tree

Hide file tree

Showing 72 changed files with 3,278 additions and 290 deletions.
diff --git a/.github/workflows/cmake-AppImage-platform.yml b/.github/workflows/cmake-AppImage-platform.yml
@@ -28,6 +28,7 @@ jobs:
         sudo apt install libsdl2-dev
         sudo apt install libsdl2-ttf-dev
         sudo apt install libsdl2-image-dev
+        sudo apt install libsdl2-mixer-dev
         sudo apt install libzip-dev
         sudo apt install libvorbis-dev
         sudo apt install zlib1g-dev
@@ -70,6 +71,7 @@ jobs:
         cp Hypseus_Singe-x86_64.AppImage hypseus-singe
         ln -s Hypseus_Singe-x86_64.AppImage hypseus-singe/hypseus.bin
         cp -r ../fonts hypseus-singe
+        cp -r ../midi hypseus-singe
         cp -r ../roms hypseus-singe
         cp -r ../sound hypseus-singe
         cp -r ../pics hypseus-singe

diff --git a/.github/workflows/cmake-linux64-platform.yml b/.github/workflows/cmake-linux64-platform.yml
@@ -30,6 +30,7 @@ jobs:
         sudo apt install libsdl2-dev
         sudo apt install libsdl2-ttf-dev
         sudo apt install libsdl2-image-dev
+        sudo apt install libsdl2-mixer-dev
         sudo apt install libzip-dev
         sudo apt install libvorbis-dev
         sudo apt install zlib1g-dev
@@ -44,7 +45,7 @@ jobs:
         cp build/hypseus .
         cp doc/hypinput.ini doc/hypinput_gamepad.ini .
         cp screenshots/hypseus-logo.png hypseus.png
-        FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ pics/ roms/ sound/ scripts/"
+        FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ midi/ pics/ roms/ sound/ scripts/"
         tar -zcvf hypseus-singe.tgz $FILES
     - name: Create Distribution
       id: vars

diff --git a/.github/workflows/cmake-macOS-brew_mpeg2-platform.yml b/.github/workflows/cmake-macOS-brew_mpeg2-platform.yml
@@ -30,6 +30,7 @@ jobs:
           brew install sdl2
           brew install sdl2_ttf
           brew install sdl2_image
+          brew install sdl2_mixer
           brew install automake
           brew install libvorbis
           brew install libmpeg2
@@ -46,7 +47,7 @@ jobs:
           cp build/hypseus .
           cp doc/hypinput.ini doc/hypinput_gamepad.ini .
           cp screenshots/hypseus-logo.png hypseus.png
-          FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ pics/ roms/ sound/ scripts/"
+          FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ midi/ pics/ roms/ sound/ scripts/"
           zip -r hypseus-singe.zip $FILES
       - name: Create Distribution
         id: vars

diff --git a/.github/workflows/cmake-macOS-platform.yml b/.github/workflows/cmake-macOS-platform.yml
@@ -27,6 +27,7 @@ jobs:
           brew install sdl2
           brew install sdl2_ttf
           brew install sdl2_image
+          brew install sdl2_mixer
           brew install automake
           brew install libvorbis
         if: success()
@@ -41,7 +42,7 @@ jobs:
           cp build/hypseus .
           cp doc/hypinput.ini doc/hypinput_gamepad.ini .
           cp screenshots/hypseus-logo.png hypseus.png
-          FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ pics/ roms/ sound/ scripts/"
+          FILES="hypseus LICENSE README.md hypseus.png hypinput.ini hypinput_gamepad.ini fonts/ midi/ pics/ roms/ sound/ scripts/"
           zip -r hypseus-singe.zip $FILES
       - name: Create Distribution
         id: vars

diff --git a/README.md b/README.md
@@ -47,6 +47,7 @@ Use homebrew to install the following packages:
     brew install sdl2
     brew install sdl2_ttf
     brew install sdl2_image
+    brew install sdl2_mixer
     brew install libtool
     brew install libvorbis
     brew install libogg
@@ -66,7 +67,7 @@ For **Raspberry Pi** clone the ``RetroPie`` branch via:
 
     git clone --single-branch --branch RetroPie https://github.com/DirtBagXon/hypseus-singe.git
 
-Further **RetroPie** and **Raspberry Pi** information can be found [here](src/3rdparty/retropie/RETROPIE.md)
+Further **RetroPie** and **Raspberry Pi** information can be found [here](doc/RETROPIE.md)
 
 ### Compilation with CMake
 
@@ -81,7 +82,7 @@ Build:
 
 Ensure you have data in the following `daphne` HOME folders:
 
-    pics, fonts, ram, roms, sound, singe, (vldp and vldp_dl)
+    pics, fonts, ram, roms, midi, sound, singe, (vldp and vldp_dl)
 
 Run `hypseus` with `daphne` [arguments](doc/CmdLine.md) on the command line:
 
@@ -96,7 +97,7 @@ Example `.bat` files  are provided within the [Windows](win32/) zip file.
 
 **Retro gaming** systems will require adoption within the relevant emulation scripts.
 
-The singe `-retropath` argument can ease integration into libretro style systems. See [RetroPie](src/3rdparty/retropie/RETROPIE.md#extended-argument-summary) as an example.
+The singe `-retropath` argument can ease integration into libretro style systems. See [RetroPie](doc/RETROPIE.md#extended-argument-summary) as an example.
 
 `bash` scripts are provided for systems that support this shell.
 
@@ -106,7 +107,7 @@ The singe `-retropath` argument can ease integration into libretro style systems
     mkdir -p ~/.daphne/vldp_dl ~/.daphne/singe
     cp doc/hypinput.ini doc/flightkey.ini ~/.daphne
     cp doc/hypinput_gamepad.ini ~/.daphne
-    cp -R pics sound fonts ~/.daphne
+    cp -R pics sound fonts midi ~/.daphne
 
     sudo cp build/hypseus /usr/local/bin/hypseus.bin
     sudo cp scripts/run.sh /usr/local/bin/hypseus
@@ -293,7 +294,7 @@ project would not be possible.
 ## License
 
 **Hypseus Singe**, Being Retro Orientated This Humble Emulator Regenerates  
-Copyright (C) 2021-2024  [DirtBagXon][owner]
+Copyright (C) 2021-2025  [DirtBagXon][owner]
 
 **Hypseus**, Multiple Arcade Laserdisc Emulator  
 Copyright (C) 2016  [Jeffrey Clark][JAC]
@@ -328,15 +329,27 @@ Laserdisc Emulator.  __Any direct or indirect commercial use of the mark
 [gcc]: https://gcc.gnu.org/
 [zlib]: http://www.zlib.net/
 [libzip]: https://libzip.org/
+[libzippp]: https://github.com/ctabin/libzippp
 [libmpeg2]: http://libmpeg2.sourceforge.net/
 [SDL2]: https://www.libsdl.org/download-2.0.php
-[SDL_Image]: https://www.libsdl.org/projects/SDL_image/
-[SDL_Mixer]: https://www.libsdl.org/projects/SDL_mixer/
-[SDL_ttf]: https://www.libsdl.org/projects/SDL_ttf/
+[SDL2_image]: https://www.libsdl.org/projects/SDL_image/
+[SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer/
+[SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf/
+[SDL2_gfx]: https://sourceforge.net/projects/sdl2gfx/
+[ManyMouse]: https://github.com/icculus/manymouse
+[serialib]: https://github.com/imabot2/serialib
+[plog]: https://github.com/SergiusTheBest/plog
 [GLEW]: http://glew.sourceforge.net/
 [ogg]: https://en.wikipedia.org/wiki/Ogg
 [vorbis]: https://en.wikipedia.org/wiki/Vorbis
 [cmake]: https://cmake.org
+[lua]: https://lua.org/
+[lua_cjson]: https://github.com/mpx/lua-cjson
+[lua_md5]: https://github.com/lunarmodules/md5
+[lua_sha2]: https://code.google.com/archive/p/sha2/
+[luars232]: https://github.com/ynezz/librs232
+[lua_bitop]: https://bitop.luajit.org/index.html
+[luafilesystem]: https://lunarmodules.github.io/luafilesystem/
 [autotools]: https://en.wikipedia.org/wiki/GNU_Build_System
 [libtool]: https://www.gnu.org/software/libtool/manual/libtool.html
 [peneus]: https://en.wikipedia.org/wiki/Peneus

diff --git a/doc/CmdLine.md b/doc/CmdLine.md
@@ -82,6 +82,7 @@ Refer also to **bezel arguments** [here](Bezels.md)
 | -noissues                        | Don't display warnings about game driver problems.    |
 | -nojoystick                      | Disables any joysticks that may be plugged in. Joysticks will normally be used if available. |
 | -nolog                           | Disables writing to the log file (hypseus.log).    |
+| -nomanymouse                     | Disables the ability to enable ManyMouse input system.        |
 | -noserversend                    | A legacy argument. No usage statistics are collected or sent. |
 | -nosound                         | Disables all sound.                                   |
 | -nospeech                        | Disables speech for Thayer's Quest.                   |
@@ -95,6 +96,7 @@ Refer also to **bezel arguments** [here](Bezels.md)
 | -pal_sa_sc                       | Tells Hypseus that you are using a PAL Software Corner Space Ace disc instead of an NTSC Space Ace disc. *Only relevant when playing the USA version of Space Ace.* |
 | -prefer_samples                  | Same games can emulate sound or use samples of sounds. If both emulated and sampled sounds are available, this option will force sampled sounds to be used. Otherwise, emulated sounds will always be used. |
 | -preset \<number>                | A simple way to pass arguments directly to the game driver. Tells the game driver to use a specific preset configuration. Different for each game. |
+| -romdir \<path>                  | Sets an alternate `roms` directory path.         |
 | -rotate \<degrees>               | Rotates the screen a certain number of degrees counter-clockwise. Valid values are from 0-359. *This is a somewhat limited feature.* |
 | -sboverlaymono                   | Use white LED's in (lair, ace) scoreboard overlay     |
 | -seek_frames_per_ms \<frames> | The # of frames that we can seek per millisecond (to simulate seek delay). Typical values for real laserdisc players are about 30.0 for 29.97fps discs and 20.0 for 23.976fps discs (dragon's lair and space ace). FLOATING POINT VALUES ARE ALLOWED HERE. Minimum value is 12.0 (5 seconds for 60,000 frames), maximum value is 600.0 (100 milliseconds for 60,000 frames). If you want a value higher than the max, you should just use 0 (as fast as possible). *This option may be replaced by something more accurate in the future.* |
@@ -125,18 +127,23 @@ Refer also to **bezel arguments** [here](Bezels.md)
 | -y \<vertical resolution>         | Specifies the height of the game window (in pixels).   |
 
 ## Singe Game Options
+| Option                           | Description                                                                                                                 |
+|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| -8bit_overlay                    | Restore original 8bit Singe overlays.                                                                                       |
+| -blend_sprites                   | Restore BLENDMODE outline on Singe sprites.                                                                                 |
+| -bootsilent                      | Mute sound during initVLDP() - if possible.                                                                                 |
+| -js_range \<1-20>                | Adjust Singe joystick sensitivity: *[def:5]*                                                                                |
+| -nocrosshair                     | Request game does not display crosshairs.                                                                                   |
+| -script                          | Defines the location of the Singe LUA script. **Required** for Singe games.                                                 |
+| -zlua                            | As above for Zipped ROMS.                                                                                                   |
+| -sinden \<1-10> \<color>         | Enable a Sinden style border for Gun Games. Color: *(w)hite, (r)ed, (g)reen, (b)lue or (x*)                                 |
+| -usealt                          | In multigame zipped ROM's. Provide the alternate startup _.singe_ filename within the zip.<br>`-altscript` is an alias.     |
+| -xratio \<float>                 | Pass a float value to help adjust the in-game mouse co-ordinates on the horizontal scale.<br>_1.33_ adjusts _4:3_ to _16:9_ |
+| -yratio \<float>                 | Pass a float value to help adjust the in-game mouse co-ordinates on the vertical scale.<br>Requires game LUA interaction.   |
+
+## Singe EmulationStation helpers
 | Option                           | Description                                                                                 |
 |----------------------------------|---------------------------------------------------------------------------------------------|
-| -8bit_overlay                    | Restore original 8bit Singe overlays.                                                       |
-| -blend_sprites                   | Restore BLENDMODE outline on Singe sprites.                                                 |
-| -bootsilent                      | Mute sound during initVLDP() - if possible.                                                 |
-| -js_range \<1-20>                | Adjust Singe joystick sensitivity: *[def:5]*                                                |
-| -nocrosshair                     | Request game does not display crosshairs.                                                   |
-| -script                          | Defines the location of the Singe LUA script. **Required** for Singe games.                 |
-| -sinden \<1-10> \<color>         | Enable a Sinden style border for Gun Games. Color: *(w)hite, (r)ed, (g)reen, (b)lue or (x*) |
-| -usealt                          | In multigame zipped ROM's. Provide the alternate startup _.singe_ filename within the zip.  |
-
-## Singe Emulationstation helpers
 | -retropath                       | Singe LUA data path _relative_ rewrite in ES [.daphne] extensions. Uses `roms` traversal.   |
 | -singedir \<path>                | Singe LUA data path _absolute_ rewrite in ES [.daphne] extensions. Uses absolute path.      |
 

diff --git a/src/3rdparty/retropie/RETROPIE.md → doc/RETROPIE.md b/src/3rdparty/retropie/RETROPIE.md → doc/RETROPIE.md
@@ -45,7 +45,7 @@ See discussion here: [Discussions](https://github.com/DirtBagXon/hypseus-singe/d
 
 * For compilation the following packages are required:
 
-    sudo apt-get install libmpeg2-4-dev libsdl2-image-dev libsdl2-ttf-dev libvorbis-dev libogg-dev zlib1g-dev cmake
+    sudo apt-get install libmpeg2-4-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev libvorbis-dev libogg-dev zlib1g-dev cmake
 
   *  *  *  *  *
 
@@ -80,6 +80,7 @@ The ``roms`` subdirectory is now purely traversed in the correct ROM location.
     drwxr-xr-x 2 root root    4096 Jul  9 22:28 fonts
     lrwxrwxrwx 1 root root      41 Apr 29 20:01 hypinput.ini -> /opt/retropie/configs/daphne/hypinput.ini
     lrwxrwxrwx 1 root root    4096 Jul 12 12:26 logs -> /opt/retropie/configs/daphne/logs
+    drwxr-xr-x 3 root root    4096 Apr 29 20:00 midi
     drwxr-xr-x 3 root root    4096 Apr 29 20:00 pics
     lrwxrwxrwx 1 root root    4096 Jun 28 19:39 ram -> /opt/retropie/configs/daphne/ram
     lrwxrwxrwx 1 root root      38 Apr 29 20:01 roms -> /home/pi/RetroPie/roms/daphne/roms
@@ -100,7 +101,7 @@ This should allow easier integration within Retro gaming systems.
 
 ### Install hypseus-singe
 
-    sudo apt-get install libmpeg2-4-dev libsdl2-image-dev libsdl2-ttf-dev
+    sudo apt-get install libmpeg2-4-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
 
     git clone --single-branch --branch RetroPie https://github.com/DirtBagXon/hypseus-singe.git
 

diff --git a/doc/debug/ascii_code.c b/doc/debug/ascii_code.c
diff --git a/doc/debug/clock_debug.c b/doc/debug/clock_debug.c
diff --git a/doc/singe.txt b/doc/singe.txt
@@ -31,6 +31,17 @@ spriteLoadData,         sep_sprite_loadata         (spr data)
 spriteResetColorKey,    sep_sprite_color_rekey     (bool, spr) -- Following GFX operations
 spriteRotateFrame,      sep_sprite_rotateframe     (rotation, frame, spr)
 
+musicLoad,              sep_music_load             (MP3 or MIDI music file)
+musicPlay,              sep_music_play             (music, [loops]) -1 = infinite
+musicPause,             sep_music_pause            (void)
+musicIsPlaying,         sep_music_playing          (return bool)
+musicResume,            sep_music_resume           (void)
+musicStop,              sep_music_stop             (void)
+musicSetVolume,         sep_music_volume           (0 - 128)
+musicUnload,            sep_music_unload           (music)
+
+soundLoadData,          sep_sound_loadata          (wav data)
+
 spriteAnimGetFrame,     sep_sprite_get_frame       (spr)
 spriteAnimIsPlaying,    sep_sprite_playing         (return bool)
 spriteAnimLoop,         sep_sprite_loop            (bool, spr)