Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jamalam360 committed Jan 28, 2025
1 parent e4e2278 commit cf5a69e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 16 deletions.
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,38 @@
![RCH Banner](https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_HEADER.webp)

<p align="center">RightClickHarvest is a mod for Fabric, (Neo)Forge, and Quilt that allows harvesting a variety of crops with just a right click.</p>
<center><img width="100%" src="https://github.com/JamCoreModding/right-click-harvest/blob/main/demo.gif?raw=true" /></center>
<h3 align="center">RightClickHarvest is a mod for Fabric and NeoForge that allows harvesting crops and plants with just a right click.</h3>

<a href="https://bisecthosting.com/jamalam"><img alt="Rent a Server (25% off with code JAMALAM)" src="https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_PROMO.webp" /></a>
- Right click to harvest crops, replanting the seeds automatically.
- Harvest all vanilla crops, including cocoa beans, cactus, sugar cane, and more.
- Enchant your hoe with fortune to get a higher yield.
- Harvest 99.9% of modded crops without extra configuration.
- Configure if a hoe is required and whether harvesting uses hunger points.
- Configure whether higher tier hoes harvest in a larger radius.

<img alt="About RightClickHarvest" src="https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_BANNER1.webp" />
<h2 align="center">Config</h2>

<center><img width="100%" src="https://github.com/JamCoreModding/right-click-harvest/blob/1.20.2-multiloader/demo.gif?raw=true" /></center>
- **Require Hoe**: whether a hoe is required to harvest crops (_default: false_).
- **Harvest in Radius**: whether to harvest crops in a bigger radius as the 'tier' of hoe used increases (_default: true_).
- **Hunger Level**: the amount of hunger to require when harvesting, or none (_default: none_).
- **Experience Type**: whether to consume or reward XP points for harvesting (_default: none_).
- **Show Server Warning**: whether to display a warning when connecting to a server which does not have RightClickHarvest installed, as the mod will not work (_default: true_).

<center>
<a href="https://curseforge.com/minecraft/mc-mods/rightclickharvest"><img alt="Download on Curseforge" height="20" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg"></a>
<a href="https://docs.jamalam.tech/right-click-harvest/about/"><img alt="Read the Documentation" height="20" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/ghpages_vector.svg"/> </a>
<a href="https://modrinth.com/mod/rightclickharvest"><img alt="Download on Modrinth" height="20" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg"></a>
</center>
There are also a number of block and item tags available to customise the mod's behaviour, documented [here](https://docs.jamalam.tech/right-click-harvest/tags/).

<img alt="Features of RightClickHarvest" src="https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_BANNER2.webp" />
<h2 align="center">FAQ</h2>

- Harvest your crops with ease.
- Harvest all vanilla crops, including cocoa beans and sugar cane.
- Harvest 99% of modded crops without configuration.
- Configure if a hoe is required and whether harvesting uses hunger points.
- Configure whether higher tier hoes harvest in a larger radius.
- **Does this work client-side?** No, RightClickHarvest **must** be installed on the server and can **optionally** be installed on the client.
- **How do I configure the mod?** On Fabric, make sure ModMenu is installed. From there, you can simply access the config through the mods menu on both platforms. For servers, edit `config/rightclickharvest.json5`.
- **The mod isn't working.** The most common issue is that **Require Hoe** is set to `true` in the config, meaning that you have to be holding a hoe to harvest crops.
- **Can you update to [version]?** The versions I currently support for all of my mods are documented [here](https://docs.jamalam.tech/supported-versions/). If the version you want is not listed, the answer is probably no.
- **How do I make the mod work with crops from Supplementaries?** A compatibility mod is available: [Curseforge](https://www.curseforge.com/minecraft/mc-mods/rightclickharvest-supplementaries-compat), [Modrinth](https://modrinth.com/mod/rch-supplementaries-compat)
- **What are the dependencies of this mod?** Architectury API and JamLib are required, as well as Fabric API on Fabric.

<h3 align="center">For any questions not listed above, please join the Discord by clicking on the banner below.</h3>

<h3 align="center">Please report any bugs to the <a href="https://github.com/JamCoreModding/right-click-harvest">GitHub page</a>.</h3>

<a href="https://discord.jamalam.tech"><img alt="Join the Discord" src="https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_BANNER3.webp" /></a>

<a href="https://bisecthosting.com/jamalam"><img alt="Rent a Server (25% off with code JAMALAM)" src="https://www.bisecthosting.com/images/CF/RightClickHarvest/BH_RH_PROMO.webp" /></a>
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public class Config implements ConfigExtensions<Config> {

public boolean requireHoe = false;
public boolean harvestInRadius = true;
public HungerLevel hungerLevel = HungerLevel.NORMAL;
public HungerLevel hungerLevel = HungerLevel.NONE;
public ExperienceType experienceType = ExperienceType.NONE;
public boolean showServerWarning = true;
@Comment("Modpack developers, set this to true to stop RCH telling users that they probably need to equip a hoe to harvest crops (if requireHoe is set to true). This message will only be displayed once.")
Expand Down

0 comments on commit cf5a69e

Please sign in to comment.