Add mixinexport tag (#150)

* feat: add mixinexport tag, remove mixindebug tag * fix: directory separators Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com> * feat: add links pointing to guides to set vm options * move image to github --------- Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com> Co-authored-by: modmuss <modmuss50@gmail.com>
FabricMC · May 1, 2024 · 72bd619 · 72bd619
1 parent 3ba7ca3
commit 72bd619
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/images/mixin-export.png b/images/mixin-export.png
diff --git a/tags/guide/mixindebug.ytag b/tags/guide/mixindebug.ytag
diff --git a/tags/guide/mixinexport.ytag b/tags/guide/mixinexport.ytag
@@ -0,0 +1,25 @@
+type: embed
+
+colour: black
+embed:
+    title: Exporting Mixin Classes
+    image:
+        url: "https://raw.githubusercontent.com/FabricMC/community/main/images/mixin-export.png"
+
+---
+
+Annotate your Mixin class with `@Debug(export = true)`, which will export the individual Mixin.
+
+Example:
+```java
+@Debug(export = true)
+@Mixin(...)
+public class MyMixin {
+    // Mixin code here
+}
+```
+You can export **all** Mixin classes by adding `-Dmixin.debug.export=true` to your VM options.
+> IntelliJ IDEA - [Run/debug configurations - More options](https://www.jetbrains.com/help/idea/run-debug-configuration-java-application.html#more_options) (See "VM options")
+> VSCode - [Running and debugging Java - Configuration options](https://code.visualstudio.com/docs/java/java-debugging#_configuration-options) (See "vmArgs")
+
+Exported finalized classes will appear in `run/.mixin.out`.