scraps

Abandon all hope, ye who enter here.
git clone https://git.neptards.moe/neptards/scraps.git
Log | Files | Refs | Submodules | README | LICENSE

README.md (2140B)


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