diff --git a/android/README.md b/android/README.md index a25d771..5a6b3b0 100644 --- a/android/README.md +++ b/android/README.md @@ -6,7 +6,44 @@ Minimum supported Android version: 5.0 You can download prebuilt APKs [here](https://github.com/kichikuou/xsystem35-sdl2/releases). -## Build +## Usage +### Basic Usage +1. Create a ZIP file containing all the game files and BGM files (see + [below](#preparing-a-zip) for details), and transfer it to your device. +2. Open the app. Tap the option menu (three dots in the top right corner) and + select "Install from ZIP". +3. Select the ZIP file you created in step 1. +4. The game will start. To simulate a right-click, tap the black bars on either + the left or right, or top or bottom of the screen. + +### Preparing a ZIP +- Include all files from the `GAMEDATA` folder (such as `.ALD` files and + others). `.EXE` and `.DLL` files are not necessary, but you can include them + if you want. +- Music files (`.mp3`, `.ogg`, or `.wav`) whose filenames have a number either + at the beginning or just before the extension are recognized as BGM files. + For example: + - `Track2.mp3` + - `15.ogg` + - `02 - Title.mp3` + - `rance4_03.wav` (Note: The filename shouldn't be `rance403.wav`, as it + would be treated as the 403rd track.) + +Note: This ZIP format is also compatible with +[Kichikuou on Web](http://kichikuou.github.io/web/). + +### Miscellaneous +- You can export or import save files via the game list's option menu. +- To uninstall a game, long-tap its title in the game list. + +## Known Issues +- Android versions older than 7.0 cannot handle ZIP files containing Shift-JIS + filenames. This issue occurs with some ZIP files distributed on + [retroc.net](http://retropc.net/alice/). If you encounter the error message + "This type of ZIP is not supported," unzip the file on your PC and re-archive + it using modern ZIP creation software. + +## Building from Source ### Using Android Studio Open this directory as an Android Studio project. @@ -34,39 +71,3 @@ git clone https://github.com/kichikuou/xsystem35-sdl2.git cd xsystem35-sdl2/android ./gradlew build # or ./gradlew installDebug if you have a connected device ``` - -## Usage -### Basic Usage -1. Create a ZIP file containing all the game files and BGM files (see - [below](#preparing-a-zip) for details), and transfer it to your device. -2. Open the app. A list of installed games will be displayed. Since no games - have been installed yet, only the "Install from ZIP" button will be visible. - Tap it. -3. Select the ZIP file you created in step 1. -4. The game will start. To simulate a right-click, tap the black bars on either - the left or right, or top or bottom of the screen. - -### Preparing a ZIP -- Include all files from the `GAMEDATA` folder (such as `.ALD` files and - others). `.EXE` and `.DLL` files are not necessary, but you can include them - if you want. -- Music files (`.mp3`, `.ogg`, or `.wav`) whose filenames end with a number - will be recognized as BGM files. For example: - - `Track2.mp3` - - `15.ogg` - - `rance4_03.wav` (Note: The filename shouldn't be `rance403.wav`, as it - would be treated as the 403rd track.) - -Note: This ZIP format is also compatible with -[Kichikuou on Web](http://kichikuou.github.io/web/). - -### Miscellaneous -- You can export or import save files via the game list's option menu. -- To uninstall a game, long-tap its title in the game list. - -## Known Issues -- Android versions older than 7.0 cannot handle ZIP files containing Shift-JIS - filenames. This issue occurs with some ZIP files distributed on - [retroc.net](http://retropc.net/alice/). If you encounter the error message - "This type of ZIP is not supported," unzip the file on your PC and re-archive - it using modern ZIP creation software.