Skip to content

Commit

Permalink
add media
Browse files Browse the repository at this point in the history
  • Loading branch information
btwonion committed Oct 20, 2024
1 parent 2c870a8 commit 060daf3
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`

<details>
<summary>telekinesis.json</summary>

```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.
}
}
```
Expand All @@ -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

Expand Down
Binary file added media/telekinesis-showcase-cave.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/telekinesis-showcase-cow-cropped.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/telekinesis-showcase-cow.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 060daf3

Please sign in to comment.