From ab8f4f8746633efa409ba7a55b3bfb215723e4f7 Mon Sep 17 00:00:00 2001 From: Observer KRypt0n_ Date: Sat, 15 Apr 2023 12:05:52 +0200 Subject: [PATCH] docs: updated readme --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19b39e2..1734b9b 100644 --- a/README.md +++ b/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) |