Skip to content

Commit 5c2471a

Browse files
MichaelHillcoxMichaelHillcox
committed
feat: updated readme
1 parent c13a318 commit 5c2471a

File tree

1 file changed

+126
-1
lines changed

1 file changed

+126
-1
lines changed

‎README.md

Lines changed: 126 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,126 @@
1-
# Squatgrow
1+
# SquatGrow
2+
3+
SquatGrow is a mod that allows you to grow crops by squatting on them in a highly configurable way.
4+
5+
[![CurseForge](https://cf.way2muchnoise.eu/515698.svg)](https://www.curseforge.com/minecraft/mc-mods/squat-grow)
6+
[![CurseForge](https://cf.way2muchnoise.eu/versions/515698.svg)](https://www.curseforge.com/minecraft/mc-mods/squat-grow)
7+
[![Modrinth](https://img.shields.io/modrinth/dt/b5JMdB5V)](https://modrinth.com/mod/squat-grow)
8+
[![Modrinth](https://img.shields.io/modrinth/game-versions/b5JMdB5V)](https://modrinth.com/mod/squat-grow)
9+
10+
> Feeling weak in Minecraft and not getting enough gains? Well throw away your bonemeal and start squatting!
11+
>
12+
> With Squat Grow your plant will grow twice as fast and feel the gains!
13+
>
14+
> All you need to do is press your sneak key until you are happy with the growth of your plant.
15+
>
16+
> You can configure the plants affected using the registry name of the plant or using tags, there is also an option to use a blacklist or a whitelist along with changing the effect range
17+
18+
Get the mod on [CurseForge](https://www.curseforge.com/minecraft/mc-mods/squat-grow) or [Modrinth](https://modrinth.com/mod/squat-grow)
19+
20+
## Features
21+
22+
- Grow crops by squatting on them
23+
- Configurable growth chances
24+
- Configurable growth multipliers
25+
- Configurable requirements for growth
26+
- Sort of API for other mods to add custom squat actions
27+
- You can see an example of this via the `actions.special.DirtToGrassAction` class
28+
- Special actions for certain blocks
29+
- Grass block in offhand to quickly convert dirt to grass
30+
- Mod integration
31+
- AE2 Crystals
32+
- Mystical Agriculture Crops
33+
34+
## Dependencies
35+
36+
- [Architectury](https://www.curseforge.com/minecraft/mc-mods/architectury-api)
37+
- [Cloth Config](https://www.curseforge.com/minecraft/mc-mods/cloth-config)
38+
39+
## Configuration
40+
41+
The configuration file is located at `config/squatgrow-common.yaml` and is generated when you first run the game with the mod installed.
42+
43+
### Options
44+
45+
#### Example Configuration
46+
47+
```yaml
48+
ae2Multiplier: 4
49+
allowAdventureTwerking: true
50+
chance: 1.0
51+
debug: false
52+
enableAE2Accelerator: true
53+
enableDirtToGrass: true
54+
enableMysticalCrops: true
55+
hoeTakesDamage: false
56+
ignoreList: ['minecraft:grass_block', 'minecraft:grass', 'minecraft:tall_grass', 'minecraft:netherrack', 'minecraft:warped_nylium', 'minecraft:crimson_nylium']
57+
randomTickMultiplier: 4
58+
range: 16
59+
requireHoe: false
60+
requirements:
61+
durabilityDamage: 1
62+
enabled: false
63+
equipmentRequirement:
64+
HEAD: 'minecraft:iron_helmet'
65+
heldItemRequirement: ["minecraft:diamond_hoe", "minecraft:golden_hoe"]
66+
requiredEnchantment: ''
67+
requiredItemTakesDamage: false
68+
sugarcaneMultiplier: 4
69+
useWhitelist: false
70+
```
71+
72+
#### Options
73+
74+
| Option | Description | Default |
75+
| ------ |----------------------------------------------------------------------------------------------------------|-----------|
76+
| `chance` | The chance for growth to occur | `1.0` |
77+
| `allowAdventureTwerking` | Whether or not to allow adventure twerking | `true` |
78+
| `enableDirtToGrass` | Whether or not to enable dirt to grass conversion when a grass block is in your offhand | `true` |
79+
| `enableMysticalCrops` | Whether or not to enable mystical agriculture crop growth | `true` |
80+
| `sugarcaneMultiplier` | The multiplier for sugarcane growth | `4` |
81+
| `randomTickMultiplier` | The multiplier for random ticks for blocks that grow via random ticks | `4` |
82+
| `range` | The range in which to check for blocks to grow | `16` |
83+
| `debug` | Whether or not to enable debug mode | `false` |
84+
| `requireHoe` | Whether or not to require a hoe to be held to grow crops (Depercated, please do not use) | `false` |
85+
| `hoeTakesDamage` | Whether or not to take damage when using a hoe to grow crops (Depercated, please do not use) | `false` |
86+
| `useWhitelist` | Whether or not to use a whitelist or blacklist for blocks to grow | `false` |
87+
| `ignoreList` | A list of blocks to ignore when growing crops (When whitelist is enabled, this is used as the whitelist) | See above |
88+
89+
### Requirements
90+
91+
The requirements system is a new system that allows you to require certain items to be held or equipment to be worn to grow crops.
92+
93+
| Option | Description | Default |
94+
| ------ |----------------------------------------------------------------------------------------------------------|-----------|
95+
| `requirements` | The requirements system for growing crops | See above |
96+
| `requirements.enabled` | Whether or not to enable the requirements system | `false` |
97+
| `requirements.heldItemRequirement` | A list of items that are required to be held to grow crops | `[]` |
98+
| `requirements.equipmentRequirement` | A map of equipment slots to items that are required to be worn to grow crops | `{}` |
99+
| `requirements.requiredEnchantment` | The enchantment that is required to grow crops | `''` |
100+
| `requirements.requiredItemTakesDamage` | Whether or not the required item takes damage when growing crops | `false` |
101+
| `requirements.durabilityDamage` | The amount of damage to take when growing crops | `1` |
102+
103+
##### Integration Options
104+
105+
| Option | Description | Default |
106+
| ------ |----------------------------------------------------------------------------------------| ------- |
107+
| `enableAE2Accelerator` | Whether or not to enable AE2 growth acceleration | `true` |
108+
| `ae2Multiplier` | The multiplier for AE2 growth | `4` |
109+
| `enableMysticalCrops` | Whether or not to enable mystical agriculture crop growth | `true` |
110+
111+
### Item special handling
112+
113+
For any config value that supports items, you can use the following format:
114+
115+
- `#<modid>:<item>` - This will be converted to an item tag upon loading the config
116+
- `<modid>:<item>` - This will be converted to an item upon loading the config
117+
118+
## License
119+
120+
This mod is licensed under All Rights Reserved.
121+
122+
## Modpacks
123+
124+
You are free to use this mod in any modpack you want via **_CURSEFORGE_**. No need to ask for permission.
125+
126+
Distribution permission is given to Feed The Beast and Curseforge. You may not distribute this mod on any other platform without my permission.

0 commit comments

Comments
 (0)