Added documentation.
This commit is contained in:
Scott Duensing
parent
55df0fc332
commit
6711bee321
2 changed files with 126 additions and 0 deletions
96
INSTALL.txt
Normal file
96
INSTALL.txt
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
SINGE 2.00
|
||||
==========
|
||||
|
||||
(For the latest version of this document, visit https://kangaroopunch.com!)
|
||||
|
||||
Welcome to Singe! The Somewhat Interactive Nostalgic Game Engine!
|
||||
|
||||
|
||||
INSTALLATION & UPGRADE
|
||||
======================
|
||||
|
||||
For the initial installation, create an empty directory and place the Singe
|
||||
binary inside it. Run the binary with no command line options to cause it
|
||||
to generate all the files needed to make Singe work properly. For example:
|
||||
|
||||
C:\Singe2\
|
||||
C:\Singe2\Singe.exe
|
||||
|
||||
Once you run Singe.exe you'll see additional files and directories:
|
||||
|
||||
C:\Singe2\Singe\ (Several files created in this folder.)
|
||||
C:\Singe2\Menu.bat (Or .sh on UNIX-ish OSs.)
|
||||
|
||||
To install games, simply unpack them and place their directory inside the
|
||||
directory you created. For example, ActionMax.7z contains a folder named
|
||||
"ActionMax". Place it here:
|
||||
|
||||
C:\Singe2\ActionMax\
|
||||
|
||||
For all Singe 2 and later games, it will automatically appear in the menu.
|
||||
|
||||
To upgrade, back up any changes you may have made to files inside the Singe
|
||||
subdirectory that was generated during installation. (You really shouldn't
|
||||
be changing things in there!) Delete the Singe subdirectory and run the new
|
||||
Singe binary with no command line arguments to generate the new files.
|
||||
|
||||
Games are available on the Internet Archive:
|
||||
|
||||
Gun Games:
|
||||
- https://archive.org/details/singe-actionmax
|
||||
- https://archive.org/details/singe-crime-patrol
|
||||
- https://archive.org/details/singe-crime-patrol-2
|
||||
- https://archive.org/details/singe-last-bounty-hunter
|
||||
- https://archive.org/details/singe-mad-dog-mccree
|
||||
- https://archive.org/details/singe-mad-dog-mccree-2
|
||||
- https://archive.org/details/singe-platoon
|
||||
- https://archive.org/details/singe-space-pirates
|
||||
- https://archive.org/details/singe-who-shot-johnny-rock
|
||||
|
||||
QTE Games:
|
||||
- https://archive.org/details/singe-cliff-hanger
|
||||
- https://archive.org/details/singe-conan
|
||||
- https://archive.org/details/singe-daitarn-3
|
||||
- https://archive.org/details/singe-dl-2e
|
||||
- https://archive.org/details/singe-dl-tv
|
||||
- https://archive.org/details/singe-dragon-english
|
||||
- https://archive.org/details/singe-dragon-italian
|
||||
- https://archive.org/details/singe-fire-and-ice
|
||||
- https://archive.org/details/singe-jack-english
|
||||
- https://archive.org/details/singe-jack-italian
|
||||
- https://archive.org/details/singe-puss-in-boots-english
|
||||
- https://archive.org/details/singe-puss-in-boots-italian
|
||||
- https://archive.org/details/singe-time-traveler
|
||||
- https://archive.org/details/singe-timegal
|
||||
- https://archive.org/details/singe-titan-ae
|
||||
|
||||
Know of a game we don't have listed? Let us know!
|
||||
|
||||
|
||||
COMMAND LINE
|
||||
============
|
||||
___ ___ _ _ ___ ___
|
||||
/ __|_ _| \| |/ __| __| Somewhat Interactive Nostalgic Game Engine v2.00
|
||||
\__ \| || .` | (_ | _| Copyright (c) 2006-2020 Scott C. Duensing
|
||||
|___/___|_|\_|\___|___| https://kangaroopunch.com
|
||||
|
||||
Usage: Singe-v2.00-Windows-x86_64.exe [OPTIONS] scriptName{.singe}
|
||||
|
||||
-a, --aspect=N:D force aspect ratio
|
||||
-c, --showcalculated show calculated framefile values for debugging
|
||||
-d, --datadir=PATHNAME alternate location for written files
|
||||
-e, --volume_nonvldp=PERCENT specify sound effects volume in percent
|
||||
-f, --fullscreen run in full screen mode
|
||||
-h, --help this display
|
||||
-k, --nologos kill the splash screens
|
||||
-l, --volume_vldp=PERCENT specify laserdisc volume in percent
|
||||
-m, --nomouse disable mouse
|
||||
-n, --nocrosshair request game not display gun crosshairs
|
||||
-s, --nosound, --mutesound mutes all sound
|
||||
-t, --trace trace script execution to screen and file
|
||||
-u, --stretch use ugly stretched video
|
||||
-v, --framefile=FILENAME use an alternate video file
|
||||
-w, --fullscreen_window run in windowed full screen mode
|
||||
-x, --xresolution=VALUE specify horizontal resolution
|
||||
-y, --yresolution=VALUE specify vertical resolution
|
||||
-z, --noconsole zero console output
|
||||
30
Sinden.txt
Normal file
30
Sinden.txt
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
SINDEN LIGHTGUN NOTES
|
||||
=====================
|
||||
|
||||
The "-g" or "--sindengun" argument allows for Singe to draw the borders
|
||||
required by the Sinden Light Gun while scaling the game content to fit
|
||||
inside it. The value, although numeric, should be in quotes and in one
|
||||
of the following formats:
|
||||
|
||||
One value: WW - Just the width of the white border.
|
||||
Two values: WW WB - Width of white border and then black border.
|
||||
Four values: RW GW BW WW - Custom color "white" border and width.
|
||||
Five values: RW GW BW WW WB - Custom color "white" border and width then
|
||||
width of black border.
|
||||
Eight values: RW GW BW WW RB GB BB WB - Custom color "white" border and width
|
||||
then custom color "black" border and
|
||||
width.
|
||||
|
||||
For example, at a minimum, you should specify a decently sized white border
|
||||
and a minimum black border:
|
||||
|
||||
Singe.exe -g "10 1"
|
||||
|
||||
If you want a red border instead of white, again with a minimum black border
|
||||
behind it, use:
|
||||
|
||||
Singe.exe -g "255 0 0 10 1"
|
||||
|
||||
In addition to drawing the border, Singe can request that games hide the gun
|
||||
crosshairs when using the Sinden Light Gun by using the "-n" or "-nocrosshair"
|
||||
option. (Note that the game needs to support this for it to work.)
|
||||
Loading…
Add table
Reference in a new issue