summaryrefslogtreecommitdiff
path: root/README
blob: 170ed2c687c322dff1447366ed041c6d45c4160e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
This is an HTML5 implementation of the game Katawa Shoujo. [0]

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

It's still very much a WIP, but at least the first scene displays half-credibly.

How to use:
0. Get Katawa Shoujo.
1. Follow steps in unrpyc/README
2. Extract files from data.rpa with an appropriate tool. Put files in www/dump.
3. Modify www/dump/ui/bt-cf-{un,}checked.png to remove empty borders.
4. Re-encode (sigh) dump/video/* into .mp4, .webm and .ogg files. reencode.sh can be used to do this, but spinning your own is fine too.

4. Run nginx.sh to start nginx with appropriate options for development, then connect to localhost:8080.
-- or --
4. lighttpd -f lighttpd.conf should also work, but is not actively tested.

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

[0] http://www.katawa-shoujo.com/
[1] https://github.com/cujojs/when/
[2] https://bugzilla.happinessforme.com/buglist.cgi?cmdtype=runnamed&namedcmd=Open+HTML5KS+bugs