Skip to content

Commit

Permalink
docs: update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
RubixDev committed Jan 8, 2025
1 parent 5c87d4e commit d760f77
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 73 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The project setup is based off of [Fallen-Breath's template](https://github.com/
- [`TNT`](markdown/TNT_Category.md)

## Index
Count: 100
Count: 99
- [anvilledBlueIce](#anvilledblueice)
- [anvilledIce](#anvilledice)
- [anvilledPackedIce](#anvilledpackedice)
Expand Down Expand Up @@ -101,7 +101,6 @@ Count: 100
- [peacefulHunger](#peacefulhunger)
- [playerHeadDrops](#playerheaddrops)
- [powderToGlassSmelting](#powdertoglasssmelting)
- [reachDistance](#reachdistance)
- [redstoneLampTurnOffDelay](#redstonelampturnoffdelay)
- [sculkBlocksAlwaysDropXp](#sculkblocksalwaysdropxp)
- [shapelessCrafting](#shapelesscrafting)
Expand Down Expand Up @@ -360,12 +359,12 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableHorseArmor
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks) or with armor_pieces
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks), with armor_pieces, or with wool (like in 13w16a)

Expect a lag spike when changing the value
- Type: `String`
- Default value: `off`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`, `with_wool`
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableNameTags
Expand Down Expand Up @@ -622,7 +621,8 @@ Repeaters on top of Redstone Blocks multiply their delay by set amount
### maxBannerLayers
Maximum number of layers, that can be applied to a banner

This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
Is disabled when [Infinite Banner Patterns](https://modrinth.com/mod/infinite-banner-patterns) is installed
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
Expand Down Expand Up @@ -733,18 +733,6 @@ Expect a lag spike when changing the value
- Additional notes:
- Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)

### reachDistance
Reach in which you can place and break blocks. Value will be 0.5 higher in creative

Mod needed on server and client for this feature to work
- Type: `double`
- Default value: `4.5`
- Suggested options: `0.0`, `4.5`, `5.0`, `10.0`
- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
- Additional notes:
- You must choose a value from 0 to 100
- Is disabled when [reach-entity-attributes](https://github.com/JamiesWhiteShirt/reach-entity-attributes) or [Pehkui](https://www.curseforge.com/minecraft/mc-mods/pehkui) is installed

### redstoneLampTurnOffDelay
Delay in game ticks for Redstone Lamps to turn off
- Type: `int`
Expand Down
18 changes: 3 additions & 15 deletions markdown/CLIENT_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 7
Count: 6
- [eggWaterDrag](#eggwaterdrag)
- [enderPearlWaterDrag](#enderpearlwaterdrag)
- [honeyCombStickiness](#honeycombstickiness)
- [kelpBlockHardness](#kelpblockhardness)
- [maxBannerLayers](#maxbannerlayers)
- [reachDistance](#reachdistance)
- [snowballWaterDrag](#snowballwaterdrag)

## Rules in CLIENT Category
Expand Down Expand Up @@ -60,7 +59,8 @@ Any value other than 0 will behave like 0.5 for clients without this mod
### maxBannerLayers
Maximum number of layers, that can be applied to a banner

This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
Is disabled when [Infinite Banner Patterns](https://modrinth.com/mod/infinite-banner-patterns) is installed
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
Expand All @@ -69,18 +69,6 @@ This only works for clients with this mod installed and the Banner tooltips neve
- You must choose a value from 3 to 16
- [Idea from SouthernPixel](https://github.com/gnembon/carpet-extra/issues/111)

### reachDistance
Reach in which you can place and break blocks. Value will be 0.5 higher in creative

Mod needed on server and client for this feature to work
- Type: `double`
- Default value: `4.5`
- Suggested options: `0.0`, `4.5`, `5.0`, `10.0`
- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
- Additional notes:
- You must choose a value from 0 to 100
- Is disabled when [reach-entity-attributes](https://github.com/JamiesWhiteShirt/reach-entity-attributes) or [Pehkui](https://www.curseforge.com/minecraft/mc-mods/pehkui) is installed

### snowballWaterDrag
How fast thrown Snowballs can travel underwater. 0.99 is the default for above water and for Tridents

Expand Down
7 changes: 4 additions & 3 deletions markdown/CRAFTING_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableHorseArmor
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks) or with armor_pieces
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks), with armor_pieces, or with wool (like in 13w16a)

Expect a lag spike when changing the value
- Type: `String`
- Default value: `off`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`, `with_wool`
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableNameTags
Expand Down Expand Up @@ -217,7 +217,8 @@ Expect a lag spike when changing the value
### maxBannerLayers
Maximum number of layers, that can be applied to a banner

This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
Is disabled when [Infinite Banner Patterns](https://modrinth.com/mod/infinite-banner-patterns) is installed
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
Expand Down
15 changes: 1 addition & 14 deletions markdown/CREATIVE_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,12 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 3
- [reachDistance](#reachdistance)
Count: 2
- [snowMelting](#snowmelting)
- [waterInNether](#waterinnether)

## Rules in CREATIVE Category

### reachDistance
Reach in which you can place and break blocks. Value will be 0.5 higher in creative

Mod needed on server and client for this feature to work
- Type: `double`
- Default value: `4.5`
- Suggested options: `0.0`, `4.5`, `5.0`, `10.0`
- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
- Additional notes:
- You must choose a value from 0 to 100
- Is disabled when [reach-entity-attributes](https://github.com/JamiesWhiteShirt/reach-entity-attributes) or [Pehkui](https://www.curseforge.com/minecraft/mc-mods/pehkui) is installed

### snowMelting
Whether snow can melt
- Type: `boolean`
Expand Down
18 changes: 3 additions & 15 deletions markdown/EXPERIMENTAL_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 30
Count: 29
- [anvilledBlueIce](#anvilledblueice)
- [anvilledIce](#anvilledice)
- [anvilledPackedIce](#anvilledpackedice)
Expand All @@ -24,7 +24,6 @@ Count: 30
- [moreFortressSpawningBlocks](#morefortressspawningblocks)
- [netherrackGeneration](#netherrackgeneration)
- [peacefulHunger](#peacefulhunger)
- [reachDistance](#reachdistance)
- [silkTouchBuddingAmethysts](#silktouchbuddingamethysts)
- [silkTouchFarmland](#silktouchfarmland)
- [silkTouchPathBlocks](#silktouchpathblocks)
Expand Down Expand Up @@ -187,7 +186,8 @@ Repeaters on top of Redstone Blocks multiply their delay by set amount
### maxBannerLayers
Maximum number of layers, that can be applied to a banner

This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
Is disabled when [Infinite Banner Patterns](https://modrinth.com/mod/infinite-banner-patterns) is installed
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
Expand Down Expand Up @@ -232,18 +232,6 @@ Players do not lose any hunger like in peaceful mode
- Additional notes:
- Suggestion by [real_zockerhopper](https://www.curseforge.com/members/real_zockerhopper)

### reachDistance
Reach in which you can place and break blocks. Value will be 0.5 higher in creative

Mod needed on server and client for this feature to work
- Type: `double`
- Default value: `4.5`
- Suggested options: `0.0`, `4.5`, `5.0`, `10.0`
- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
- Additional notes:
- You must choose a value from 0 to 100
- Is disabled when [reach-entity-attributes](https://github.com/JamiesWhiteShirt/reach-entity-attributes) or [Pehkui](https://www.curseforge.com/minecraft/mc-mods/pehkui) is installed

### silkTouchBuddingAmethysts
Mining Budding Amethysts with a Silk Touch tool will drop itself
- Type: `boolean`
Expand Down
4 changes: 2 additions & 2 deletions markdown/RENEWABLE_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableHorseArmor
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks) or with armor_pieces
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks), with armor_pieces, or with wool (like in 13w16a)

Expect a lag spike when changing the value
- Type: `String`
- Default value: `off`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`, `with_wool`
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableNotchApple
Expand Down
7 changes: 4 additions & 3 deletions markdown/SURVIVAL_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,12 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableHorseArmor
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks) or with armor_pieces
Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks), with armor_pieces, or with wool (like in 13w16a)

Expect a lag spike when changing the value
- Type: `String`
- Default value: `off`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`
- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`, `with_wool`
- Categories: `CRAFTING`, `RENEWABLE`, `RUG`, `SURVIVAL`

### craftableNameTags
Expand Down Expand Up @@ -386,7 +386,8 @@ Any value other than 0 will behave like 0.5 for clients without this mod
### maxBannerLayers
Maximum number of layers, that can be applied to a banner

This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
This only works for clients with this mod installed and the Banner tooltips never show more than 6 layers
Is disabled when [Infinite Banner Patterns](https://modrinth.com/mod/infinite-banner-patterns) is installed
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
Expand Down
3 changes: 1 addition & 2 deletions markdown/curseforge.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Extension for [gnembon's Carpet Mod](https://modrinth.com/mod/carpet) adding loa
If you encounter any issues, please let me know on [GitHub](https://github.com/RubixDev/Rug/issues).

## List of available Settings
Count: 100
Count: 99
- anvilledBlueIce
- anvilledIce
- anvilledPackedIce
Expand Down Expand Up @@ -78,7 +78,6 @@ Count: 100
- peacefulHunger
- playerHeadDrops
- powderToGlassSmelting
- reachDistance
- redstoneLampTurnOffDelay
- sculkBlocksAlwaysDropXp
- shapelessCrafting
Expand Down
3 changes: 1 addition & 2 deletions markdown/modrinth.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Extension for [gnembon's Carpet Mod](https://modrinth.com/mod/carpet) adding loa
If you encounter any issues, please let me know on [GitHub](https://github.com/RubixDev/Rug/issues).

## List of available settings
Count: 100
Count: 99
- anvilledBlueIce
- anvilledIce
- anvilledPackedIce
Expand Down Expand Up @@ -78,7 +78,6 @@ Count: 100
- peacefulHunger
- playerHeadDrops
- powderToGlassSmelting
- reachDistance
- redstoneLampTurnOffDelay
- sculkBlocksAlwaysDropXp
- shapelessCrafting
Expand Down

0 comments on commit d760f77

Please sign in to comment.