Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
@RubixDev
RubixDev committed Mar 8, 2021
1 parent 37f74ca commit bfb2b52
Show file tree
Hide file tree
Showing 8 changed files with 136 additions and 32 deletions.
41 changes: 36 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,21 @@ Extension Mod for [gnembon's fabric-carpet](https://github.com/gnembon/fabric-ca
## Lists of Categories
- [`BUGFIX`](markdown/BUGFIX_Category.md)
- [`CLIENT`](markdown/CLIENT_Category.md)
- [`COMMAND`](markdown/COMMAND_Category.md)
- [`CRAFTING`](markdown/CRAFTING_Category.md)
- [`CREATIVE`](markdown/CREATIVE_Category.md)
- [`EXPERIMENTAL`](markdown/EXPERIMENTAL_Category.md)
- [`FEATURE`](markdown/FEATURE_Category.md)
- [`SURVIVAL`](markdown/SURVIVAL_Category.md)

## Index
Count: 64
Count: 67
- [anvilledBlueIce](#anvilledblueice)
- [anvilledIce](#anvilledice)
- [anvilledPackedIce](#anvilledpackedice)
- [cactusFurnaceXp](#cactusfurnacexp)
- [campSleeping](#campsleeping)
- [commandSlimeChunk](#commandslimechunk)
- [concreteConvertOnCauldron](#concreteconvertoncauldron)
- [craftableCobwebs](#craftablecobwebs)
- [craftableHorseArmor](#craftablehorsearmor)
Expand Down Expand Up @@ -56,6 +58,7 @@ Count: 64
- [kelpBlockHardness](#kelpblockhardness)
- [lilyPadsOnCauldron](#lilypadsoncauldron)
- [longerRepeaters](#longerrepeaters)
- [maxBannerLayers](#maxbannerlayers)
- [moreBarkCrafting](#morebarkcrafting)
- [moreFortressSpawningBlocks](#morefortressspawningblocks)
- [newShulkerBehavior](#newshulkerbehavior)
Expand All @@ -77,6 +80,7 @@ Count: 64
- [snowballWaterDrag](#snowballwaterdrag)
- [stonecutterDamage](#stonecutterdamage)
- [strictShulkerShells](#strictshulkershells)
- [tallPlantNoUpdate](#tallplantnoupdate)
- [universalDyeing](#universaldyeing)
- [unpackableIce](#unpackableice)
- [unpackableNetherWart](#unpackablenetherwart)
Expand Down Expand Up @@ -135,6 +139,14 @@ Allows players to sleep in a Bed without setting their spawn point by entering w
- Required options: `true`, `false`
- Categories: `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`

### commandSlimeChunk
A command that shows if the current chunk is a slime chunk based on the set slimeChunkPercentage
Players do not need extra permissions to use this command
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `COMMAND`, `RUG`

### concreteConvertOnCauldron
Concrete powder converts to concrete blocks when on top of a filled cauldron
- Type: `boolean`
Expand Down Expand Up @@ -175,7 +187,7 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### dragonDrops
Ender Dragon drops an Elytra when killed
Ender Dragon drops selected item(s) when killed
- Type: `String`
- Default value: `none`
- Required options: `none`, `dragon_egg`, `elytra`, `both`
Expand All @@ -195,7 +207,7 @@ Amount of XP dropped by later Dragons. The first Dragon always drops 12000
- Type: `int`
- Default value: `500`
- Suggested options: `500`, `1200`, `12000`
- Categories: `CLIENT`, `EXPERIMENTAL`, `RUG`
- Categories: `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 0 to 12000
- [Idea from Neubulae](https://github.com/gnembon/carpet-extra/issues/171)
Expand Down Expand Up @@ -380,12 +392,23 @@ Lily Pads can be placed on Cauldrons
- Categories: `FEATURE`, `RUG`

### longerRepeaters
Repeaters on top of Redstone BLocks multiply their delay by set amount
Repeaters on top of Redstone Blocks multiply their delay by set amount
- Type: `int`
- Default value: `1`
- Required options: `1`, `2`, `3`, `4`
- Categories: `EXPERIMENTAL`, `FEATURE`, `RUG`

### 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
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
- Categories: `CLIENT`, `CRAFTING`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 3 to 16
- [Idea from SouthernPixel](https://github.com/gnembon/carpet-extra/issues/111)

### moreBarkCrafting
Crafting Logs to Wood gives 4 instead of 3
Expect a lag spike when changing the value
Expand All @@ -396,7 +419,7 @@ Expect a lag spike when changing the value

### moreFortressSpawningBlocks
What blocks Fortress mobs can spawn on inside the bigger Bounding Box
o
off: nether bricks only / more: (red) nether bricks, netherrack, soul sand/soil, packed/blue ice, gravel, magma blocks / all: all
- Type: `String`
- Default value: `off`
- Required options: `off`, `more`, `all`
Expand Down Expand Up @@ -566,6 +589,14 @@ Shulkers always drop a given amount of shulker shells when killed
- You must choose a value from 0 to 4
- Idea from [VanillaTweaks](https://vanillatweaks.net/picker/datapacks/)

### tallPlantNoUpdate
Tall Plants do not update blocks around the top part if the bottom half got broken
Old Bug: MC-31038
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `EXPERIMENTAL`, `RUG`

### universalDyeing
Allows to dye already dyed things and clean Glass, Glass Panes and Terracotta with a Water Bucket in the Crafting Table
Expect a lag spike when changing the value
Expand Down
23 changes: 12 additions & 11 deletions markdown/CLIENT_Category.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
For a list of all implemented Rules go [here](../README.md)
## Index
Count: 11
- [dragonXpDrop](#dragonxpdrop)
- [edibleGoldIngots](#ediblegoldingots)
- [edibleMagmaCream](#ediblemagmacream)
- [edibleNetheriteScraps](#ediblenetheritescraps)
Expand All @@ -12,21 +11,12 @@ Count: 11
- [enderPearlWaterDrag](#enderpearlwaterdrag)
- [honeyCombStickiness](#honeycombstickiness)
- [kelpBlockHardness](#kelpblockhardness)
- [maxBannerLayers](#maxbannerlayers)
- [reachDistance](#reachdistance)
- [snowballWaterDrag](#snowballwaterdrag)

## Rules in CLIENT Category

### dragonXpDrop
Amount of XP dropped by later Dragons. The first Dragon always drops 12000
- Type: `int`
- Default value: `500`
- Suggested options: `500`, `1200`, `12000`
- Categories: `CLIENT`, `EXPERIMENTAL`, `RUG`
- Additional notes:
- You must choose a value from 0 to 12000
- [Idea from Neubulae](https://github.com/gnembon/carpet-extra/issues/171)

### edibleGoldIngots
Butter is finally edible. Keep in mind 250g of pure butter are not that healthy
Works server side only, but eating animation is only rendered if the mod is on the client too
Expand Down Expand Up @@ -99,6 +89,17 @@ Any value other than 0 will behave like 0.5 for clients without this mod
- Additional notes:
- You must choose a value from 0 to 0.5

### 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
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
- Categories: `CLIENT`, `CRAFTING`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- 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
Expand Down
16 changes: 16 additions & 0 deletions markdown/COMMAND_Category.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# List of Rules in the COMMAND Category

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 1
- [commandSlimeChunk](#commandslimechunk)

## Rules in COMMAND Category

### commandSlimeChunk
A command that shows if the current chunk is a slime chunk based on the set slimeChunkPercentage
Players do not need extra permissions to use this command
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `COMMAND`, `RUG`
14 changes: 13 additions & 1 deletion markdown/CRAFTING_Category.md
View file
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: 21
Count: 22
- [craftableCobwebs](#craftablecobwebs)
- [craftableHorseArmor](#craftablehorsearmor)
- [craftableNameTags](#craftablenametags)
Expand All @@ -15,6 +15,7 @@ Count: 21
- [easyRepeaterCrafting](#easyrepeatercrafting)
- [easyStickCrafting](#easystickcrafting)
- [easyTrappedChestCrafting](#easytrappedchestcrafting)
- [maxBannerLayers](#maxbannerlayers)
- [moreBarkCrafting](#morebarkcrafting)
- [powderToGlassSmelting](#powdertoglasssmelting)
- [shapelessCrafting](#shapelesscrafting)
Expand Down Expand Up @@ -125,6 +126,17 @@ Expect a lag spike when changing the value
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### 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
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
- Categories: `CLIENT`, `CRAFTING`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 3 to 16
- [Idea from SouthernPixel](https://github.com/gnembon/carpet-extra/issues/111)

### moreBarkCrafting
Crafting Logs to Wood gives 4 instead of 3
Expect a lag spike when changing the value
Expand Down
29 changes: 25 additions & 4 deletions markdown/EXPERIMENTAL_Category.md
View file
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: 28
Count: 30
- [anvilledBlueIce](#anvilledblueice)
- [anvilledIce](#anvilledice)
- [anvilledPackedIce](#anvilledpackedice)
Expand All @@ -21,6 +21,7 @@ Count: 28
- [infinityNeedsArrow](#infinityneedsarrow)
- [kelpBlockHardness](#kelpblockhardness)
- [longerRepeaters](#longerrepeaters)
- [maxBannerLayers](#maxbannerlayers)
- [moreFortressSpawningBlocks](#morefortressspawningblocks)
- [newShulkerBehavior](#newshulkerbehavior)
- [peacefulHunger](#peacefulhunger)
Expand All @@ -30,6 +31,7 @@ Count: 28
- [silkTouchSpawners](#silktouchspawners)
- [slimeChunkPercentage](#slimechunkpercentage)
- [snowballWaterDrag](#snowballwaterdrag)
- [tallPlantNoUpdate](#tallplantnoupdate)
- [zeroTickPlants](#zerotickplants)

## Rules in EXPERIMENTAL Category
Expand Down Expand Up @@ -83,7 +85,7 @@ Amount of XP dropped by later Dragons. The first Dragon always drops 12000
- Type: `int`
- Default value: `500`
- Suggested options: `500`, `1200`, `12000`
- Categories: `CLIENT`, `EXPERIMENTAL`, `RUG`
- Categories: `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 0 to 12000
- [Idea from Neubulae](https://github.com/gnembon/carpet-extra/issues/171)
Expand Down Expand Up @@ -186,15 +188,26 @@ Any value other than 0 will behave like 0.5 for clients without this mod
- You must choose a value from 0 to 0.5

### longerRepeaters
Repeaters on top of Redstone BLocks multiply their delay by set amount
Repeaters on top of Redstone Blocks multiply their delay by set amount
- Type: `int`
- Default value: `1`
- Required options: `1`, `2`, `3`, `4`
- Categories: `EXPERIMENTAL`, `FEATURE`, `RUG`

### 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
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
- Categories: `CLIENT`, `CRAFTING`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 3 to 16
- [Idea from SouthernPixel](https://github.com/gnembon/carpet-extra/issues/111)

### moreFortressSpawningBlocks
What blocks Fortress mobs can spawn on inside the bigger Bounding Box
o
off: nether bricks only / more: (red) nether bricks, netherrack, soul sand/soil, packed/blue ice, gravel, magma blocks / all: all
- Type: `String`
- Default value: `off`
- Required options: `off`, `more`, `all`
Expand Down Expand Up @@ -270,6 +283,14 @@ Thrown Snowball will stutter on client when mod is only on server
- Additional notes:
- You must choose a value from 0.5 to 0.99

### tallPlantNoUpdate
Tall Plants do not update blocks around the top part if the bottom half got broken
Old Bug: MC-31038
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `EXPERIMENTAL`, `RUG`

### zeroTickPlants
Brings back the ability to force grow certain plants using 0-ticks
- Type: `boolean`
Expand Down
6 changes: 3 additions & 3 deletions markdown/FEATURE_Category.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Concrete powder converts to concrete blocks when on top of a filled cauldron
- Categories: `FEATURE`, `RUG`

### dragonDrops
Ender Dragon drops an Elytra when killed
Ender Dragon drops selected item(s) when killed
- Type: `String`
- Default value: `none`
- Required options: `none`, `dragon_egg`, `elytra`, `both`
Expand Down Expand Up @@ -169,15 +169,15 @@ Lily Pads can be placed on Cauldrons
- Categories: `FEATURE`, `RUG`

### longerRepeaters
Repeaters on top of Redstone BLocks multiply their delay by set amount
Repeaters on top of Redstone Blocks multiply their delay by set amount
- Type: `int`
- Default value: `1`
- Required options: `1`, `2`, `3`, `4`
- Categories: `EXPERIMENTAL`, `FEATURE`, `RUG`

### moreFortressSpawningBlocks
What blocks Fortress mobs can spawn on inside the bigger Bounding Box
o
off: nether bricks only / more: (red) nether bricks, netherrack, soul sand/soil, packed/blue ice, gravel, magma blocks / all: all
- Type: `String`
- Default value: `off`
- Required options: `off`, `more`, `all`
Expand Down
27 changes: 25 additions & 2 deletions markdown/SURVIVAL_Category.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 46
Count: 48
- [cactusFurnaceXp](#cactusfurnacexp)
- [campSleeping](#campsleeping)
- [craftableCobwebs](#craftablecobwebs)
- [craftableHorseArmor](#craftablehorsearmor)
- [craftableNameTags](#craftablenametags)
- [craftableNotchApple](#craftablenotchapple)
- [dragonDrops](#dragondrops)
- [dragonXpDrop](#dragonxpdrop)
- [easyBlueIceCrafting](#easyblueicecrafting)
- [easyBoneBlockCrafting](#easyboneblockcrafting)
- [easyChestCrafting](#easychestcrafting)
Expand All @@ -27,6 +28,7 @@ Count: 46
- [foodInstantHeal](#foodinstantheal)
- [infinityNeedsArrow](#infinityneedsarrow)
- [kelpBlockHardness](#kelpblockhardness)
- [maxBannerLayers](#maxbannerlayers)
- [moreBarkCrafting](#morebarkcrafting)
- [noCreeperGriefing](#nocreepergriefing)
- [noEndermanGriefing](#noendermangriefing)
Expand Down Expand Up @@ -102,14 +104,24 @@ Expect a lag spike when changing the value
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### dragonDrops
Ender Dragon drops an Elytra when killed
Ender Dragon drops selected item(s) when killed
- Type: `String`
- Default value: `none`
- Required options: `none`, `dragon_egg`, `elytra`, `both`
- Categories: `FEATURE`, `RUG`, `SURVIVAL`
- Additional notes:
- Idea from [VanillaTweaks](https://vanillatweaks.net/picker/datapacks/)

### dragonXpDrop
Amount of XP dropped by later Dragons. The first Dragon always drops 12000
- Type: `int`
- Default value: `500`
- Suggested options: `500`, `1200`, `12000`
- Categories: `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 0 to 12000
- [Idea from Neubulae](https://github.com/gnembon/carpet-extra/issues/171)

### easyBlueIceCrafting
Blue Ice can be crafted from Ice and Blue Dye
Expect a lag spike when changing the value
Expand Down Expand Up @@ -252,6 +264,17 @@ Any value other than 0 will behave like 0.5 for clients without this mod
- Additional notes:
- You must choose a value from 0 to 0.5

### 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
- Type: `int`
- Default value: `6`
- Suggested options: `3`, `6`, `10`, `12`
- Categories: `CLIENT`, `CRAFTING`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
- Additional notes:
- You must choose a value from 3 to 16
- [Idea from SouthernPixel](https://github.com/gnembon/carpet-extra/issues/111)

### moreBarkCrafting
Crafting Logs to Wood gives 4 instead of 3
Expect a lag spike when changing the value
Expand Down
Loading

0 comments on commit bfb2b52

Please sign in to comment.