From 11d8c74a26f1b26b108eea932663cbf7a515a375 Mon Sep 17 00:00:00 2001
From: EpicKnarvik97 <kristian.knarvik@knett.no>
Date: Thu, 16 Nov 2023 22:51:20 +0100
Subject: [PATCH] Adds comments to every option in strings.yml

---
 README.md                                     | 13 +++--
 .../blacksmith/command/EditCommand.java       |  5 ++
 .../config/scrapper/ScrapperSetting.java      |  2 +-
 src/main/resources/config.yml                 |  2 +-
 src/main/resources/strings.yml                | 48 ++++++++++++++++++-
 5 files changed, 62 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index f4c54be..230a362 100644
--- a/README.md
+++ b/README.md
@@ -55,14 +55,17 @@ In addition to just being able to repair items, blacksmiths have some random fea
 | Command           | Arguments                     | Description                                                                                  |
 |-------------------|-------------------------------|----------------------------------------------------------------------------------------------|
 | /blacksmith       | \<option> \[new-value]        | Changes a configuration option for the selected blacksmith (use Citizens' /npc select first) |
-| /blacksmithconfig | \<reload/option> \[new-value] | Changes a default/global configuration value                                                 |
+| /blacksmithconfig | \<reload/option> \[new-value] | Changes a default/global blacksmith configuration value                                      |
+| /scrapper         | \<option> \[new-value]        | Changes a configuration option for the selected scrapper (use Citizens' /npc select first)   |
+| /scrapperconfig   | \<reload/option> \[new-value] | Changes a default/global scrapper configuration value                                        |
 | /preset           | \<preset>\[:filter]           | Displays all materials included in the given preset, after applying the filter if set        |
 
-For /blacksmith and /blacksmithconfig, if a new value isn't specified, the current value is displayed instead.
+For /blacksmith, /blacksmithconfig, /scrapper and /scrapperconfig, if a new value isn't specified, a description of the
+configuration option, and the current value, is displayed instead.
 
-For /blacksmith, using -1 or null as the value will clear a custom value, making the NPC use the default value set in
-the config instead. Additionally, every value overridden for an NPC will display a marker (default: \[NPC]) when
-displaying the current value.
+For /blacksmith or /scrapper, using -1 or null as the value will clear a custom value, making the NPC use the default
+value set in the config instead. Additionally, every value overridden for an NPC will display a marker (default: \[NPC])
+when displaying the current value.
 
 Note: basePrice, pricePerDurabilityPoint and enchantmentCost can be set like: `/blacksmithconfig option 4` or
 like `/blacksmithconfig option material/enchantment 4` depending on whether you are setting the default or an override
diff --git a/src/main/java/net/knarcraft/blacksmith/command/EditCommand.java b/src/main/java/net/knarcraft/blacksmith/command/EditCommand.java
index 777075f..eb51c81 100644
--- a/src/main/java/net/knarcraft/blacksmith/command/EditCommand.java
+++ b/src/main/java/net/knarcraft/blacksmith/command/EditCommand.java
@@ -34,6 +34,11 @@ public abstract class EditCommand<K extends CustomTrait<L>, L extends Setting> i
 
     protected final Class<K> traitClass;
 
+    /**
+     * Instantiates a new edit command
+     *
+     * @param traitClass <p>The type of trait this command edits</p>
+     */
     public EditCommand(Class<K> traitClass) {
         this.traitClass = traitClass;
     }
diff --git a/src/main/java/net/knarcraft/blacksmith/config/scrapper/ScrapperSetting.java b/src/main/java/net/knarcraft/blacksmith/config/scrapper/ScrapperSetting.java
index e6cf069..4e70863 100644
--- a/src/main/java/net/knarcraft/blacksmith/config/scrapper/ScrapperSetting.java
+++ b/src/main/java/net/knarcraft/blacksmith/config/scrapper/ScrapperSetting.java
@@ -94,7 +94,7 @@ public enum ScrapperSetting implements Setting {
      */
     TOO_DAMAGED_FOR_SALVAGE_MESSAGE("messages.tooDamagedForSalvageMessage", SettingValueType.STRING,
             "&cThat item is too damaged to be salvaged into anything useful",
-            "tooDamagedForSalvageMessage", "The message to display if reforging the player's " +
+            "tooDamagedForSalvageMessage", "The message to display if salvaging the player's " +
             "item would result in no salvage", true, true),
 
     /**
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
index aa33eda..e640fc4 100644
--- a/src/main/resources/config.yml
+++ b/src/main/resources/config.yml
@@ -161,7 +161,7 @@ scrapper:
       # The message to display if the player tries to salvage an item the blacksmith cannot salvage
       cannotSalvageMessage: "&cI'm unable to salvage that item"
       
-      # The message to display if reforging the player's item would result in no salvage
+      # The message to display if salvaging the player's item would result in no salvage
       tooDamagedForSalvageMessage: "&cThat item is too damaged to be salvaged into anything useful"
       
       # The message to display when an item is successfully salvaged
diff --git a/src/main/resources/strings.yml b/src/main/resources/strings.yml
index 22bc6fc..d699f70 100644
--- a/src/main/resources/strings.yml
+++ b/src/main/resources/strings.yml
@@ -1,44 +1,90 @@
+# The english translation of internal strings. To add your own language, copy everything below, and change "en" to your
+#  own language's code, and change each string. Afterwards, copy this file to Blacksmith's plugin folder, and change the
+#  language in config.yml to your language's language code.
 en:
+  # The format used to display when a setting's value has been changed
   VALUE_CHANGED: "&7{setting} set to &6{newValue}"
+  # The format used to display when a setting's value has been changed for a specific material or enchantment
   VALUE_FOR_ITEM_CHANGED: "&7{setting} for {itemType} {item} set to &6{newValue}"
+  # The format used to display the current value of a setting
   CURRENT_VALUE: "&7Current value of {setting}:&r {currentValue}"
+  # The format used to display the current value of a setting for a specific material or enchantment
   CURRENT_VALUE_FOR_ITEM: "&7Current value of {setting} for {itemType} {item}:&r {currentValue}"
+  # Translation of the enchantment item type (used for VALUE_FOR_ITEM_CHANGED, CURRENT_VALUE_FOR_ITEM)
   ITEM_TYPE_ENCHANTMENT: "enchantment"
+  # Translation of the material item type (used for VALUE_FOR_ITEM_CHANGED, CURRENT_VALUE_FOR_ITEM)
   ITEM_TYPE_MATERIAL: "material"
+  # The format used when displaying the raw formatting of messages
   RAW_VALUE: "Raw value: {rawValue}"
-  NO_NPC_SELECTED: "You must select an NPC before running this command"
+  # The translation of the message displayed when the player uses /blacksmith or /scrapper without selecting an NPC first
+  NO_NPC_SELECTED: "You must select an NPC with the correct trait before running this command (/npc select)"
+  # The translation of the message displayed when a comma-separated list of strings is expected by a setting, but not given
   INPUT_STRING_LIST_REQUIRED: "A string list is required!"
+  # The translation of the message displayed when a percentage is expected, but not given
   INPUT_PERCENTAGE_REQUIRED: "You specified a value which isn't between 0 and 100!"
+  # The translation of the message displayed when a non-empty text string is expected, but not given
   INPUT_STRING_REQUIRED: "A non-empty string is required!"
+  # The translation of the message displayed when a positive double (comma number) is expected, but not given
   INPUT_POSITIVE_DOUBLE_REQUIRED: "You specified a value which isn't a positive double!"
+  # The translation of the message displayed when a positive integer is expected, but not given
   INPUT_POSITIVE_INTEGER_REQUIRED: "You specified a value which isn't a positive integer!"
+  # The translation of the message displayed when a player is missing the necessary permission for an action
   PERMISSION_DENIED: "You lack the necessary permission"
+  # The translation of the message displayed when the configuration is reloaded
   PLUGIN_RELOADED: "Blacksmith config reloaded!"
+  # The translation of the message displayed when an invalid filter is used for a smith preset 
   INVALID_FILTER_FOR_PRESET: "The specified filter is not valid for that preset"
+  # The translation of the message displayed when an invalid filter or preset is specified
   INVALID_PRESET_OR_FILTER: "You specified an invalid preset or an invalid filter"
+  # The translation of the message displayed before listing all materials in a preset for the /preset command
   PRESET_MATERIALS: "Materials in preset: {materials}"
+  # The format used when displaying any duration remaining
   DURATION_FORMAT: "in {time} {unit}"
+  # The format used when NPCs talk to players ({npc} = The NPC's name, {message} is the actual message contents)
   NPC_TALK_FORMAT: "&a[{npc}] -> You:&r {message}"
+  # Translation of the duration of less than a second
   UNIT_NOW: "imminently"
+  # Translation of seconds in singular form
   UNIT_SECOND: "second"
+  # Translation of seconds in plural form
   UNIT_SECONDS: "seconds"
+  # Translation of minutes in singular form
   UNIT_MINUTE: "minute"
+  # Translation of minutes in plural form
   UNIT_MINUTES: "minutes"
+  # Translation of hour in singular form
   UNIT_HOUR: "hour"
+  # Translation of hour in plural form
   UNIT_HOURS: "hours"
+  # Translation of days in singular form
   UNIT_DAY: "day"
+  # Translation of days in plural form
   UNIT_DAYS: "days"
+  # Translation of weeks in singular form
   UNIT_WEEK: "week"
+  # Translation of weeks in plural form
   UNIT_WEEKS: "weeks"
+  # Translation of months in singular form
   UNIT_MONTH: "month"
+  # Translation of months in plural form
   UNIT_MONTHS: "months"
+  # Translation of years in singular form
   UNIT_YEAR: "year"
+  # Translation of years in plural form
   UNIT_YEARS: "years"
+  # Translation of decades in singular form
   UNIT_DECADE: "decade"
+  # Translation of decades in plural form
   UNIT_DECADES: "decades"
+  # The text shown if the player has less than 10 seconds left of waiting
   INTERVAL_LESS_THAN_10_SECONDS: "in just a moment"
+  # The text shown if the player has to wait between 10 and 30 seconds
   INTERVAL_LESS_THAN_30_SECONDS: "in a little while"
+  # The text shown if the player has to wait for between 30 seconds and 1 minute
   INTERVAL_LESS_THAN_1_MINUTE: "in a while"
+  # The text shown if the player has to wait for less than 5 minutes, but more than 1 minute
   INTERVAL_LESS_THAN_5_MINUTES: "after some time"
+  # The text shown if the player has to wait for more than 5 minutes
   INTERVAL_MORE_THAN_5_MINUTES: "in quite a while"
+  # The marker shown when displaying values overridden for the selected NPC (not shown if the NPC inherits the default value)
   SETTING_OVERRIDDEN_MARKER: " [NPC]"
\ No newline at end of file