diff --git a/src/Information.md b/src/Information.md new file mode 100644 index 0000000..54de8d5 --- /dev/null +++ b/src/Information.md @@ -0,0 +1,8 @@ +## What is This Mod? +- This mod is a Custom Avatars mod for Beat Saber for the standalone version of Beat Saber. +- This mod utilizes the [VRM Format](https://vrm.dev/en/vrm/vrm_about.html) to load in models. + - Source for these models can be found [This Section](findvrms.md) + +## What Should I know? +- This mod does not have perfect native performance. From my testing I get around ~30-40fps depending on the avatar and the settings. This will likely be improved in future updates. + - It is recommended that you use Hollywood to render replays with avatars. \ No newline at end of file diff --git a/src/SUMMARY.md b/src/SUMMARY.md index da3bc58..cfa6e6d 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,5 +1,5 @@ # Summary - +- [Information](Information.md) - [Installation (Mod & VRMs)](installation.md) - [Finding VRMs](findvrms.md) - [Configuration](configuration.md)