diff --git a/README.md b/README.md new file mode 100644 index 0000000..c410c4e --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Right Click Harvester + +simple plugin to right click harvest crops + +## features + +- easy harvest +- Replants automatically +- Supports foila and paper! Mostly tested! +- Can be configured with the json (check below) + +## configuration + +The plugin generates a `harvester.json` file in its data folder: + +- `Drop_Seeds`: (true/false) Whether to drop seeds when harvesting. +- `Use_Durability`: (true/false) Whether the hoe should lose durability. +- `DropTo`: ('ground' or 'inventory') Where to put harvested items. +- `Require_Hoe`: (true/false) Whether a hoe is required to harvest. +- **Inventory Full Notification**: If `DropTo` is set to `inventory` and the player's inventory is full, an action bar message will appear and items will drop to the ground. + +## supported Crops + +- Wheat +- Carrots +- Potatoes +- Beetroots +- Nether Wart +- Cocoa Beans