Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
VoxCrafterLP authored Jul 13, 2021
1 parent b5c9e28 commit af2edea
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CauldronInteract

CauldronInteract is a simple 1.17 plugin, which enables dispensers to interact with cauldrons. Dispensers can use buckets to fill or empty a cauldron. Bottles are currently not supported.

## Use case

A possible use for this plugin would be an integration into an automatic lava farm using the new dripstone blocks. This would allow dispensers to empty the cauldrons and fill chests with lava buckets.

## Installation

The installation is fairly straightforward. Download the plugin from the [releases tab](https://github.com/VoxCrafterLP/CauldronInteract/releases) and put the .jar file into the plugins folder. Make sure that you are using a 1.17+ server.

## Bugreports and features

If you have found a bug or you want to request a feature, feel free to [create an issue](https://github.com/VoxCrafterLP/CauldronInteract/issues/new).

## License
This project is licensed under the GNU GPL v3 and may be used accordingly. Further information can be found [here](https://github.com/VoxCrafterLP/CauldronInteract/blob/main/LICENSE).

0 comments on commit af2edea

Please sign in to comment.