This is a WIP HTML5 implementation of the game Katawa Shoujo.
- Navigate to http://html5ks.happinessforme.com/
- Katawa Shoujo (obviously)
- Firefox/Chrome/a sensible browser (i.e. not IE)
- a shell (Bash, dash, zsh, etc)
- GNU make 3.82 or greater (see Makefile section)
- ffmpeg (preferably git HEAD) with fdk-aac, libopus, libtheora, libvpx-vp9, libx264 - for full list, see
configureor.travis.sh - cwebp and webpmux from libwebp
- convert from ImageMagick
- apngasm
- Node.js, npm for uglifyjs
- Python 3
- DeflOpt
- defluff
- inotify-tools (for
make dev) - jpegmini
- jpegrescan
- jpegtran
- nginx
- pngquant
- zopfli and zopflipng
- Get Katawa Shoujo, install prerequisites. For guidance on Ubuntu, see .travis.sh.
- Copy *.rpyc from Katawa Shoujo/game into ast2json/ directory.
- Extract files from Katawa Shoujo/game/data.rpa to www/dump/ with an rpa extractor, like rpatool or unrpa.
- Install prerequisites.
- Run ./configure.
- Run make.
- Run nginx.sh to start nginx, then navigate to localhost:8080 in your browser. -- OR --
- Open www/index.html in a browser.
To reduce programs and build time required, some conversions can be disabled by passing CONVERSION= on the command line, e.g. ZOPFLIPNG= ./configure.
Alternatively, just don't install those programs. Conversions that are safe to disable are labeled as such in configure. If a required conversion is disabled, configure will print a big error.
Run make space. Warning: This will remove source files from dump.
make will continue to work (i.e. make new files as appropriate) but will not re-make converted files.
See CONTRIBUTING.rst.
Run make dev to automatically start nginx and re-make when changes are made.
GNU make is required since I do not really want to write a script to output a Makefile. I refuse to use autoconf; moreover, it isn't even relevant to this program, being designed for use with C/C++ projects.
Make 3.82 is required since this version sorts rules differently; versions of make prior to this one will not properly build www/dump/ctc_strip-0.png, resulting in errors building ctc_anim.png and ctc_anim-*.webp. If you must use a version before that one (e.g. you are stuck on Ubuntu 12.04), manually building that file according to the Makefile should resolve the error. Patches to fix this are welcome.