summaryrefslogtreecommitdiff
path: root/README
blob: 9de4a79d0c4986b658ffbd5b7b3e51dfa53b8435 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
This is a WIP HTML5 implementation of the game Katawa Shoujo. [0]

jQuery is not used, but when.js [1] is used as a sensible Promises/A+ implementation.

== Requirements ==
- Katawa Shoujo (obviously)
- when.js
- Bash
- Firefox/Chrome/a sensible browser
- ffmpeg with fdk-aac, libtheora, libvpx, libx264
- opusenc from opus-tools
- cwebp from libwebp
- zopfli
- nginx

How to use:
0. Get Katawa Shoujo.
1. Copy *.rpyc from Katawa Shoujo/game into unrpyc/ directory.
2. Extract files from data.rpa with an rpa extractor, e.g. unrpa. Put files in www/dump.
3. Run setup.sh.

4. Run nginx.sh [2] to start nginx with appropriate options for development, then connect to localhost:8080.
-- or --
4. Open www/index.html in a browser. This is untested, and some things may not work. [3]

lighttpd.conf is no longer maintained. Patches to fix it are welcome.

== Reducing setup time ==
By editing the Makefile, you can turn on or off the various encodings. To reduce the setup time (many hours), try the following:

Turn off zopflipng recompression by commenting it out. It saves only a few MB but takes several hours to complete. Useful if you're serving many, MANY copies, but not useful if you're serving one locally.

== Reducing file size ==
[TODO]

== Contributing ==

Check Bugzilla for things that need to be done. [4]

[0] http://www.katawa-shoujo.com/
[1] https://github.com/cujojs/when/
[2] If you're on Windoze, sucks for you. Use a better OS.
[3] Do not send patches for this, unless they also fix other issues.
[4] https://bugzilla.happinessforme.com/buglist.cgi?cmdtype=runnamed&namedcmd=Open+HTML5KS+bugs