64 lines
2.3 KiB
Text
64 lines
2.3 KiB
Text
SINGE 3.00
|
|
==========
|
|
|
|
(For the latest version of this document, visit https://kangaroopunch.com!
|
|
The full manual is extracted to Singe/Manual.pdf on first run.)
|
|
|
|
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
|
|
============
|
|
|
|
Run the binary with -h (or --help) for the option summary. Every option is
|
|
described in the "Command Line Options" chapter of Singe/Manual.pdf, which
|
|
is extracted on first run.
|
|
|
|
|
|
BUILDING FROM SOURCE
|
|
====================
|
|
|
|
The build is a CMake superbuild: one preset per platform builds every
|
|
vendored library (zlib, zstd, SDL3 and its satellites, OpenSSL, FFmpeg)
|
|
into .builddir/<os>/<arch> and then Singe against them. The cross
|
|
toolchains live in ../toolchains (see toolchains.sh there); build-all.sh
|
|
prepares that environment and runs the preset:
|
|
|
|
./build-all.sh every supported platform
|
|
./build-all.sh linux x86_64 one platform
|
|
./build-all.sh linux x86_64 --target singe Singe alone, libraries as built
|
|
./build-all.sh linux x86_64 --target rebuild-ffmpeg redo one library
|
|
|
|
The finished binary is copied to .builddir/Singe-v<version>-<Os>-<arch>.
|
|
Presets are linux-x86_64, pi-aarch64, macos-aarch64 and windows-x86_64
|
|
(CMakePresets.json).
|