mirror of
https://github.com/kichikuou/xsystem35-sdl2.git
synced 2026-10-07 14:18:04 +03:00
kichikuou
3cbe4c73d8
Document the supported SDL configurations and build dependencies for each platform. Keep Android on SDL3 only and identify every packaged artifact by its SDL version.
107 lines
4.5 KiB
Markdown
107 lines
4.5 KiB
Markdown
# xsystem35 for Android
|
|
|
|
Minimum supported Android version: 5.0
|
|
|
|
## Download
|
|
You can download prebuilt APKs
|
|
[here](https://github.com/kichikuou/xsystem35-sdl2/releases).
|
|
|
|
### Installing with Obtainium
|
|
Alternatively, you can install `xsystem35-sdl2` using [Obtainium](https://github.com/ImranR98/Obtainium). Obtainium will detect new releases and allow you to update the app directly.
|
|
|
|
1. Install Obtainium on your Android device.
|
|
2. Click the badge below to add the app to Obtainium:
|
|
|
|
[<img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="60">](https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/%7B%22id%22%3A%22io.github.kichikuou.xsystem35%22%2C%22url%22%3A%22https%3A%2F%2Fgithub.com%2Fkichikuou%2Fxsystem35-sdl2%22%2C%22author%22%3A%22kichikuou%22%2C%22name%22%3A%22xsystem35%22%2C%22categories%22%3A%5B%22games%22%5D%7D)
|
|
|
|
## Usage
|
|
### Basic Usage
|
|
You can install games either from a prepared ZIP file or directly from a CD-ROM
|
|
image.
|
|
|
|
#### Installing from a ZIP
|
|
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.
|
|
|
|
#### Installing from a CD image
|
|
1. Transfer the CD image file(s) to your device.
|
|
2. Open the app. Tap the option menu and select "Install from CD image".
|
|
3. Select the image file and, when needed, the matching metadata file at the
|
|
same time. The supported combinations are:
|
|
- `.iso`
|
|
- `.bin` or `.img` with matching `.cue`
|
|
- `.bin` or `.img` with matching `.ccd`
|
|
- `.mdf` with matching `.mds`
|
|
|
|
In many Android file pickers, tapping a file immediately selects only that
|
|
one file. Long-press a file first to enter multi-select mode, then select
|
|
both the image file and its metadata file.
|
|
4. The game will start.
|
|
|
|
### 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
|
|
- To simulate a right-click, tap the black bars on either the left or right,
|
|
or top or bottom of the screen.
|
|
- 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
|
|
|
|
Android builds use SDL3 exclusively. Gradle downloads the fixed official SDL3
|
|
3.4.16 and SDL3_mixer 3.2.4 AARs, verifies their checksums, and supplies their
|
|
native libraries to CMake through Prefab. No separate SDL installation is
|
|
required.
|
|
|
|
### Using Android Studio
|
|
Open this directory as an Android Studio project.
|
|
|
|
### Command Line Build
|
|
Set environment variables and run the `gradlew` script in this directory.
|
|
|
|
Example build instructions (for Debian bookworm):
|
|
```sh
|
|
# Install necessary packages
|
|
sudo apt install git wget unzip default-jdk-headless ninja-build
|
|
|
|
# Install Android SDK / NDK
|
|
export ANDROID_SDK_ROOT=$HOME/android-sdk
|
|
mkdir -p $ANDROID_SDK_ROOT/cmdline-tools
|
|
wget https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip
|
|
unzip commandlinetools-linux-11076708_latest.zip -d $ANDROID_SDK_ROOT/cmdline-tools
|
|
mv $ANDROID_SDK_ROOT/cmdline-tools/cmdline-tools $ANDROID_SDK_ROOT/cmdline-tools/tools
|
|
yes | $ANDROID_SDK_ROOT/cmdline-tools/tools/bin/sdkmanager --licenses
|
|
$ANDROID_SDK_ROOT/cmdline-tools/tools/bin/sdkmanager ndk-bundle 'cmake;3.22.1'
|
|
export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk-bundle
|
|
|
|
# Clone and build xsystem35
|
|
git clone https://github.com/kichikuou/xsystem35-sdl2.git
|
|
cd xsystem35-sdl2/android
|
|
./gradlew build # or ./gradlew installDebug if you have a connected device
|
|
```
|