Add information

BSQ-VRM · Dec 1, 2023 · fd455d7 · fd455d7
1 parent 2b436d6
commit fd455d7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/Information.md 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.
diff --git 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)