Create README.md

Sherko231 · Feb 28, 2024 · 7edc016 · 7edc016
1 parent 763ac82
commit 7edc016
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Simple API to lock items (in inventory or in slot) for Nukkit
+
+### Just register the item you want to lock in ``LockedItemRegistry`` when enabling your plugin
+
+```java
+LockedItemRegistry.registerLockedItem(ItemID.DIAMOND, true);
+```
+to lock item in slot ( you `can't` move the item in inventory but you can't drop it ).
+
+```java
+LockedItemRegistry.registerLockedItem(ItemID.DIAMOND, false);
+```
+to lock item in inventory ( you `can` move the item in inventory but you can't drop it )
+