Max/kichikuou_system3-sdl2
1
0
Fork 0
mirror of https://github.com/kichikuou/system3-sdl2.git synced 2026-10-11 16:58:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update android/README.md

Browse Source
This commit is contained in:
kichikuou
2025-04-10 10:40:21 +09:00
parent aedfa185c7
commit 6e84b73064
1 changed files with 33 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
android/README.md
+33 -32
View File
@@ -6,7 +6,39 @@ Minimum supported Android version: 5.0
You can download prebuilt APKs
[here](https://github.com/kichikuou/system3-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 `.DAT` files.
- 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`
- `rance41_03.wav` (Note: The filename shouldn't be `rance4103.wav`, as it
would be treated as the 4103rd 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
- Installing from a ZIP file containing multiple games (e.g., the DPS series)
may not work correctly.
## Building from Source
### Using Android Studio
Clone this repository along with its submodules:
@@ -39,34 +71,3 @@ git clone --recurse-submodules https://github.com/kichikuou/system3-sdl2.git
cd system3-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 `.DAT` files.
- Music files (`.mp3`, `.ogg`, or `.wav`) whose filenames end with a number are
recognized as BGM files. For example:
- `Track2.mp3`
- `15.ogg`
- `rance41_03.wav` (Note: The filename shouldn't be `rance4103.wav`, as it
would be treated as the 4103rd 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
- Installing from a ZIP file containing multiple games (e.g., the DPS series)
may not work correctly.