Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
RubixDev committed Mar 17, 2021
1 parent d3359b4 commit 12263f4
Show file tree
Hide file tree
Showing 4 changed files with 234 additions and 4 deletions.
76 changes: 75 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,18 @@ Extension Mod for [gnembon's fabric-carpet](https://github.com/gnembon/fabric-ca
- [`SURVIVAL`](markdown/SURVIVAL_Category.md)

## Index
Count: 80
Count: 88
- [anvilledBlueIce](#anvilledblueice)
- [anvilledIce](#anvilledice)
- [anvilledPackedIce](#anvilledpackedice)
- [basaltToBlackstoneConversion](#basalttoblackstoneconversion)
- [basaltToLavaConversion](#basalttolavaconversion)
- [blastFurnaceGlass](#blastfurnaceglass)
- [blastFurnaceGlazedTerracotta](#blastfurnaceglazedterracotta)
- [blastFurnaceNetherBrick](#blastfurnacenetherbrick)
- [blastFurnaceSmoothQuartz](#blastfurnacesmoothquartz)
- [blastFurnaceSmoothSandStone](#blastfurnacesmoothsandstone)
- [blastFurnaceStone](#blastfurnacestone)
- [cactusFurnaceXp](#cactusfurnacexp)
- [campSleeping](#campsleeping)
- [cobbleCrushing](#cobblecrushing)
Expand Down Expand Up @@ -90,6 +96,8 @@ Count: 80
- [silkTouchPathBlocks](#silktouchpathblocks)
- [silkTouchSpawners](#silktouchspawners)
- [slimeChunkPercentage](#slimechunkpercentage)
- [smokerGreenDye](#smokergreendye)
- [smokerLimeDye](#smokerlimedye)
- [snowballWaterDrag](#snowballwaterdrag)
- [stonecutterDamage](#stonecutterdamage)
- [strictShulkerShells](#strictshulkershells)
Expand Down Expand Up @@ -150,6 +158,56 @@ Basalt converts to a Lava source when placed (or moved) next to a Lava Source, F
- Required options: `true`, `false`
- Categories: `FEATURE`, `RENEWABLE`, `RUG`, `SURVIVAL`

### blastFurnaceGlass
Sand and Red Sand can be smelted to Glass Blocks in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceGlazedTerracotta
Dyed Terracotta can be smelted to the corresponding Glazed Terracotta in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceNetherBrick
Netherrack can be smelted to Nether Brick in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothQuartz
Quartz Blocks can be smelted to Smooth Quartz in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothSandStone
Sandstone and Red Sandstone can be smelted to the smooth variant in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceStone
Cobblestone to Stone to Smooth Stone can be smelted in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
- Additional notes:
- [Suggestion from Philipp766](https://github.com/RubixDev/fabric-rug/issues/15)

### cactusFurnaceXp
Amount of XP a Cactus smelted in a furnace gives
1 XP per Cactus seems to be a bug, as in Bedrock Edition it's only 0.2, which fits more in line with other items
Expand Down Expand Up @@ -661,6 +719,22 @@ The percentage of chunks that are Slime chinks
- You must choose a value from 0 to 100 that is a multiple of 10
- [Idea from Philipp766](https://github.com/gnembon/carpet-extra/issues/161)

### smokerGreenDye
Cacti can be cooked into Green Dye in a Smoker. XP override of cactusFurnaceXp still applies
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### smokerLimeDye
Sea Pickles can be cooked into Lime Dye in a Smoker
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### snowballWaterDrag
How fast thrown Snowballs can travel under water. 0.99 is the default for above water and for Tridents
Thrown Snowball will stutter on client when mod is only on server
Expand Down
76 changes: 75 additions & 1 deletion markdown/CRAFTING_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 22
Count: 30
- [blastFurnaceGlass](#blastfurnaceglass)
- [blastFurnaceGlazedTerracotta](#blastfurnaceglazedterracotta)
- [blastFurnaceNetherBrick](#blastfurnacenetherbrick)
- [blastFurnaceSmoothQuartz](#blastfurnacesmoothquartz)
- [blastFurnaceSmoothSandStone](#blastfurnacesmoothsandstone)
- [blastFurnaceStone](#blastfurnacestone)
- [craftableCobwebs](#craftablecobwebs)
- [craftableHorseArmor](#craftablehorsearmor)
- [craftableNameTags](#craftablenametags)
Expand All @@ -19,6 +25,8 @@ Count: 22
- [moreBarkCrafting](#morebarkcrafting)
- [powderToGlassSmelting](#powdertoglasssmelting)
- [shapelessCrafting](#shapelesscrafting)
- [smokerGreenDye](#smokergreendye)
- [smokerLimeDye](#smokerlimedye)
- [universalDyeing](#universaldyeing)
- [unpackableIce](#unpackableice)
- [unpackableNetherWart](#unpackablenetherwart)
Expand All @@ -28,6 +36,56 @@ Count: 22

## Rules in CRAFTING Category

### blastFurnaceGlass
Sand and Red Sand can be smelted to Glass Blocks in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceGlazedTerracotta
Dyed Terracotta can be smelted to the corresponding Glazed Terracotta in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceNetherBrick
Netherrack can be smelted to Nether Brick in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothQuartz
Quartz Blocks can be smelted to Smooth Quartz in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothSandStone
Sandstone and Red Sandstone can be smelted to the smooth variant in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceStone
Cobblestone to Stone to Smooth Stone can be smelted in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
- Additional notes:
- [Suggestion from Philipp766](https://github.com/RubixDev/fabric-rug/issues/15)

### craftableCobwebs
Cobwebs can be crafted with 5 Strings in a cross pattern or with a 3x3 full area
Expect a lag spike when changing the value
Expand Down Expand Up @@ -165,6 +223,22 @@ Expect a lag spike when changing the value
- Additional notes:
- Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)

### smokerGreenDye
Cacti can be cooked into Green Dye in a Smoker. XP override of cactusFurnaceXp still applies
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### smokerLimeDye
Sea Pickles can be cooked into Lime Dye in a Smoker
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### 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
76 changes: 75 additions & 1 deletion markdown/SURVIVAL_Category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

For a list of all implemented Rules go [here](../README.md)
## Index
Count: 56
Count: 64
- [basaltToBlackstoneConversion](#basalttoblackstoneconversion)
- [basaltToLavaConversion](#basalttolavaconversion)
- [blastFurnaceGlass](#blastfurnaceglass)
- [blastFurnaceGlazedTerracotta](#blastfurnaceglazedterracotta)
- [blastFurnaceNetherBrick](#blastfurnacenetherbrick)
- [blastFurnaceSmoothQuartz](#blastfurnacesmoothquartz)
- [blastFurnaceSmoothSandStone](#blastfurnacesmoothsandstone)
- [blastFurnaceStone](#blastfurnacestone)
- [cactusFurnaceXp](#cactusfurnacexp)
- [campSleeping](#campsleeping)
- [cobbleCrushing](#cobblecrushing)
Expand Down Expand Up @@ -49,6 +55,8 @@ Count: 56
- [silkTouchFarmland](#silktouchfarmland)
- [silkTouchPathBlocks](#silktouchpathblocks)
- [silkTouchSpawners](#silktouchspawners)
- [smokerGreenDye](#smokergreendye)
- [smokerLimeDye](#smokerlimedye)
- [stonecutterDamage](#stonecutterdamage)
- [strictShulkerShells](#strictshulkershells)
- [universalDyeing](#universaldyeing)
Expand Down Expand Up @@ -76,6 +84,56 @@ Basalt converts to a Lava source when placed (or moved) next to a Lava Source, F
- Required options: `true`, `false`
- Categories: `FEATURE`, `RENEWABLE`, `RUG`, `SURVIVAL`

### blastFurnaceGlass
Sand and Red Sand can be smelted to Glass Blocks in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceGlazedTerracotta
Dyed Terracotta can be smelted to the corresponding Glazed Terracotta in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceNetherBrick
Netherrack can be smelted to Nether Brick in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothQuartz
Quartz Blocks can be smelted to Smooth Quartz in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceSmoothSandStone
Sandstone and Red Sandstone can be smelted to the smooth variant in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### blastFurnaceStone
Cobblestone to Stone to Smooth Stone can be smelted in a Blast Furnace
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
- Additional notes:
- [Suggestion from Philipp766](https://github.com/RubixDev/fabric-rug/issues/15)

### cactusFurnaceXp
Amount of XP a Cactus smelted in a furnace gives
1 XP per Cactus seems to be a bug, as in Bedrock Edition it's only 0.2, which fits more in line with other items
Expand Down Expand Up @@ -438,6 +496,22 @@ Mining Spawners with a Silk Touch tool will drop itself
- Required options: `true`, `false`
- Categories: `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`

### smokerGreenDye
Cacti can be cooked into Green Dye in a Smoker. XP override of cactusFurnaceXp still applies
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### smokerLimeDye
Sea Pickles can be cooked into Lime Dye in a Smoker
Expect a lag spike when changing the value
- Type: `boolean`
- Default value: `false`
- Required options: `true`, `false`
- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

### stonecutterDamage
How much damage Stonecutters deal when stepping on them
- Type: `int`
Expand Down
10 changes: 9 additions & 1 deletion markdown/curseforge.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ Extension Mod for [gnembon's fabric-carpet](https://github.com/gnembon/fabric-ca
**Visit the [GitHub page](https://github.com/RubixDev/fabric-rug) for a more detailed explanation of all features.**

## List of implemented Carpet Rules
Count: 80
Count: 88
- anvilledBlueIce
- anvilledIce
- anvilledPackedIce
- basaltToBlackstoneConversion
- basaltToLavaConversion
- blastFurnaceGlass
- blastFurnaceGlazedTerracotta
- blastFurnaceNetherBrick
- blastFurnaceSmoothQuartz
- blastFurnaceSmoothSandStone
- blastFurnaceStone
- cactusFurnaceXp
- campSleeping
- cobbleCrushing
Expand Down Expand Up @@ -73,6 +79,8 @@ Count: 80
- silkTouchPathBlocks
- silkTouchSpawners
- slimeChunkPercentage
- smokerGreenDye
- smokerLimeDye
- snowballWaterDrag
- stonecutterDamage
- strictShulkerShells
Expand Down

0 comments on commit 12263f4

Please sign in to comment.