KS2Android

Katawa Shoujo Android port

I didn't have time to work on this at all since I've released v7.
Sincere apologies to anyone who sent an email and didn't receive a response.

I tried to keep up for a while but I spent too much time troubleshooting problems
 for people only to find out that they've put the files in the wrong folder.
(I'd sometimes receive a couple emails each day)
Not to mention those which would just plain ask why it doesn't work on their
 device with 240x320 resolution and 256MB RAM.
Well, I guess I can't blame them, there are no minimum requirements listed.

I appreciate all messages of support. I would've stopped updating this quite
 a while ago if it weren't for the demand.

There is probably going to be at least one new version released because the
 last one has quite a serious bug.
      When? No idea...

The latest version is v7, last updated on 23 January 2014

Instructions:
- Download the Android package (.apk) and expansion data file (.obb) from the links in the Downloads section
- Copy both files to your phone using a usb cable, bluetooth, etc. or just download them straight to your phone.
- Install the apk using any Android file manager.
(If the installation fails, make sure "Unknown sources" is checked in your device's security settings)
- Copy the obb file to /Android/obb/vn.katawashoujo/ on your external storage device,
  usually an SD Card. Create the folders if they don't exists. Delete obb files from previous versions.
(If you don't copy the obb file or if you copy it to the wrong location you will be greeted with the message
saying "Download failed because the resources could not be found" when you launch KS)
- That's it, launch KS

(For earlier versions only monolithic apks are available, there is no obb file)


Downloads: (Last update: 23 January 2014)
Latest version: http://d-h.st/bCM (apk)
                http://d-h.st/VsZ (obb)

Older versions: http://tiny.cc/KS-v6-Android-apk (Dev-Host http://d-h.st/gLJ)
                http://tiny.cc/KS-v6-Android-data (Dev-Host http://d-h.st/i8g)


                http://tiny.cc/KS-v5-Android-apk (Dev-Host http://d-h.st/Olt)
                http://tiny.cc/KS-v5-Android-data (Dev-Host http://d-h.st/g3y)

                http://tiny.cc/KS-v5-Android-monolithic (Dev-Host)
                  Here's a one-piece version (334MB in a single apk) for those who had problems
                  with the obb expansion file.


                http://tiny.cc/KS-v4-Android (Dev-Host)
                http://tiny.cc/KS-v4-Android-lowmemory (Dev-Host, use only if your device has less
                                                        than 512MB of RAM and/or Katawa Shoujo is
                                                        randomly force-closing.)

                http://tiny.cc/KS-v3-Android (Dev-Host)

                http://tiny.cc/KS-v2-Android (Dev-Host, no waiting, captchas and similar annoyances,
                                              why didn't I know about it before?)
                http://tiny.cc/KS-v2-Android-alternate (Multiupload, multi-annoyances)

                http://tiny.cc/KS-v1-Android (Dropbox)

You will maybe lose your progress when you update.
If you are unable to save your game after updating you will have to clear the app's
data from the settings menu. (this only happened in old versions)

Differences from the PC version:
What works:
 - The text and the script
 - Backgrounds and characters
 - Particles (e.g. snow)
 - Sound effects
 - Music
 - Saving and loading
 - Transitions (as of 12 June 2013)
 - Videos between acts (as of 18 December 2013)
What doesn't:
 - Everything works (Fuck yeah!)

Changelog and bugs:

Here "crash" actually means "exception screen with an ignore button".

v7 - known bugs:
     - The note window, see below
     - The ending credits don't work, will be fixed in the next version
   - fixes:
     - Fixed the black screen issue with v6 on some devices.
   - changes:
     - Added a link to this pastebin on the splash screen due to an increasing number
       of reuploads which do not link here.

v6 - known bugs:
     - KS hangs on a black screen on some devices after the loading screen
       I am investigating the issue and will make an update as soon as possible
     - The note window, see below
   - fixes:
     - All videos now work e.g. route introductions, passing of time sequences etc.
   - changes:
     - Now includes all the content from Katawa Shoujo 1.1
     - The game now uses /Android/data/vn.katawashoujo/files/saves on your external storage
       as the save location.
     - The save states are NOT compatible with the PC version. The persistance file is.
       The persistance file is what holds your progress info, completion percentage, library
       and gallery unlock status.
     - All your saves and the persistance data will be copied over to the new location the
       next time you start KSv6 if you installed it over an older version.
       If you try to load an incompatible save, it will crash the game.

v5 - known bugs:
     - The note window, it seems to actually be a problem in Ren'Py
   - fixes:
     - All transitions work now

   A lot of bugs that I had to work around have been fixed in Ren'Py itself so this version is made
   completely from scratch. Let me know if there are any bugs I missed.

v4 - known bugs:
     - The note window, see v2
   - fixes:
     - Fixed the crash that happened at the end of each route.
       Seems like 4LS considered the fact that they might want to make a related project as some point
       and used "multipersistent storage". Basically, it allows two different Ren'Py games to share
       progress information.
       From what I understand, it just notes which ends you have seen but no information is ever
       read from the file.
       Since Ren'Py for Android doesn't have multipersistent storage implemented yet I have just
       removed it from the script.

v3 - known bugs:
     - The note window, see v2
     - A crash possibly related to saving some information after finishing a route has been reported.
       I am yet to look into it.
   - fixes:
     - Fix for the "JPEG loading error" that was occurring on some devices (awaiting feedback! -> FIXED)
     - Fixed two bugs in Shizune's route related to the "[" character and double-speak.

v2 - known bugs:
     - The note window (e.g. the note from Hisao's mom and dad) doesn't show up if the background
       is set to tile. Instead I've set it to stretch for the time being. The text doesn't strictly
       follow the horizontal lines on the note anymore but it doesn't look bad.
       This is also present in v1.
       If anyone reading this has any experience with Ren'Py, let me know.
     - Emi-knockdown and Shizune-Lilly-showdown scenes have been reported to cause an exception
       (JPEG loading error) on Android 4.1.1 (clicking on "Ignore" skips a few lines but you can continue)
       I haven't been able to reproduce the issue on my Android 4.0.4 device.
   - fixes:
     - Fixed the credits screen crash
     - Hopefully fixed all crashes related to character transitions (if you encounter any, email me)

v1 - known bugs:
     - On a couple of points in the game you'll get an "An exception has occurred" screen with a bunch
       of technical information. Just click on "Ignore" and you're good to go.
     - The credits on the end will keep throwing exceptions and you can't really continue no matter how
       many times you click on "Ignore"

Feel free to send bug reports to: kss22aa@gmail.com
When sending a crash report, please include the .txt files from /Android/data/vn.katawashoujo/files
If possible, include the system log. You can access it with apps such at CatLog (root required for Android 4.1+)
The log should be saved just moments after the crash happens.


FAQ (Last change: 18 December 2013):

Q: It hangs at the loading screen. What do I do?
A: It will take a while to load, especially if it's an older phone, give it a minute or two.

Q: It crashes at the loading screen! What is this shit?
A: Are you using CyanogenMod? If so, there seems to be a bug in CM which causes an error. Try sending a bug report to CM devs.
Someone made a bug report for it here: https://jira.cyanogenmod.org/browse/CYAN-1423

Q: Where are the save files located?
A: v6+: /Android/data/vn.katawashoujo/files/saves on your external storage
   v1-5: /data/data/vn.katawashoujo/files/saves but you can't access them without rooting your phone.

Q: Can I use the save files from the PC version?
A: You can't use the save files but you can use the persistance file. See the changelog for v6 for more info.
Old answer: No, they are incompatible due to differences between the Ren'Py versions.
   What you can do is tick "Skip unread text" in the options menu (something that a surprisingly large amount of people don't know about),
   enter skip mode and just skip through everything you've already read.
   KS on Android is using a much more recent version of Ren'Py so skip mode is a lot faster than on PC.
Old answer 2: Save files from KS 1.1 on Linux and OSX might be compatible but I haven't tested that.

Q: Are you from Indonesia?
A: No. A link to this paste has appeared on what seems to be a popular Indonesian forum.
   KSG threads on 4chan are the only place where I posted the link myself.

Q: How can I contact you?
A: Send an email to kss22aa@gmail.com



History...
This was previously a paste containing a Python script that operated on the Windows version
of Katawa Shoujo and compiled it into an Android package.
It was designed to avoid the complications of the Creative Commons license which forbids
distributing derivative works. However after I saw how many bugs were introduced by the
incompatibility between the different versions of Ren'Py I decided to drop that idea and
just upload compiled versions here.
If anyone is interested in changes that are required, drop me a note here: kss22aa@gmail.com
For historical reasons the script is now available here: http://pastebin.com/u1ubhLMN


-In reply to an anonymous email from Dave U. Random <anonymous@anonymitaet-im-inter.net>
Creating an app to export the save files would be impossible without giving the app root
access because of how Android works. A user with root access can use any file manager
to copy the files to another location. (See the FAQ for the location of save files)
Another option would be to modify Ren'Py's saving mechanism to save the files to another
location but I'd rather not go that far.
Please notify me when you've read this.


-In reply to an anonymous email from Anonymous <nobody@remailer.paranoici.org> signed: NotReallyDave
I hope I have fulfilled your request with the change made to the latest version.

What happened is that the latest Ren'Py uses external storage as the preferred
location for save files unless there are already some in other locations.
I have modified it to move the existing saves to the new location.

>I'm sending it once more, in case it landed where it shouldn't
I received a total of two emails from you. One probably did land where it shouldn't.

>Also, Android video support? Awesome, are we missing anything else to enjoy it fully?
No, it think that's it.



In reply to anonymous emails signed: NotReallyDave
>Also, if you wish to contact me through other means, maybe you've got *************?
I do but I'm not going to write it down here for obvious reasons.
Feel free to email me yours but I don't think that's necessary.

>Still, my mission has not been accomplished yet. It didn't actually convert existing saves.
You did run KS, right? Did you check the location mentioned in the updated FAQ answer regarding saves?

>it did not start on Xperia SP on Android 4.1.2 (hangs after loading splash image, as you said)
Try v7.

>This device also has funny way of storing your app data, because I need to put obb file in limited internal storage (what is 5GB nowadays...).
I don't really understand this. You mean that its external storage directory doesn't reside on an external removable device (such as an sdcard) but on device's internal memory? That's normal.