docs: updated readme
This commit is contained in:
parent
4314d30d25
commit
ab8f4f8746
1 changed files with 26 additions and 2 deletions
28
README.md
28
README.md
|
@ -1,3 +1,27 @@
|
||||||
# Anime Launcher SDK
|
# 🦀 Anime Launcher SDK
|
||||||
|
|
||||||
SDK based on anime-game-core with some basic instruments like launcher state system and configuration file manager, written on Rust
|
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
|
||||||
|
|
||||||
|
## 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` |
|
||||||
|
|
||||||
|
## Anime Game specific features
|
||||||
|
|
||||||
|
| Description | Feature |
|
||||||
|
| - | - |
|
||||||
|
| Emulate game environment to get additional in-game payment methods | `environment-emulation` |
|
||||||
|
| 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](https://github.com/an-anime-team/honkers-launcher) | `hon-kai` (without dash) |
|
||||||
|
|
Loading…
Reference in a new issue