Files
STARTLINER/README.md
2025-03-14 00:45:26 +00:00

77 lines
2.4 KiB
Markdown

## STARTLINER
A simple and easy to use launcher, configuration tool and mod manager for [many games](https://silentblue.remywiki.com/ONGEKI:bright_MEMORY) (more to come) using [Rainycolor Watercolor](https://rainy.patafour.zip).
Intended for those who just want a glorified `start.bat` clicker, without VHDs, keychips etc.
(for an all-in-one solution, check out the [BlueSteel launcher](https://yozora.bluesteel.737.jp.net/HarmonyPublic/SOS-Kongou)).
Made with Rust (Tauri) and Vue. Technically multiplatform. Contributions welcome.
### Usage
```sh
bun install
bun run tauri dev
bun run tauri build
```
Once a profile is set up, it is possible to bypass the GUI:
```sh
startliner --start --game ongeki --name profile-name
```
### Package format
- [Package format requirements](https://rainy.patafour.zip/package/create/docs/)
- A subset of [the simple Rainycolor format](https://yozora.bluesteel.737.jp.net/HarmonyPublic/SOS-Kongou/wiki/Create-Module#user-content-rainycolor-simple) is currently supported.
```
├───app
│ └───BepInEx
│ └───*
├───option
│ └───Axyz
│ └───*
├───icon.png
├───README.md
└───manifest.json
```
More file overrides may be supported in the future.
Arbitrary scripts are not supported by design and that will probably never change.
### Features
- Clean data modding
- Monitor selection
- segatools configuration UI
- Etc
### Architecture details
- Downloaded packages are stored in `%LOCALAPPDATA%\STARTLINER\data\pkg` (or `$XDG_DATA_HOME/startliner/pkg`).
- Each profile is associated with a prefix directory `%LOCALAPPDATA%\STARTLINER\data\profile-x` which includes:
- `option` with junctions of vanilla opts as well as Rainycolor package opts
- `BepInEx` with Rainycolor mods copied over
- It's currently pointless to symlink those since they are measured in kilobytes
- `segatools.ini` generated on-the-fly and pointing at `option`
- It's currently based on the existing `segatools.ini` but that will change in the future
- logs
- Persistent configuration is stored in `%APPDATA%\STARTLINER` (or `$XDG_CONFIG_HOME/startliner`).
### Todo
- Auto-updates
- CHUNITHM support
- segatools as a special package
- Progress bars and other GUI sugar
- Search bar
- Start check
### Endgame
- IO DLLs and artemis as special packages
- Other arcade games (if there is demand)