2.1.0, improve config texts and tooltips

Madis0 · Dec 4, 2021 · 0587703 · 0587703
1 parent 4c2329b
commit 0587703
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ The mod only uses client-side data, so it is never needed on a server. There are
 * Regeneration - pink bar, **→ _number_** where number is the resulting health¹
 * Absorption - no bar, **+number**, where number is your absorption health points
 * Resistance - no bar, **+⛨number%** or **+rnumber%** where number is the [effect level multiplier](https://minecraft.gamepedia.com/Resistance#Effect)²
-* Fire Resistance - no bar, **-~🔥number×~** or **-~bnumber×~** where number is a rough damage multiplier (1× - burning, 2× - burning in fire, 4× - burning in lava)²
+* Fire Resistance - no bar, **-~🔥number×~** or **-~bnumber×~** where number is a rough damage multiplier (1× - burning, 2× - burning in fire, 4× - burning in lava/soul fire)²
 * Water Breathing/Conduit Power - blue bar, **-~⭘number~** or **-~anumber~**, number is usually zero and bar hidden unless you got water breathing _within_ water²
 * Held food restored hunger bar - green (exact/less) or orange (wasted) bar on top of hunger bar, **→ _number_** where number is the resulting hunger (negative if wasted; feature similar to AppleSkin)
 

diff --git a/gradle.properties b/gradle.properties
@@ -8,7 +8,7 @@ org.gradle.jvmargs=-Xmx1G
 	loader_version=0.12.8
 
 # Mod Properties
-	mod_version = 2.0.0
+	mod_version = 2.1.0
 	maven_group = io.github.madis0
 	archives_base_name = onebar
 

diff --git a/src/main/java/io/github/madis0/ModConfig.java b/src/main/java/io/github/madis0/ModConfig.java
@@ -6,10 +6,11 @@
 
 @Config(name = "onebar")
 public class ModConfig implements ConfigData {
-
+    @ConfigEntry.Gui.Tooltip
     public boolean showOneBar = true;
     @ConfigEntry.Gui.Tooltip
     public boolean healthEstimates = true;
+    @ConfigEntry.Gui.Tooltip
     public boolean uhcMode = false;
     @ConfigEntry.Gui.Tooltip
     public boolean disableHunger = false;
@@ -38,9 +39,13 @@ public static class TextSettings {
         public boolean showText = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int textColor = 0xB3FFFFFF;
+        @ConfigEntry.Gui.Tooltip
         public boolean estimatesItalic = true;
+        @ConfigEntry.Gui.Tooltip
         public boolean estimatesParentheses = true;
+        @ConfigEntry.Gui.Tooltip
         public boolean useEmoji = true;
+        @ConfigEntry.Gui.Tooltip
         public boolean useFractions = false;
     }
 
@@ -51,7 +56,9 @@ public static class GoodThings {
         public int naturalRegenerationColor = 0xFFFFC107;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int regenerationColor = 0xFFEC407A;
+        @ConfigEntry.Gui.Tooltip
         public boolean showResistance = true;
+        @ConfigEntry.Gui.Tooltip
         public boolean heldFoodHungerBar = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int heldFoodHungerWasteColor = 0xA6FFB04C;
@@ -64,11 +71,13 @@ public static class BadThings {
         public int hungerColor = 0xBF3E2723;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int hungerEffectColor = 0xA6827717;
+        @ConfigEntry.Gui.Tooltip
         public boolean showHungerDecreasing = false;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int airColor = 0xA61A237E;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int freezeColor = 0xA68EACBB;
+        @ConfigEntry.Gui.Tooltip
         public boolean showFire = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int fireColor = 0xA6C43E00;
@@ -81,6 +90,7 @@ public static class BadThings {
     public static class Entity {
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int healthColor = 0xFFF57F17;
+        @ConfigEntry.Gui.Tooltip
         public boolean showHorseJump = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int jumpColor = 0xFF795548;
@@ -89,15 +99,19 @@ public static class Entity {
     public static class OtherBars {
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int xpColor = 0xFF00C853;
+        @ConfigEntry.Gui.Tooltip
         public boolean showArmorBar = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int armorColor = 0xA6FFFFFF;
+        @ConfigEntry.Gui.Tooltip
         public boolean showArmorDurabilityBar = false;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int armorDurabilityColor = 0xA600B8D4;
+        @ConfigEntry.Gui.Tooltip
         public boolean showElytraDurabilityBar = true;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int elytraDurabilityColor = 0xCCE040FB;
+        @ConfigEntry.Gui.Tooltip
         public boolean showSaturationBar = false;
         @ConfigEntry.ColorPicker(allowAlpha = true)
         public int saturationColor = 0xE6F9A825;

diff --git a/src/main/resources/assets/onebar/lang/en_us.json b/src/main/resources/assets/onebar/lang/en_us.json
@@ -13,52 +13,67 @@
   "text.autoconfig.onebar.title": "OneBar configuration",
   "text.autoconfig.onebar.category.default": "General",
   "text.autoconfig.onebar.option.showOneBar": "Show OneBar",
+  "text.autoconfig.onebar.option.showOneBar.@Tooltip": "Disabling will show vanilla HUD instead",
   "text.autoconfig.onebar.option.healthEstimates": "Estimates for potion and natural effects",
   "text.autoconfig.onebar.option.healthEstimates.@Tooltip": "Toggles the texts and bars for (natural) regeneration, hunger effect, poison etc.",
-  "text.autoconfig.onebar.option.uhcMode": "UHC mode (disable natural regen estimate)",
-  "text.autoconfig.onebar.option.disableHunger": "Disable hunger (for minigames)",
-  "text.autoconfig.onebar.option.disableHunger.@Tooltip": "Hides the hunger bar/text, hunger effect and starvation estimates etc.",
+  "text.autoconfig.onebar.option.uhcMode": "UHC mode",
+  "text.autoconfig.onebar.option.uhcMode.@Tooltip": "Disables natural regen estimates, if effect estimates are enabled",
+  "text.autoconfig.onebar.option.disableHunger": "Disable hunger visibility",
+  "text.autoconfig.onebar.option.disableHunger.@Tooltip": "Hides the hunger bar/text, hunger effect and starvation estimates etc. for certain minigames",
   "text.autoconfig.onebar.option.backgroundColor.@PrefixText": "§8Every color is preceded by the opacity value in hex, see mod page for help",
   "text.autoconfig.onebar.option.backgroundColor": "Background color",
   "text.autoconfig.onebar.category.textSettings": "Text",
   "text.autoconfig.onebar.option.textSettings.showText": "Show numbers and symbols on OneBar",
-  "text.autoconfig.onebar.option.textSettings.showText.@Tooltip": "Disabling will still show absorption and hardcore indicators",
+  "text.autoconfig.onebar.option.textSettings.showText.@Tooltip": "Disabling will still show numeric absorption health and hardcore indicator (if exist)",
   "text.autoconfig.onebar.option.textSettings.textColor": "Text color",
-  "text.autoconfig.onebar.option.textSettings.estimatesItalic": "Show effect estimates (if enabled) in §oitalic§r",
-  "text.autoconfig.onebar.option.textSettings.estimatesParentheses": "Show parentheses around effect estimates (if enabled) where needed",
-  "text.autoconfig.onebar.option.textSettings.useEmoji": "Use emoji instead of letters (e.g. \uD83D\uDD25 instead of b)",
-  "text.autoconfig.onebar.option.textSettings.useFractions": "Vanilla-like fractions (e.g 9,5 instead of 19)",
+  "text.autoconfig.onebar.option.textSettings.estimatesItalic": "Show effect estimates in §oitalic§r",
+  "text.autoconfig.onebar.option.textSettings.estimatesItalic.@Tooltip": "If effect estimates are enabled",
+  "text.autoconfig.onebar.option.textSettings.estimatesParentheses": "Show parentheses around effect estimates",
+  "text.autoconfig.onebar.option.textSettings.estimatesParentheses.@Tooltip": "E.g. health-related effect estimates will be grouped; if effect estimates are enabled",
+  "text.autoconfig.onebar.option.textSettings.useEmoji": "Use emoji instead of letters",
+  "text.autoconfig.onebar.option.textSettings.useEmoji.@Tooltip": "E.g. show \uD83D\uDD25 instead of b for burning",
+  "text.autoconfig.onebar.option.textSettings.useFractions": "Vanilla-like fractions",
+  "text.autoconfig.onebar.option.textSettings.useFractions.@Tooltip": "E.g. show 9,5 instead of 19 health",
   "text.autoconfig.onebar.category.goodThings": "Good effects",
   "text.autoconfig.onebar.option.goodThings.healthColor": "Health color",
   "text.autoconfig.onebar.option.goodThings.naturalRegenerationColor": "Natural regeneration color",
   "text.autoconfig.onebar.option.goodThings.regenerationColor": "Regeneration effect color",
   "text.autoconfig.onebar.option.goodThings.showResistance": "Resistance percent",
-  "text.autoconfig.onebar.option.goodThings.heldFoodHungerBar": "Food level restoration by held food (overlay on hunger bar)",
+  "text.autoconfig.onebar.option.goodThings.showResistance.@Tooltip": "Show resistance effect level as percentage, e.g. level 2 shows 40% (level × 20%)",
+  "text.autoconfig.onebar.option.goodThings.heldFoodHungerBar": "Food level restoration by held food",
+  "text.autoconfig.onebar.option.goodThings.heldFoodHungerBar.@Tooltip": "Shows an overlay on hunger bar when holding any food item and player has hunger",
   "text.autoconfig.onebar.option.goodThings.heldFoodHungerWasteColor": "Food level restoration color: wasted",
   "text.autoconfig.onebar.option.goodThings.heldFoodHungerGoodColor": "Food level restoration color: exact or less",
   "text.autoconfig.onebar.category.badThings": "Bad effects",
   "text.autoconfig.onebar.option.badThings.hungerColor": "Hunger color",
   "text.autoconfig.onebar.option.badThings.hungerEffectColor": "Hunger effect color",
-  "text.autoconfig.onebar.option.badThings.showHungerDecreasing": "Show ↓ when you're getting hungrier by activities (zero saturation)",
+  "text.autoconfig.onebar.option.badThings.showHungerDecreasing": "Show ↓ when you're getting hungrier",
+  "text.autoconfig.onebar.option.badThings.showHungerDecreasing.@Tooltip": "Meaning zero saturation - various activities will increase the hunger",
   "text.autoconfig.onebar.option.badThings.airColor": "Air color (underwater)",
   "text.autoconfig.onebar.option.badThings.freezeColor": "Freezing color",
-  "text.autoconfig.onebar.option.badThings.showFire": "Burning overlay bar and damage multiplier (based on the block)",
+  "text.autoconfig.onebar.option.badThings.showFire": "Burning bar and damage multiplier",
+  "text.autoconfig.onebar.option.badThings.showFire.@Tooltip": "1× - burning, 2× - burning in fire, 4× - burning in lava/soul fire",
   "text.autoconfig.onebar.option.badThings.fireColor": "Burning color",
   "text.autoconfig.onebar.option.badThings.poisonColor": "Poison color",
   "text.autoconfig.onebar.option.badThings.witherColor": "Wither color",
-  "text.autoconfig.onebar.category.entity": "Ridable entities",
+  "text.autoconfig.onebar.category.entity": "Rideable entities",
   "text.autoconfig.onebar.option.entity.healthColor": "Health color",
-  "text.autoconfig.onebar.option.entity.showHorseJump": "Horse jump bar (vertical bar below crosshair)",
+  "text.autoconfig.onebar.option.entity.showHorseJump": "Horse jump bar",
+  "text.autoconfig.onebar.option.entity.showHorseJump.@Tooltip": "Vertical bar below crosshair",
   "text.autoconfig.onebar.option.entity.jumpColor": "Jump color",
   "text.autoconfig.onebar.category.otherBars": "Other bars",
-  "text.autoconfig.onebar.option.otherBars.xpColor": "Experience level number/bar color",
-  "text.autoconfig.onebar.option.otherBars.showArmorBar": "Armor bar (thin bar above OneBar, also for ridden horses)",
+  "text.autoconfig.onebar.option.otherBars.xpColor": "Experience level/bar color",
+  "text.autoconfig.onebar.option.otherBars.showArmorBar": "Armor bar",
+  "text.autoconfig.onebar.option.otherBars.showArmorBar.@Tooltip": "Thin bar above OneBar, also for ridden horses",
   "text.autoconfig.onebar.option.otherBars.armorColor": "Armor color",
-  "text.autoconfig.onebar.option.otherBars.showArmorDurabilityBar": "Armor durability bar (overlay on armor bar, width adapts to armor bar)",
+  "text.autoconfig.onebar.option.otherBars.showArmorDurabilityBar": "Armor durability bar",
+  "text.autoconfig.onebar.option.otherBars.showArmorDurabilityBar.@Tooltip": "Overlay on armor bar, width adapts to armor bar",
   "text.autoconfig.onebar.option.otherBars.armorDurabilityColor": "Armor durability color",
-  "text.autoconfig.onebar.option.otherBars.showElytraDurabilityBar": "Elytra durability bar (thin bar above OneBar, only when flying)",
+  "text.autoconfig.onebar.option.otherBars.showElytraDurabilityBar": "Elytra durability bar",
+  "text.autoconfig.onebar.option.otherBars.showElytraDurabilityBar.@Tooltip": "Thin bar above OneBar; only when flying",
   "text.autoconfig.onebar.option.otherBars.elytraDurabilityColor": "Elytra durability color",
-  "text.autoconfig.onebar.option.otherBars.showSaturationBar": "Saturation line (thin bar below OneBar)",
+  "text.autoconfig.onebar.option.otherBars.showSaturationBar": "Saturation bar",
+  "text.autoconfig.onebar.option.otherBars.showSaturationBar.@Tooltip": "Thin bar below OneBar",
   "text.autoconfig.onebar.option.otherBars.saturationColor": "Saturation color",
   "text.autoconfig.onebar.option.otherBars.compatibilityMode": "Compatibility mode",
   "text.autoconfig.onebar.option.otherBars.compatibilityMode.@Tooltip": "Allows some other mods to show their HUD elements around OneBar"