Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
RubixDev committed Aug 9, 2022
1 parent fc9dca7 commit c8528d4
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This mod now tries to provide similar functionality for Fabric, as the only othe

## Features
This mod adds the "Siphon" and "Refill" enchantments to the game. They can be obtained just like Mending and other treasure enchantments.
The enchantments can be added to Shulker Boxes <!-- TODO: and Ender Chests --> on an anvil.
The enchantments can be added to Shulker Boxes and optionally to Ender Chests (see [configuration](#configuration)) on an anvil.

### Siphon
With the Siphon enchantment, any item that you pick up will be immediately stored in an enchanted container as long as that container already has a non-full stack of that exact item inside.
Expand All @@ -25,4 +25,27 @@ This mod does actually work as a server-only mod, but it is not recommended.
Players without the mod on their client cannot see these enchantments on enchanted books and enchanted containers.

## Configuration
*coming soon...*
A few aspects of the mod can be configured in the `config/enchanted_shulkers.toml` config file. On first launch a default file is generated. Below is a list of available options.

| **Option** | **Possible Values** | **Default Value** | **Description** |
|----------------------------|---------------------|-------------------|-------------------------------------------------------------|
| `refill_offhand` | `true`, `false` | `true` | Allow refilling stacks in the offhand |
| `refill_non_stackables` | `true`, `false` | `false` | Allow refilling non-stackable items like Totems of Undying |
| `enchantable_ender_chest` | `true`, `false` | `false` | Allows Ender Chests to also be enchanted |
| `colorize_container_names` | `true`, `false` | `false` | Show the names of placed enchanted containers in aqua color |

## For Mod Developers
If your Mod adds a new container that should support these enchantments, you must simply add the container to the `enchanted_shulkers:portable_container` item tag.
To do that, create the file `portable_container.json` inside the `src/main/resources/data/enchanted_shulkers/tags/items/` folder of your mod with following contents:

```json
{
"replace": false,
"values": [
"your_mod_namespace:your_container_item"
]
}
```

If your container does not extend the vanilla Shulker Box class, you might have to manually implement the [`EnchantableBlockEntity`](https://github.com/RubixDev/EnchantedShulkers/blob/1.19/src/main/java/de/rubixdev/enchanted_shulkers/EnchantableBlockEntity.java) interface and support rendering the enchantment glint and display name colorizer.
For more information have a look at [`ShulkerBoxBlockEntityRendererMixin.java`](https://github.com/RubixDev/EnchantedShulkers/blob/1.19/src/main/java/de/rubixdev/enchanted_shulkers/mixin/client/ShulkerBoxBlockEntityRendererMixin.java) and [`ShulkerBoxBlockEntityMixin.java`](https://github.com/RubixDev/EnchantedShulkers/blob/1.19/src/main/java/de/rubixdev/enchanted_shulkers/mixin/ShulkerBoxBlockEntityMixin.java)

0 comments on commit c8528d4

Please sign in to comment.