anime-game-testing/anime-launcher-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: updated readme

Browse source
This commit is contained in:
Nikita Podvirnyi 2024-05-27 15:36:30 +02:00
parent 00513049a3
commit dce10eb82f
No known key found for this signature in database
GPG key ID: 859D416E5142AFF3
1 changed files with 20 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -2,29 +2,32 @@
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
> ⚠️ Current implementation is considered legacy. No deep changes will be made.
## Common features
| 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` |
| 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` |
## Anime Game specific features
| Description | Feature |
| - | - |
| Description | Feature |
|--------------------------------------------------------------------|-------------------------|
| Emulate game environment to get additional in-game payment methods | `environment-emulation` |
| Unlock in-game frame rendering limit | `fps-unlocker` |
| Unlock in-game frame rendering limit | `fps-unlocker` |
## Supported games
| 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` |
| [Honkers](https://github.com/an-anime-team/honkers-launcher) | `hon-kai` (without dash) |
| [Punishing: Gray Raven](https://github.com/an-anime-team/an-anime-borb-launcher) | `pgr` |
| 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` |
| [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` |