release 2.11.2

DirtBagXon · Apr 1, 2024 · e2ad79d · e2ad79d
1 parent 428d412
commit e2ad79d
Show file tree

Hide file tree

Showing 95 changed files with 28,695 additions and 1,976 deletions.
diff --git a/.github/workflows/cmake-AppImage-platform.yml b/.github/workflows/cmake-AppImage-platform.yml
@@ -60,7 +60,7 @@ jobs:
         echo "Categories=Game;Emulator;" >> AppDir/hypseus.desktop
         echo "Name=Hypseus Singe" >> AppDir/hypseus.desktop
         echo "GenericName=Arcade LaserDisc Emulator" >> AppDir/hypseus.desktop
-        echo "Keywords=emulator;hyspeus;singe;daphne;laserdisc" >> AppDir/hypseus.desktop
+        echo "Keywords=emulator;hypseus;singe;daphne;laserdisc" >> AppDir/hypseus.desktop
         curl -s -SL https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage -o linuxdeploy
         curl -s -SL https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage -o AppImageTool
         chmod +x linuxdeploy AppImageTool
@@ -101,7 +101,7 @@ jobs:
         echo "KEY_TILT = SDLK_t 0 0" >> hypseus-singe/hypinput.ini
         echo "END" >> hypseus-singe/hypinput.ini
         tar -zcvf ../hypseus-singe_${{ env.COMMIT_SHORT_SHA }}_ES-DE.tar.gz hypseus-singe
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: hypseus-singe-AppImage-${{ env.COMMIT_SHORT_SHA }}
         path: hypseus-singe_${{ env.COMMIT_SHORT_SHA }}_ES-DE.tar.gz
diff --git a/.github/workflows/cmake-linux64-platform.yml b/.github/workflows/cmake-linux64-platform.yml
@@ -51,7 +51,7 @@ jobs:
       run: |
         ShortSHA=$(git rev-parse --short ${{ github.sha }})
         echo "COMMIT_SHORT_SHA=$ShortSHA" >> $GITHUB_ENV
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: hypseus-singe-${{ env.COMMIT_SHORT_SHA }}
         path: hypseus-singe.tgz
diff --git a/.github/workflows/cmake-macOS-platform.yml b/.github/workflows/cmake-macOS-platform.yml
@@ -14,20 +14,23 @@ env:
 
 jobs:
   build:
-    runs-on: macos-latest
+    runs-on: macos-13
 
     steps:
       - uses: actions/checkout@master
       - name: Install Homebrew
         run: |
           /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
         if: success()
-      - name: Install SDL2
+      - name: Install Dependancies
         run: |
           brew install sdl2
           brew install sdl2_ttf
           brew install sdl2_image
           brew install automake
+          brew install libvorbis
+          brew install libogg
+          brew install libzip
         if: success()
       - name: Build
         run: |
@@ -47,7 +50,7 @@ jobs:
         run: |
           ShortSHA=$(git rev-parse --short ${{ github.sha }})
           echo "COMMIT_SHORT_SHA=$ShortSHA" >> $GITHUB_ENV
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: hypseus-singe-MacOS-${{ env.COMMIT_SHORT_SHA }}
           path: hypseus-singe.zip

diff --git a/.gitignore b/.gitignore
@@ -1,15 +1,11 @@
-*.o
-/daphne*
-/testvldp*
 hypseus
 .deps
+*.o
 *.d
-*.so
 *.a
-*.res
+*.so
 *.zip
-*.orig
 *.rej
+*.orig
 roms
 build
-src/Makefile.vars
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ Features:
 ## Compile
 
 Minimum software requirements: [gcc], [cmake], [autotools], [zlib], [SDL2],
-[libtool], [vorbis] and [ogg].
+[libtool], [libzip], [vorbis] and [ogg].
 
 ### MacOS X
 
@@ -154,7 +154,7 @@ Edit **run.sh** and **singe.sh**, to reflect the location of your ROM folders:
 
 ## Bezels
 
-Bezel arguments are documented in: [bezels.txt](doc/bezels.txt)
+Bezel arguments are documented in: [Bezels.md](doc/Bezels.md)
 
 ## Hardware USB Scoreboard
 
@@ -217,7 +217,7 @@ The following additional, and reimplemented, arguments have been added to Hypseu
     -linear_scale              [ Enable linear filtering when scaling          ]
     -novsync                   [ Disable VSYNC presentation on Renderer [crt]  ]
     -original_overlay          [ Enable daphne style overlays (lair,ace,lair2) ]
-    -scalefactor <50-100>      [ Scale video display area [50-100]%            ]
+    -scalefactor <25-100>      [ Scale video display area [25-100]%            ]
     -scanlines                 [ Simulate scanlines [adjust: -scanline_shunt]  ]
     -scanline_alpha <1-255>    [ Adjust scanline alpha blending                ]
     -scanline_shunt <2-10>     [ Shunt scanline spacing [adjust: -x -y]        ]
@@ -291,7 +291,7 @@ project would not be possible.
 ## License
 
 **Hypseus Singe**, Being Retro Orientated This Humble Emulator Regenerates  
-Copyright (C) 2021-2023  [DirtBagXon][owner]
+Copyright (C) 2021-2024  [DirtBagXon][owner]
 
 **Hypseus**, Multiple Arcade Laserdisc Emulator  
 Copyright (C) 2016  [Jeffrey Clark][JAC]
@@ -325,6 +325,7 @@ Laserdisc Emulator.  __Any direct or indirect commercial use of the mark
 [CUS]: http://www.daphne-emu.com/site3/statement.php
 [gcc]: https://gcc.gnu.org/
 [zlib]: http://www.zlib.net/
+[libzip]: https://libzip.org/
 [libmpeg2]: http://libmpeg2.sourceforge.net/
 [SDL2]: https://www.libsdl.org/download-2.0.php
 [SDL_Image]: https://www.libsdl.org/projects/SDL_image/

diff --git a/doc/Bezels.md b/doc/Bezels.md
@@ -0,0 +1,63 @@
+# Bezels
+
+Refer also to **CmdLine arguments** [here](CmdLine.md)
+
+## Video Positional Arguments
+| Option    | Description                   |
+|--------------|-------------------------------|
+| -scalefactor _\<25-100\>_   | Scale video image _[25-100]_%                           |
+| -shiftx _\<-100 to 100\>_   | Position video window - horizontally                    |
+| -shifty _\<-100 to 100\>_   | Position video window - vertically                      |
+| -vertical_screen            | Reorient calculations above within a portrait screen    |
+
+
+## Bezel Arguments
+| Option    | Description                   |
+|--------------|-------------------------------|
+| -bezel _\<lair.png\>_              | Specify a _png_ bezel within the 'bezels' sub-folder  |
+| -bezelflip                         | Reverse the priority bezels are rendered to screen    |
+|                                    |                                                       |
+| -scorebezel                        | Built-in bezel: ace/lair/tq scoreboard                |
+| -scorebezel_alpha _\<1-2\>_        | Built-in bezel: alpha transparency levels             |
+| -scorebezel_position _\<x\> \<y\>_ | Adjust position of software Scorepanel                |
+| -scorebezel_scale _\<1-25\>_       | Software Scorepanel scale option                      |
+|                                    |                                                       |
+| -annunbezel                        | Built-in bezel: ace annunciator _[Conversion]_        |
+| -annunlamps                        | Built-in bezel: staggered: lamps only _[Conversion]_  |
+| -dedannunbezel                     | Built-in bezel: ace annunciator _[Dedicated]_         |
+| -tqkeys                            | Built-in bezel: Interactive tq keyboard displayed     |
+|                                    |                                                       |
+| -auxbezel_alpha _\<1-2\>_          | Built-in bezel: alpha transparency levels             |
+| -auxbezel_position _\<x\> \<y\>_   | Built-in bezel: position options                      |
+| -auxbezel_scale _\<1-25\>_         | Built-in bezel: scale option                          |
+
+## Scorepanel Arguments
+| Option    | Description                   |
+|--------------|-------------------------------|
+| -scorepanel                        | Enable windowed software scoreboard in lair/ace/tq    |
+| -scorepanel_position _\<x\> \<y\>_ | Adjust position of software Scorepanel                |
+| -scorepanel_scale _\<1-25\>_       | Software Scorepanel scale option                      |
+| -scorescreen _\< x \>_             | Specify an initial Scorepanel display screen          |
+|                                    |                                                       |
+| _[KEY_TILT]_                       | Switch Scorepanel display screen lair/ace/tq          |
+
+
+## Override built-in bezel graphic
+| Game | Location                   |
+|------|----------------------------|
+| ace      | - bezels/annunoff.png      |
+| ace      | - bezels/annunon.png       |
+| ace      | - bezels/cadet.bmp         |
+| ace      | - bezels/captain.bmp       |
+| ace      | - bezels/spaceace.bmp      |
+|          |                            |
+| ace      | - bezels/onspaceace.bmp    |
+| ace      | - bezels/oncaptain.bmp     |
+| ace      | - bezels/oncadet.bmp       |
+| ace      | - bezels/offspaceace.bmp   |
+| ace      | - bezels/offcaptain.bmp    |
+| ace      | - bezels/offcadet.bmp      |
+|          |                            |
+| tq       | - bezels/tqkeys.png        |
+|          |                            |
+| badlands | - bezels/shoot.bmp         |
diff --git a/doc/CmdLine.md b/doc/CmdLine.md
@@ -9,7 +9,7 @@ The command line format is:
 
 The game type and framefile argument are required.
 
-Refer also to **bezel arguments** [here](bezels.txt)
+Refer also to **bezel arguments** [here](Bezels.md)
 
 ## Game Types
 | Game Type    | Description                   |
@@ -52,6 +52,7 @@ Refer also to **bezel arguments** [here](bezels.txt)
 | Option                           | Description                                           |
 |----------------------------------|-------------------------------------------------------|
 | -altaudio \<suffix string>       | Specifies a suffix to be added to the audio filenames that Hypseus would normally try to use. The purpose is so you can use alternate audio for games. |
+| -alwaysontop                     | Enable SDL WINDOW_ALWAYS_ON_TOP for main game window. |
 | -bank \<which bank> \<base2 value> | Used to modify dip switch settings. The 'which bank' argument specifies which dip switch bank to modify, where 0 is the first bank. The 'base2 value' argument is in 8-bit binary form that is composed of 1's and 0's, where the right-most bit corresponds to the first dip switch. For example, if you wanted to enable dip switch 0 in bank 0, but disable switches 1-7, then you'd do "-bank 0 00000001". |
 | -bezel \<bezel.png>              | Specify a png bezel in 'bezels' sub-folder             |
 | -blank_blue                      | VLDP blank using YUV#1DEB6B                            |
@@ -64,7 +65,7 @@ Refer also to **bezel arguments** [here](bezels.txt)
 | -force_aspect_ratio              | Tells Hypseus to force the 4:3 aspect ratio regardless of the video size. |
 | -fullscreen                      | Runs Hypseus in fullscreen mode (instead of windowed mode). |
 | -fullscreen_window               | Runs Hypseus in a fullscreen window.                    |
-| -gamepad                         | Enable SDL_GameController configuration.               |
+| -gamepad                         | Enable SDL_GameController configuration. Use -haptic [0-4] to configure rumble. |
 | -grabmouse                       | Capture mouse in SDL window.                           |
 | -homedir \<dirname>              | Sets the Home Directory that Hypseus will use.         |
 | -idleexit \<seconds>             | Tells Hypseus to exit after a certain number of seconds if no input has been received. |
@@ -84,20 +85,21 @@ Refer also to **bezel arguments** [here](bezels.txt)
 | -nospeech                        | Disables speech for Thayer's Quest.                   |
 | -novsync                         | Disable VSYNC presentation on Renderer.               |
 | -opengl                          | Enforces SDL_WINDOW_OPENGL                            |
-| -original_overlay                | Enable daphne style overlays (lair,ace,lair2)         |
+| -original_overlay                | Enable daphne style overlays (lair, ace, lair2)       |
 | -pal_dl                          | Tells Hypseus that you are using a PAL Philips Dragon's Lair disc instead of an NTSC Dragon's Lair disc. *Only relevant when playing the USA version of Dragon's Lair.* |
 | -pal_dl_sc                       | Tells Hypseus that you are using a PAL Software Corner Dragon's Lair disc instead of an NTSC Dragon's Lair disc. *Only relevant when playing the USA version of Dragon's Lair.* |
 | -pal_sa                          | Tells Hypseus that you are using a PAL Philips Space Ace disc instead of an NTSC Space Ace disc. *Only relevant when playing the USA version of Space Ace.* |
 | -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. |
 | -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.* |
-| -scalefactor \<50-100>            | Scale video display area [50-100]%.                    |
-| -scanlines                      | Simulate scanline effect.                               |
+| -scalefactor \<25-100>            | Scale video display area [25-100]%.                    |
+| -scanlines                      | Simulate scanline effect. See also -scanline_alpha and -scanline_shunt                               |
 | -scoreboard                      | Enables external Scoreboard.                           |
 | -scoreport \<port>               | Sets which parallel port to use with the scoreboard. 0 correspond to LPT1. *As of v1.0.12, any value over 1 will indicate the address of the parallel port in hexadecimal. So instead of passing in 0, I could pass in 378 which would achieve the same result.* |
-| -script                          | Defines the location of the Singe LUA script. Required for Singe games |
+| -script                          | Defines the location of the primary Singe LUA game script. Required for Singe games. `-zlua` is an alias. |
 | -shiftx \<-100 to 100>           | Shift x-axis on video window [%]                                        |
 | -shifty \<-100 to 100>           | Shift y-axis on video window [%]                                        |
 | -sound_buffer \<number of samples> | Sets the number of samples in the sound buffer. Hypseus runs at 44,100 kHz which means 44,100 samples per second. The sound buffer size is typically 2048 samples. Lower values make the sound more responsive but choppier, while higher values make the sound smoother but more sluggish. |
@@ -108,6 +110,7 @@ Refer also to **bezel arguments** [here](bezels.txt)
 | -texturetarget                   | Enable SDL_TEXTUREACCESS_TARGET (Default).   |
 | -tiphat                          | Invert joystick SDL_HAT_UP and SDL_HAT_DOWN. |
 | -usbscoreboard \<args>           | Enable USB serial support for scoreboard. Arguments: *(i)mplementation, (p)ort, (b)aud* |
+| -usbserial_rts_on                | Enable RTS on USB serial port setup [Default: off] |
 | -use_annunciator                 | Use this when using a real Space Ace scoreboard with the annunciator board attached. *Space Ace only.* |
 | -useoverlaysb \<overlay number>   | Enables a graphical scoreboard for Dragon's Lair, Space Ace, or Thayer's Quest. The 'overlay number' is the style of scoreboard. Currently the two choices for the 'overlay number' are 0 and 1. |
 | -vertical_screen                  | Reorient calculations in the logical fullscreen |
@@ -134,6 +137,7 @@ Refer also to **bezel arguments** [here](bezels.txt)
 |----------------------------------|--------------------------------------------------------------------------|
 | Alt-Enter                        | Toggle Fullscreen.                                                       |
 | Alt-Backspace                    | Toggle Scanlines.                                                        |
+| Alt-[KEYPAD]                     | Viewport Positioning toolbox. Requires [KeyPad]                          |
 | [KEY_BUTTON3]                    | Toggle *overlay* scorebard in lair/ace.                                  |
 | [KEY_COIN1]=\|[KEY_START1]       | *Joystick* hotkey combination for [KEY_QUIT]                             |
 | [KEY_TILT]                       | Switch *scorepanel* display screen lair/ace/tq.                          |

diff --git a/doc/bezels.txt b/doc/bezels.txt