summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author zaaarf <me@zaaarf.foo>2024-02-15 00:54:12 +0100
committer zaaarf <me@zaaarf.foo>2024-02-15 00:58:26 +0100
commita6aa21a9857594ce1f94b7d200877a96b345b99b (patch)
treec0f67dd86e9758b63078aaff0e499a9da4718d05 /README.md
parente50d61850b0b7bc0005259d343f0c3eb729966e2 (diff)
feat: reworked to make it extension-based, done?0.1.0
might just work, but it's untested for now so take care
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index b47183d..0a5c48f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# WIP, IT DOES NOT WORK YET!
+# UNTESTED FOR NOW, TAKE CARE!
# Lillero-mixin
Lillero-mixin is a Mixin plugin capable of applying [Lillero](https://github.com/zaaarf/lillero) ASM patches without
@@ -6,6 +6,10 @@ needing to inject itself as a JAR library. While slightly dirtier code-wise, thi
[Lillero-loader](https://github.com/zaaarf/lillero-loader) of being compatible with both Forge and Fabric - and, barring
major API changes, with any other future mod loader that will try to force Mixin on you.
+To use this, write a class extending `LilleroMixinPlugin`. Then, register it as a Mixin plugin; it usually involves editing
+or writing your mod's configuration, but the exact steps vary depending on your mod loader.
+Specific instructions for Fabric and Forge coming as soon as I have time for this.
+
## Credits
This time there's one other project that must be mentioned. I would've never thought of this had I not stumbled on
[Manningham Mills](https://github.com/Chocohead/Fabric-ASM). So, thanks to Chocohead for showing that it was indeed