mirror of
https://github.com/kichikuou/system3-sdl2.git
synced 2026-10-12 17:28:22 +03:00
Add documentation for Switch build
This commit is contained in:
@@ -56,6 +56,11 @@ To use the Emscripten build, check out https://github.com/kichikuou/web and copy
|
||||
### Android
|
||||
|
||||
See [android/README.md](android/).
|
||||
To use the Emscripten build, check out https://github.com/kichikuou/web and copy `out/wasm/system3.*` into its `docs` directory.
|
||||
|
||||
### Nintendo Switch
|
||||
|
||||
See [switch/README.md](switch/README.md).
|
||||
|
||||
## Running
|
||||
Usage:
|
||||
@@ -85,6 +90,9 @@ The first line is not used, because track 1 of game CD is usually a data track.
|
||||
#### `-fm`
|
||||
Use FM tone generator emulation. If not specified, MIDI sound is used.
|
||||
|
||||
#### `-timiditycfg` _filename_
|
||||
Specified a specific configuration file in a [format for TiMidity](https://manpages.ubuntu.com/manpages/bionic/en/man5/timidity.cfg.5.html) to use (used in some platforms by SDL_Mixer).
|
||||
|
||||
#### `-game` _game_id_
|
||||
Since System1-3 behave slightly differently depending on the game, `system3` uses fingerprint of the scenario file (ADISK.DAT) to determine which game you are playing. This option allows you to override this. This is useful when running patched games.
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# System3 for Switch
|
||||
|
||||
## Build
|
||||
Prerequisites:
|
||||
- CMake >=3.20
|
||||
- devkitPro environment ([how to install](https://devkitpro.org/wiki/devkitPro_pacman]))
|
||||
- Nintendo Switch development tools package (switch-dev)
|
||||
- SDL2, SDL2_Mixer and SDL2_ttf Switch ports (switch-sdl2, switch-sdl2_ttf, switch-sdl2_mixer)
|
||||
|
||||
```sh
|
||||
git submodule update --init
|
||||
sudo (dkp-)pacman -S switch-dev switch-sdl2 switch-sdl2_ttf switch-sdl2_mixer
|
||||
mkdir -p out/debug
|
||||
cd out/debug
|
||||
/opt/devkitpro/portlibs/switch/bin/aarch64-none-elf-cmake -DCMAKE_BUILD_TYPE=Debug ../../src/
|
||||
make
|
||||
```
|
||||
|
||||
## Use
|
||||
1. Copy the resulting `system3.nro` file to a folder inside your Nintendo Switch's SD card (eg. `/switch/[game name]/`)
|
||||
2. Copy all the game files, BGM files and configuration.
|
||||
3. Open system3 through the Homebrew Launcher
|
||||
|
||||
## Notes
|
||||
- The Switch needs its own MIDI Sound Library (eg. freepats, configurable through `timiditycfg` on the `system3.ini` config) due to the lack of built-in MIDI files.
|
||||
Reference in New Issue
Block a user