diff --git a/README.md b/README.md index 5187f82..9544fc1 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,39 @@ # telekinesis -This mod/plugin adds the telekinesis enchantment, allowing you to instantly move exp and item drops into your inventory. -This includes the drops from mobs, vehicles and blocks. +Adds auto-pickup functionality to the player. Also know as telekinesis from Hypixel Skyblock. -## Where can I get this enchantment? +## Functionality -You can trade this enchantment with villagers, enchant it in an enchanting table, or you can find it in treasures +Check out the [Gallery](https://modrinth.com/plugin/telekinesis/gallery) for a preview. + +With this mod you can automatically pickup drops, including experience, from mobs, blocks and entities. + +## Can I use the functionality without the enchantment? + +Yes, in the [config](#Configuration) you can change the `needEnchantment` option to `false`. If you want to only apply this +functionality while sneaking, you can also enable `needSneak` + +## Where can I find the enchantment? + +You can trade the enchantment with villagers, enchant it in an enchanting table, or you can find it in treasures enchanting on tools. ## Configuration The configuration file can be found in the client/server directory. --> configuration file: `/config/telekinesis.json` +-> `/config/telekinesis.json`
telekinesis.json ```json5 { - "version": 1, - // For migration purposes only, just ignore this. + "version": 1, // For migration purposes only, just ignore this. "config": { - "needEnchantment": true, - // Defines, whether telekinesis should without or with the enchantment on the tool. - "needSneak": false, - // Defines. whether the player should have to sneak in order to use telekinesis. - "expAllowed": true, - // Enables the use of telekinesis for exp drops. - "itemsAllowed": true - // Enables the use of telekinesis for item drops. + "needEnchantment": true, // Defines, whether telekinesis should without or with the enchantment on the tool. + "needSneak": false, // Defines. whether the player should have to sneak in order to use telekinesis. + "expAllowed": true, // Enables the use of telekinesis for exp drops. + "itemsAllowed": true // Enables the use of telekinesis for item drops. } } ``` @@ -37,7 +42,7 @@ The configuration file can be found in the client/server directory. ### Other -If you need help with any of my mods, just join my [discord server](https://nyon.dev/discord). +If you need help with any of my mods, join my [discord server](https://nyon.dev/discord). #### Paper Compatibility diff --git a/media/telekinesis-showcase-cave.gif b/media/telekinesis-showcase-cave.gif new file mode 100644 index 0000000..26d258b Binary files /dev/null and b/media/telekinesis-showcase-cave.gif differ diff --git a/media/telekinesis-showcase-cow-cropped.gif b/media/telekinesis-showcase-cow-cropped.gif new file mode 100644 index 0000000..c8c97b3 Binary files /dev/null and b/media/telekinesis-showcase-cow-cropped.gif differ diff --git a/media/telekinesis-showcase-cow.gif b/media/telekinesis-showcase-cow.gif new file mode 100644 index 0000000..c64fd8f Binary files /dev/null and b/media/telekinesis-showcase-cow.gif differ