Merge pull request #4 from RubixDev/development

Release v1.1.1

generate_readme.py

@@ -1,3 +1,6 @@
+from typing import List
+
+
 class Rule:
     type: str
     name: str
@@ -12,6 +15,7 @@ class Rule:
 
     def __repr__(self):
         nl = '\n'
+        self.categories.sort()
         out = f'### {self.name}\n' \
               f'{self.desc}  {nl + self.extra if self.extra else ""}  \n' \
               f'- Type: `{self.type}`\n' \
@@ -28,7 +32,7 @@ def __repr__(self):
         return out
 
 
-def read_rules() -> list:
+def read_rules() -> List[Rule]:
     with open('src/main/java/com/rubixdev/rug/RugSettings.java', 'r') as settings_file:
         settings_string = settings_file.read()
     raw_settings = [i.split(';')[0] for i in settings_string.split('@Rule')[1:]]
@@ -39,7 +43,7 @@ def read_rules() -> list:
         field = raw_rule.split('\n')[-1][18:].split(' ')
         rule.type = field[0]
         rule.name = field[1]
-        rule.value = field[3]
+        rule.value = field[3].replace('"', '')
 
         keys = [i[12:].split(' = ')[0] for i in raw_rule.split('\n')[1:-2]]
         values = [i[12:].split(' = ')[1] for i in raw_rule.split('\n')[1:-2]]
@@ -63,7 +67,7 @@ def read_rules() -> list:
     return rules
 
 
-def write_file(rules: list):
+def write_file(rules: List[Rule]):
     with open('markdown/README-header.md', 'r') as header_file:
         out = header_file.read()
 
@@ -93,7 +97,7 @@ def write_file(rules: list):
             category_readme.write(out[:-1])
 
 
-def list_rules(rules: list, rule_headline: str) -> str:
+def list_rules(rules: List[Rule], rule_headline: str) -> str:
     out = f'## Index\n' \
            f'Count: {len(rules)}\n'
     for rule in rules:

gradle.properties

@@ -10,7 +10,7 @@ org.gradle.jvmargs=-Xmx2G
 	carpet_core_version=1.4.23+v210115
 
 # Mod Properties
-	mod_version = 1.1.0
+	mod_version = 1.1.1
 	maven_group = com.rubixdev.rug
 	archives_base_name = fabric-rug
 

markdown/BUGFIX_Category.md

@@ -15,7 +15,7 @@ Amount of XP a Cactus smelted in a furnace gives
 - Type: `double`
 - Default value: `1`
 - Suggested options: `0.1`, `0.2`, `0.5`, `1`
-- Categories: `BUGFIX`, `SURVIVAL`, `RUG`
+- Categories: `BUGFIX`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 1
 
@@ -24,13 +24,13 @@ A Bow enchanted with Infinity needs the player to have an arrow in his inventory
 - Type: `boolean`
 - Default value: `true`
 - Required options: `true`, `false`
-- Categories: `EXPERIMENTAL`, `BUGFIX`, `SURVIVAL`, `RUG`
+- Categories: `BUGFIX`, `EXPERIMENTAL`, `RUG`, `SURVIVAL`
 
 ### stonecutterDamage
 How much damage Stonecutters deal when stepping on them    
 - Type: `int`
 - Default value: `0`
 - Suggested options: `0`, `3`, `4`, `5`
-- Categories: `BUGFIX`, `SURVIVAL`, `RUG`
+- Categories: `BUGFIX`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 10

markdown/CLIENT_Category.md

@@ -2,11 +2,12 @@
 
 For a list of all implemented Rules go [here](../README.md)
 ## Index
-Count: 5
+Count: 6
 - [edibleGoldIngots](#ediblegoldingots)
 - [edibleMagmaCream](#ediblemagmacream)
 - [edibleNetheriteScraps](#ediblenetheritescraps)
 - [edibleSlimeBalls](#edibleslimeballs)
+- [honeyCombStickiness](#honeycombstickiness)
 - [reachDistance](#reachdistance)
 
 ## Rules in CLIENT Category
@@ -17,38 +18,48 @@ Works server side only, but eating animation is only rendered if the mod is on t
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `EXPERIMENTAL`, `FEATURE`, `SURVIVAL`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`
 
 ### edibleMagmaCream
 Magma Cream is edible and gives 10 seconds of Fire Resistance  
 Works server side only, but eating animation is only rendered if the mod is on the client too  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `EXPERIMENTAL`, `FEATURE`, `SURVIVAL`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`
 
 ### edibleNetheriteScraps
 Makes Netherite Scraps edible, because, let's be honest, they kinda look like chocolate  
 Works server side only, but eating animation is only rendered if the mod is on the client too  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `EXPERIMENTAL`, `FEATURE`, `SURVIVAL`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`
 
 ### edibleSlimeBalls
 Slime Balls are edible and give Jump Boost and Slowness  
 Works server side only, but eating animation is only rendered if the mod is on the client too  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `EXPERIMENTAL`, `FEATURE`, `SURVIVAL`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `EXPERIMENTAL`, `FEATURE`, `RUG`, `SURVIVAL`
+
+### honeyCombStickiness
+Honey Comb only sticks to selected Blocks  
+Will render Ghost Blocks on the Client when mod is only Server Side  
+- Type: `String`
+- Default value: `both`
+- Required options: `both`, `honey`, `slime`, `none`
+- Categories: `CLIENT`, `EXPERIMENTAL`, `FEATURE`, `RUG`
+- Additional notes:
+  - Suggestion by DragonEggBedrockBreaking#0034
 
 ### 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`, `4.5`, `5`, `10`
-- Categories: `EXPERIMENTAL`, `CREATIVE`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
 - Additional notes:
   - You must choose a value from 0 to 100

markdown/CRAFTING_Category.md

@@ -2,8 +2,9 @@
 
 For a list of all implemented Rules go [here](../README.md)
 ## Index
-Count: 18
+Count: 20
 - [craftableCobwebs](#craftablecobwebs)
+- [craftableHorseArmor](#craftablehorsearmor)
 - [craftableNameTags](#craftablenametags)
 - [craftableNotchApple](#craftablenotchapple)
 - [easyBoneBlockCrafting](#easyboneblockcrafting)
@@ -21,6 +22,7 @@ Count: 18
 - [unpackableNetherWart](#unpackablenetherwart)
 - [unpackableQuartz](#unpackablequartz)
 - [unpackableWool](#unpackablewool)
+- [woodcutting](#woodcutting)
 
 ## Rules in CRAFTING Category
 
@@ -30,47 +32,55 @@ Expect a lag spike when changing the value
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
+
+### craftableHorseArmor
+Horse Armor can be crafted in vanilla_style (H-shape), with_saddle (like in VanillaTweaks) or with armor_pieces  
+Expect a lag spike when changing the value  
+- Type: `String`
+- Default value: `off`
+- Required options: `off`, `vanilla_style`, `with_saddle`, `armor_pieces`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### craftableNameTags
 Name Tags can be crafted with Paper and Iron  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### craftableNotchApple
 Enchanted Golden Apples can be crafted with 8 Gold Blocks again  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyBoneBlockCrafting
 Bone Blocks can be crafted out of Bones  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyChestCrafting
 Chests can be crafted out of logs  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyDispenserCrafting
 Dispensers can be crafted in full stacks with a dropper plus the raw materials of a bow  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)
 
@@ -80,47 +90,47 @@ Expect a lag spike when changing the value
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyRepeaterCrafting
 Repeaters can be crafted with the raw materials for Redstone Torches  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyStickCrafting
 Sticks can be crafted out of logs  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### easyTrappedChestCrafting
 Trapped Chests can be crafted out of logs and a Tripwire Hook  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### moreBarkCrafting
 Crafting Logs to Wood gives 4 instead of 3  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 
 ### powderToGlassSmelting
 Concrete Powder can be smelted to Glass of the corresponding color  
 Expect a lag spike when changing the value  
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)
 
@@ -130,7 +140,7 @@ Expect a lag spike when changing the value
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)
 
@@ -140,7 +150,7 @@ Expect a lag spike when changing the value
 - Type: `boolean`
 - Default value: `false`
 - Required options: `true`, `false`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - Idea from [VanillaTweaks](https://vanillatweaks.net/picker/crafting-tweaks/)
 
@@ -150,7 +160,7 @@ Expect a lag spike when changing the value
 - Type: `int`
 - Default value: `0`
 - Suggested options: `0`, `3`, `4`, `9`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 9
 
@@ -160,7 +170,7 @@ Expect a lag spike when changing the value
 - Type: `int`
 - Default value: `0`
 - Suggested options: `0`, `9`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 9
 
@@ -170,7 +180,7 @@ Expect a lag spike when changing the value
 - Type: `int`
 - Default value: `0`
 - Suggested options: `0`, `4`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 9
 
@@ -180,6 +190,14 @@ Expect a lag spike when changing the value
 - Type: `int`
 - Default value: `0`
 - Suggested options: `0`, `4`
-- Categories: `CRAFTING`, `SURVIVAL`, `RUG`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`
 - Additional notes:
   - You must choose a value from 0 to 9
+
+### woodcutting
+The Stonecutter can be used for all wood types  
+Expect a lag spike when changing the value  
+- Type: `boolean`
+- Default value: `false`
+- Required options: `true`, `false`
+- Categories: `CRAFTING`, `RUG`, `SURVIVAL`

markdown/CREATIVE_Category.md

@@ -13,6 +13,6 @@ Mod needed on server and client for this feature to work
 - Type: `double`
 - Default value: `4.5`
 - Suggested options: `0`, `4.5`, `5`, `10`
-- Categories: `EXPERIMENTAL`, `CREATIVE`, `CLIENT`, `RUG`
+- Categories: `CLIENT`, `CREATIVE`, `EXPERIMENTAL`, `RUG`
 - Additional notes:
   - You must choose a value from 0 to 100