SINGE 2.10
==========

(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, Menu.bat (or
.sh) and run the new Singe binary with no command line arguments to generate
the new files.


COMMAND LINE
============
 ___ ___ _  _  ___ ___
/ __|_ _| \| |/ __| __|   Somewhat Interactive Nostalgic Game Engine v2.10
\__ \| || .` | (_ | _|    Copyright (c) 2006-2024 Scott C. Duensing
|___/___|_|\_|\___|___|   https://KangarooPunch.com   https://SingeEngine.com

Usage:  Singe-v2.10-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
  -o, --audio=TRACK              select default track for audio output
  -p, --program                  trace Singe execution to screen and file
  -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
