You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
2.1 KiB
Markdown

Scraps
======
This is a work in progress player for Rags games. Expect bugs and missing
features:
* No GUI (yet). This also means no pretty pictures or music.
* No saves, variable import/export, no JS support, etc
* No stable file format. **You must reimport your game after upgrading Scraps**
Also, be ready to **say goodbye to your** not yet existing **saves**.
* Old rags game format (before the sqlcompact era) are not yet supported
Usage
-----
No gui yet. To import a Rags game:
scraps --import game.rag imported
This expects `load.exe` to be in your working directory... On linux, you need to
be able to execute `.exe` files through wine for this to work, if not create a
shell script that executes wine with the correct parameters and specify it with
`--importer-executable`. Then "play" it with
scraps imported
Compilation
===========
See libshit's general COMPILE.md for the time being. Generally, `./waf configure
--release && ./waf` should work on Linux like systems.
To be able to import Rags games, you'll need to compile `tools/load.c`. If you
have a Mingw (cross)-compiler, you can run something like this:
i686-w64-mingw32-gcc -Os -static -m32 load.c -municode -luuid -loleaut32 -lole32 -o load.exe
If you have wine, you can try to use winegcc:
winegcc -Os -m32 -municode -mno-cygwin load.c -o load.exe -lcombase -luuid -loleaut32
Note that in this case, `load.exe` will be actually a shell script, that you can
execute directly. Make sure you place `sqlce*.dll` in the same directory as
`load.exe`, otherwise it might fail to find it and exit with a completely not
helpful error.
License
=======
This program is free software. It comes without any warranty, to the extent
permitted by applicable law. You can redistribute it and/or modify it under the
terms of the Do What The Fuck You Want To Public License, Version 2, as
published by Sam Hocevar. See http://www.wtfpl.net/ for more details.
Third-party software in `ext` and `libshit/ext` directory are licensed under
different licenses. See [COPYING.THIRD_PARTY](COPYING.THIRD_PARTY) for licenses
of software that end up in binaries.