aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhannibal2 <24389977+hannibal00212@users.noreply.github.com>2024-01-01 14:20:17 +0100
committerhannibal2 <24389977+hannibal00212@users.noreply.github.com>2024-01-01 14:20:17 +0100
commitee59317f888672844f91dce3cb7fa22a66c895eb (patch)
tree3e3b52f1147595bb8855fee5aa76ac2a6b5917e9
parent4699fd46b99a869c8817f641cb287d012f60beeb (diff)
parentd5e90ae076d3e9de41af390f5c05545437b0415e (diff)
downloadskyhanni-ee59317f888672844f91dce3cb7fa22a66c895eb.tar.gz
skyhanni-ee59317f888672844f91dce3cb7fa22a66c895eb.tar.bz2
skyhanni-ee59317f888672844f91dce3cb7fa22a66c895eb.zip
Merge remote-tracking branch 'origin/beta' into beta
-rw-r--r--CONTRIBUTING.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b33db983d..1b439bc15 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -119,9 +119,14 @@ All data sent is anonymonized and opt-in.
### Mixin
A system to inject code into the original Minecraft code.
-This library is not part of SkyHanni itself; it comes preinstalled with Forge.
+This library is not part of SkyHanni or Forge, but we bundle it.
-For more information, see https://github.com/SpongePowered/Mixin.
+It allows to easily modify methods in Minecraft itself, without conflicting with other mods.
+
+For more information, see https://github.com/SpongePowered/Mixin or [our existing mixins](https://github.com/hannibal002/SkyHanni/tree/beta/src/main/java/at/hannibal2/skyhanni/mixins/transformers).
+
+When creating new Mixins, try to keep the code inside of the mixin as small as possible, and calling a hook as soon as
+possible.
### Repo
@@ -143,7 +148,7 @@ at [DiscordRPCManager.kt](https://github.com/hannibal002/SkyHanni/blob/beta/src/
### Auto Updater
-We use the [auto update library](https://repo.nea.moe/#/releases/moe/nea/libautoupdate) from nea.
+We use the [auto update library](https://github.com/nea89o/libautoupdate) from nea89.
## Additional Useful Developement Tools