anime-launcher-sdk/README.md

35 lines
2.2 KiB
Markdown
Raw Normal View History

2023-04-15 10:05:52 +00:00
# 🦀 Anime Launcher SDK
2022-11-11 16:29:16 +00:00
2023-04-15 10:05:52 +00:00
SDK based on [anime-game-core](https://github.com/an-anime-team/anime-game-core) with some basic instruments like launcher state system and configuration file manager, written in Rust
2024-05-27 13:36:30 +00:00
> ⚠️ Current implementation is considered legacy. No deep changes will be made.
2023-04-15 10:05:52 +00:00
## Common features
2024-05-27 13:36:30 +00:00
| Description | Feature |
|--------------------------------------------------|---------------|
| Manage launcher state | `states` |
| Manage launcher config | `config` |
| Manage components (list wine/dxvk versions, etc) | `components` |
| Run the game | `game` |
| Use Discord RPC when the game is running | `discord-rpc` |
| Run the game in `bwrap` sandbox | `sandbox` |
2023-04-15 10:05:52 +00:00
## Anime Game specific features
2024-05-27 13:36:30 +00:00
| Description | Feature |
|--------------------------------------------------------------------|-------------------------|
2023-04-15 10:05:52 +00:00
| Emulate game environment to get additional in-game payment methods | `environment-emulation` |
2024-05-27 13:36:30 +00:00
| Unlock in-game frame rendering limit | `fps-unlocker` |
2023-04-15 10:05:52 +00:00
## Supported games
2024-05-27 13:36:30 +00:00
| Name | Feature |
|----------------------------------------------------------------------------------|---------------------------|
| [An Anime Game](https://github.com/an-anime-team/an-anime-game-launcher) | `gen-shin` (without dash) |
| [Honkers Railway](https://github.com/an-anime-team/the-honkers-railway-launcher) | `star-rail` |
2024-07-04 07:40:54 +00:00
| [Sleepy](https://github.com/an-anime-team/sleepy-launcher) | `zzz` |
2024-05-27 13:36:30 +00:00
| [Honkers](https://github.com/an-anime-team/honkers-launcher) | `hon-kai` (without dash) |
| [An Anime Borb](https://github.com/an-anime-team/an-anime-borb-launcher) | `pgr` |
| [Waves](https://github.com/an-anime-team/wavey-launcher) | `wuwa` |