diff --git a/docs/mod-development/mixin/mixinbooter.md b/docs/mod-development/mixin/mixinbooter.md new file mode 100644 index 0000000..68534cd --- /dev/null +++ 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)! \ No newline at end of file diff --git a/docs/mod-development/mixin/preface.md b/docs/mod-development/mixin/preface.md new file mode 100644 index 0000000..0c11b60 --- /dev/null +++ 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.** \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 329a806..6746e5f 100644 --- 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: