Starting mixin docs

CleanroomMC · Sep 21, 2023 · 0b1d9b4 · 0b1d9b4
1 parent abde2e3
commit 0b1d9b4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/mod-development/mixin/mixinbooter.md b/docs/mod-development/mixin/mixinbooter.md
@@ -0,0 +1,6 @@
+--8<--
+https://raw.githubusercontent.com/CleanroomMC/MixinBooter/main/README.md
+--8<--
+
+!!! tip
+    Because of Mixin and Bytecode intricacies, MixinBooter tries to allow both the developers and the users to understand crashes and logs better, but it is still being improved on. Please direct any feedback [here](https://github.com/CleanroomMC/MixinBooter/issues)!
diff --git a/docs/mod-development/mixin/preface.md b/docs/mod-development/mixin/preface.md
@@ -0,0 +1,8 @@
+**Only for advanced developers! Make sure you are adept with Java prior to this!**
+
+Recommended concepts to be acquainted before venturing into mixins:
+
+- Annotations
+- Bytecode Structure
+
+**Mixins are powerful and simplified tools modders use to manipulate existing code at runtime. This goes beyond the basic Reflection and MethodHandle concepts, and results directly in the bytecode of the modified class changing.**
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -16,6 +16,9 @@ nav:
     - Game Object:
       - Sound:
         - Play Sound: mod-development/game-object/sound/play.md
+    - Mixin:
+      - Preface: mod-development/mixin/preface.md
+      - MixinBooter: mod-development/mixin/mixinbooter.md
     - Rendering:
       - Colouring Blocks and Items: mod-development/rendering/colouring-blocks-and-items.md
   - Proposal: