Create Basics

Scott Duensing 2022-07-09 22:53:03 +00:00
parent 32c48818f7
commit 8ade615d4b

35
Basics.md Normal file

@ -0,0 +1,35 @@
* Singe is cross-platform, therefore, things you don't normally need to worry
about on Windows are important. Filenames are case sensitive.
"MyScript.singe" and "myscript.singe" are not the same thing! Also, you
should use UNIX path separators - that is "/" instead of "\". Not only will
this make your code look better (since you don't have to duplicate the
forward slash to escape it) but it works everywhere Singe is supported.
* Pick a distinctive name for your game folder. Do not use spaces.
* Use the included Singe Framework. Do not make a copy of this framework in
your game scripts! By including the provided framework you help with future
compatibility as Singe is updated. Begin your game script with:
dofile("Singe/Framework.singe")
* Stay out of the "Singe" folder. This is managed by Singe and anything added
or changed here is subject to future deletion.
* Include a games.dat! This is extremely important for new users! While other
front ends and Singe-based menu systems exist, it's vital that you include
data for the built-in menu system. Almost all support issues are due to this
one simple little file!
* Do not distribute non-essential files. Never ship Singe binaries or Singe
provided scripts with your game! Do not ship index files generated from
the videos.
* Remember your non-Windows friends! If you bundle batch files to start your
game, please include shell scripts for the Linux, Mac, and Pi users. Your
Pi-cade friends will thank you!
* Use a reliable hosting service. Archive.org, while not terribly fast, is
stable and free. Nothing is more annoying than dead file sharing links!
* Tell me (Scott Duensing - scott@kangaroopunch.com) when you release or
update a game! I want to know! I want others to know!