merge with master

eid_config.lua

@@ -1,7 +1,7 @@
 EID.UserConfig = {
     -------GENERAL---------
-	-- Change language of the mod.
+    -- Change the language of the mod
-	-- Currently Supported: English = "en_us" (Default) , "en_us_detailed"
+    -- Currently Supported: English = "en_us" (Default), "en_us_detailed" (More detailed descriptions)
     --						French = "fr"  		SPECIAL THANKS TO Nicolas Delvaux
     --						Polish = "pl"		SPECIAL THANKS TO Rickyy
     --						Spanish = "spa"		SPECIAL THANKS TO Lidia Arroyo Purroy
@@ -9,53 +9,56 @@ EID.UserConfig = {
     --						Brazilian Portuguese = "pt_br"	SPECIAL THANKS TO Marcelino Cruz
     --						Russian = "ru"		SPECIAL THANKS TO hell2pay, fly_6
     --						Italian = "it"		SPECIAL THANKS TO Denkishi, 2G
-	--						Bulgarian = "bul"	SPECIAL THANKS TO ,Gothika_47 					(WIP)
+    --						Bulgarian = "bul"	SPECIAL THANKS TO Gothika_47
     --						Turkish = "tr_tr"	SPECIAL THANKS TO Mert Dutal
+    --						Korean = "ko_kr"	SPECIAL THANKS TO Blackcreamtea and 미카
     --						Chinese (https://steamcommunity.com/sharedfiles/filedetails/?id=836319872)
     -- 						Italian (https://steamcommunity.com/sharedfiles/filedetails/?id=931392691)
-	-- If you want to make a translation, please contact me :)
+    --
+    -- If you want to make a translation, please contact me :) (wofsauge)
+    --
     ["Language"] = "en_us",
-	-- Toggle if item names should be displayed in your language, english or both
+    -- Change if item names should be displayed in English, your translated language or both
-	-- States: 1 = english , 2 = translated,  3 = both
+    -- States: 1 = English , 2 = translated,  3 = both
     -- Default = 2
     ["TranslateItemName"] = 2,
     -- Change font type. Values are [default, borderless, inverted]
     -- Default = "default"
     ["FontType"] = "default",
-	-- Change Width of the info boxes. (In characters)
+    -- Change the width of the info boxes (in characters).
     -- Default = 100
     ["TextboxWidth"] = 100,
-	-- Change Size of the info boxes. Range: [0,...,1]
+    -- Change the size of the info boxes. Range: [0,...,1]
     -- Default = 1
     ["Scale"] = 1,
-	-- Set transparency of the background. Range: [0,...,1]
+    -- Set the background transparency. Range: [0,...,1]
     -- Default = 0.75
     ["Transparency"] = 0.75,
-	-- Set the HUD offset of the description. 
+    -- Set the HUD offset of the descriptions
-	-- This should be set to the same number of "strokes" set in the ingame options for the "hud offset" value. (Range is 0 to 10)
+    -- This should be set to the same number of "strokes" set in the in-game options for the "hud offset" value (range is 0 to 10)
     -- Default = 10
     ["HUDOffset"] = 10,
-	-- Set X Position (Width) of the descriptiontext
+    -- Set the X Position (width) of the description texts
     -- Default = 60
     ["XPosition"] = 60,
-	-- Set Y Position (Height) of the descriptiontext
+    -- Set the Y Position (height) of the description texts
     -- Default = 45
     ["YPosition"] = 45,
-	-- Set the distance to an item in which informations will be displayed (in Tiles)
+    -- Set the distance between an item and its information display (in tiles)
     -- Default = 5
     ["MaxDistance"] = 5,
-	-- Choose between an indicator, that highlights the currently inspected object
+    -- Select the type of the indicator that highlights the currently inspected object
     -- Options: ["arrow", "blink", "border", "highlight", "none"].
-	-- Arrow = moving arrow pointing at the item | Blink = the whole sprite blinks white | Border = Blinking white border around the sprite | Highlight = White border around the sprite |  None = Disable funtion
+    -- Arrow = Moving arrow pointing at the item | Blink = The whole sprite blinks white | Border = Blinking white border around the sprite | Highlight = White border around the sprite |  None = No indicator
     -- Default = "none"
     ["Indicator"] = "none",
-	-- Set the keybinding to toggle the descriptions
+    -- Set the keybind to toggle the description display
-	-- look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
+    -- Look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
     -- Default = Keyboard.KEY_F2
     ["HideKey"] = Keyboard.KEY_F2,
-	-- Set the controller binding to toggle the descriptions
+    -- Set the controller binding to toggle the description display
-	-- Use the Controller names here: https://github.com/wofsauge/External-Item-Descriptions/blob/master/mod_config_menu.lua#L1 or a number
+    -- Use the controller names here: https://github.com/wofsauge/External-Item-Descriptions/blob/master/mod_config_menu.lua#L1 or a number
-	-- Of note are Controller.STICK_LEFT and Controller.STICK_RIGHT (pushing the sticks in), which aren't used in-game with default controls
+    -- Controller.STICK_LEFT and Controller.STICK_RIGHT (pushing the sticks in), which aren't used in-game with default controls
     -- Default = none (-1)
     ["HideButton"] = -1,
     -- Initial display state. Can be used to change the toggle behavior of the "Hide Key" event
@@ -68,19 +71,19 @@ EID.UserConfig = {
     -- Default = true
     ["DisableObstructionOnFlight"] = true,
     -- If set to true, the mod will no longer display a warning if the save game doesn't have achievements unlocked
-	-- This also disables warnings for using an outdated game version, and for having potentially modded Bag of Crafting recipes
+    -- This also disables warnings for using an outdated game version and for having potentially modded Bag of Crafting recipes
     -- Default = false
     ["DisableAchievementCheck"] = false,
 
-	-------Display Modes---------
+    -------display Modes---------
 
-	-- Sets the display mode of the description text. 
+    -- Sets the display mode of the description text
-	-- possible values: default, local
+    -- Possible values: default, local
-	--   "default": text will be displayed in the top-left of the screen.
+    --	"default": text will be displayed in the top left of the screen
-	--   "local": text will be displayed under the described object.
+    --	"local": text will be displayed under the described object
     -- Default = "default"
     ["DisplayMode"] = "default",
-	-- Change Size of the info boxes for LocalMode.
+    -- Change the size of the info boxes for local mode
     -- Default = 0.5
     ["LocalScale"] = 0.5,
     -- Changes the position of the text in local mode, relative to the described object to be centered. Set to false to make it left-aligned
@@ -89,97 +92,99 @@ EID.UserConfig = {
 
     -------------CURSE-------------
 
-	-- Disable informations when the floor has curse of the blind ( ? - Items)
+    -- Disable descriptions when the floor has Curse of the Blind
     -- Default = true
     ["DisableOnCurse"] = true,
-	-- Disable Item informations for the second Treasure room item on alt paths
+    -- Disable descriptions for the second Treasure Room item on the alt path
     -- REPENTANCE ONLY!!!
     -- Default = true
     ["DisableOnAltPath"] = true,
-	-- Disable Item informations on the April fools challenge
+    -- Disable descriptions for the April Fools challenge
     -- Default = true
     ["DisableOnAprilFoolsChallenge"] = true,
 
     ----------ITEM NAMES-----------
 
-	-- Toggle Display of Collectible / Card and Pill names
+    -- Toggle display of collectible or Card and Pill names
     -- Default = true
     ["ShowItemName"] = true,
-	-- Toggle Display of the Item Type and Maximum Charges as an icon
+    -- Toggle display of item type and maximum charge icons
     -- Default = true
     ["ShowItemType"] = true,
-	-- Toggle Display of Collectible / Trinket Icon next to Itemname
+    -- Toggle display of collectible or trinket icons next to the item name
     -- Default = true
     ["ShowItemIcon"] = true,
-	-- Toggle Display of Collectible / Item descriptions
+    -- Toggle display of collectible descriptions
     -- Default = true
     ["DisplayItemInfo"] = true,
-	-- Toggle Display of Trinket descriptions
+    -- Toggle display of trinket descriptions
     -- Default = true
     ["DisplayTrinketInfo"] = true,
-	-- Set the color-name of the Itemname description text. Color names can be found& defined in "eid_data.lua"
+    -- Set the color of the item name text
+    -- Color names are defined in "eid_data.lua" (line 300)
     -- Default = "ColorEIDObjName"
     ["ItemNameColor"] = "ColorEIDObjName",
-	-- Show ID of described object in the format "Type.Variant.SubType" next to the name
+    -- Display the ID of described object in the format "Type.Variant.SubType" next to the name
     -- Default = false
     ["ShowObjectID"] = false,
-	-- Enables or disables item quality after item name
+    -- Enables or disables item quality icon after item name
     -- REPENTANCE ONLY!!!
     -- Default = true
     ["ShowQuality"] = true,
 
     -------TRANSFORMATIONS---------
 
-	-- Toggle Display of Transformation text
+    -- Toggle display of transformation names
     -- Default = true
     ["TransformationText"] = true,
-	-- Toggle Display of Transformation icons
+    -- Toggle display of transformation icons
     -- Default = true
     ["TransformationIcons"] = true,
-	-- Set the color-name of the Transformation description text. Color names can be found& defined in "eid_data.lua"
+    -- Set the color of the Transformation description text
+    -- Color names are defined in "eid_data.lua" (line 300)
     -- Default = "ColorEIDTransform"
     ["TransformationColor"] = "ColorEIDTransform",
 
     ------------CARDS--------------
 
-	-- Toggle Display of Card / Rune descriptions
+    -- Toggle display of Card or Rune descriptions
     -- Default = true
     ["DisplayCardInfo"] = true,
-	-- Toggle Display of Card / Rune descriptions when its a shop item
+    -- Toggle display of Card or Rune descriptions when they're sold in shops
     -- Default = false
     ["DisplayCardInfoShop"] = false,
-	-- Toggle Display of Soulstone descriptions when its a shop item
+    -- Toggle display of Soul Stone descriptions when they're sold in shops
     -- REPENTANCE ONLY!!!
     -- Default = true
     ["DisplaySoulstoneInfoShop"] = true,
-	-- Toggle Display of Card / Rune descriptions when its not accessable with walking. AKA behind rock, blocks, spikes
+    -- Toggle display of Card or Rune descriptions when they're not accessible without flight, e.g. when they are behind rocks, blocks, spikes, etc.
     -- Default = false
     ["DisplayObstructedCardInfo"] = false,
-	-- Toggle Display of Soulstone descriptions when its not accessable with walking. AKA behind rock, blocks, spikes
+    -- Toggle display of Soul Stone descriptions when they're not accessible without flight, e.g. when they are behind rocks, blocks, spikes, etc.
     -- REPENTANCE ONLY!!!
     -- Default = true
     ["DisplayObstructedSoulstoneInfo"] = true,
-	-- Toggle Display of Card / Rune descriptions that are spawned with the Options? item
+    -- Toggle display of Card or Rune descriptions when they spawn from the Options? item
     -- REPENTANCE ONLY!!!
     -- Default = false
     ["DisplayCardInfoOptions?"] = false,
 
     ------------PILLS--------------
 
-	-- Toggle Display of Pill descriptions
+    -- Toggle display of Pill descriptions
     -- Default = true
     ["DisplayPillInfo"] = true,
-	-- Toggle Display of Pill descriptions when its a shop item
+    -- Toggle display of Pill descriptions when they're a shop item
     -- Default = true
     ["DisplayPillInfoShop"] = true,
-	-- Toggle Display of Pill descriptions when its not accessable with walking. AKA behind rock, blocks, spikes
+    -- Toggle display of Pill descriptions when they're not accessible without flight, e.g. when they are behind rocks, blocks, spikes, etc.
     -- Default = false
     ["DisplayObstructedPillInfo"] = false,
-	-- Toggle Display of Pill descriptions that are spawned with the Options? item
+    -- Toggle display of Pill descriptions when they spawn from the Options? item
     -- REPENTANCE ONLY!!!
     -- Default = true
     ["DisplayPillInfoOptions?"] = true,
-	-- Toggle Display of Pill descriptions that arent known to you yet
+    -- Toggle display of description for Pills that haven't been identified yet
     -- Default = false
     ["ShowUnidentifiedPillDescriptions"] = false,
 
@@ -193,20 +198,20 @@ EID.UserConfig = {
 
     --------Sacrifice Room---------
 
-	-- Toggle Display of next Sacrifice room Payout descriptions
+    -- Toggle display of the next Sacrifice Room payout description
     -- Default = true
     ["DisplaySacrificeInfo"] = true,
 
     --------Dice Room---------
 
-	-- Toggle Display of Diceroom descriptions
+    -- Toggle display of Dice Room descriptions
     -- Default = true
     ["DisplayDiceInfo"] = true,
 
     --------Crane Game---------
     -- REPENTANCE ONLY!!!
 
-	-- Toggle Display for items inside of a Crane Game
+    -- Toggle display for items inside of a Crane Game
     -- Default = true
     ["DisplayCraneInfo"] = true,
 
@@ -215,7 +220,7 @@ EID.UserConfig = {
 
     -- When to show the Bag of Crafting display
     -- Options: "always", "hold", "never"
-	-- "always" = Always show Results, "hold" = Show when holding up bag, "never" = Never show results
+    -- "always" = Always show results, "hold" = Show when holding up bag, "never" = Never show results
     -- Default = "always"
     ["DisplayBagOfCrafting"] = "always",
     -- Display modes for the Bag of Crafting display
@@ -230,20 +235,20 @@ EID.UserConfig = {
     -- Hide the recipe list when in battle
     -- Default = true
     ["BagOfCraftingHideInBattle"] = true,
-	-- Changes the number of Results shown in the Bag of crafting description
+    -- Changes the amount of results shown in the Bag of Crafting description
     -- Higher numbers can cause more lag!
     -- Default = 7
     ["BagOfCraftingResults"] = 7,
-	-- Changes the number of ingredients for which every combination is checked
+    -- Changes the amount of ingredients for which every combination is checked
     -- Higher numbers will cause lag spikes on new pickup sets!
     -- Default = 12
     ["BagOfCraftingCombinationMax"] = 12,
-	-- Changes the number of random recipes calculated
+    -- Changes the amount of how many random recipes get calculated
     -- Higher numbers will cause lag spikes on new pickup sets!
     -- Default = 400
     ["BagOfCraftingRandomResults"] = 400,
-	-- Set the keybinding to toggle the scroll feature of the bag of crafting descriptions
+    -- Set the keybinding to toggle the scroll feature of the Bag of Crafting descriptions
-	-- look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/ButtonAction.html
+    -- Look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/ButtonAction.html
     -- Default = ButtonAction.ACTION_MAP
     ["BagOfCraftingToggleKey"] = ButtonAction.ACTION_MAP,
     -- Display craftable item names, moving the recipe to a new line
@@ -253,7 +258,7 @@ EID.UserConfig = {
     -- Default = false
     ["BagOfCraftingDisplayIcons"] = false,
     -- Set the keybinding to toggle the crafting display, so you can see descriptions of items/pickups on the floor
-	-- look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
+    -- Look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
     -- Default = Keyboard.KEY_F3
     ["CraftingHideKey"] = Keyboard.KEY_F3,
     -- Set the controller binding to toggle the crafting display, so you can see descriptions of items/pickups on the floor
@@ -262,11 +267,11 @@ EID.UserConfig = {
     -- Default = none (-1)
     ["CraftingHideButton"] = -1,
     -- Set the keybinding to toggle viewing the description of the item ready to be crafted in the bag
-	-- look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
+    -- Look into the AB+ or Repentance documentation for the key names here: https://wofsauge.github.io/IsaacDocs/rep/enums/Keyboard.html
     -- Default = Keyboard.KEY_F3
     ["CraftingResultKey"] = Keyboard.KEY_F4,
     -- Set the controller binding to toggle viewing the description of the item ready to be crafted in the bag
-	-- Use the Controller names here: https://github.com/wofsauge/External-Item-Descriptions/blob/master/mod_config_menu.lua#L1 or a number
+    -- Use the controller names here: https://github.com/wofsauge/External-Item-Descriptions/blob/master/mod_config_menu.lua#L1 or a number
     -- Of note are Controller.STICK_LEFT and Controller.STICK_RIGHT (pushing the sticks in), which aren't used in-game with default controls
     -- Default = none (-1)
     ["CraftingResultButton"] = -1,
@@ -276,19 +281,17 @@ EID.UserConfig = {
     -- Toggles HUD descriptions based on the mouse position
     -- Default = false
     ["EnableMouseControls"] = false,
-	
     -- Toggles the custom mouse cursor
     -- Default = false
     ["ShowCursor"] = false,
 
     -------------MISC---------------
 
-	-- Changes the number of Results shown for the additional Spindown dice description
+    -- Changes the number of results shown for the additional Spindown Dice description
     -- REPENTANCE ONLY!!!
     -- Default = 3
     ["SpindownDiceResults"] = 3,
-	
+    -- Spindown Dice preview can skip over locked items, however the method for determining an item's locked status is not perfect
-	-- Spindown dice preview can skip over locked items, however the method for determining an item's locked status is not perfect
     -- REPENTANCE ONLY!!!
     -- Default = false
     ["SpindownDiceSkipLocked"] = false,
@@ -296,20 +299,22 @@ EID.UserConfig = {
     -- Error message displayed when an error occurs
     -- Default = [Effect not defined]
     ["ErrorMessage"] = "[Effect not defined]",
-	-- Set the color-name of the default description text. Color names can be found& defined in "eid_data.lua"
+    -- Set the color of the default description text
+    -- Color names are defined in "eid_data.lua" (line 300)
     -- Default = "ColorEIDText"
     ["TextColor"] = "ColorEIDText",
-	-- Set the color-name of the Error description text. Color names can be found& defined in "eid_data.lua"
+    -- Set the color of the error description text
+    -- Color names are defined in "eid_data.lua" (line 300)
     -- Default = "ColorEIDError"
     ["ErrorColor"] = "ColorEIDError",
-	-- Enables or disables custom Descriptions for entities
+    -- Enables or disables custom descriptions for entities
     -- Default = true
-	["EnableEntityDescriptions"] = true,
+    ["EnableEntityDescriptions"] = true
 }
 
 -- END CONFIG--
------------
+--------------
------------
+--------------
 
 --------------------------------------------------
 --------------------------------------------------
@@ -322,6 +327,7 @@ EID.UserConfig = {
 --------------------------------------------------
 --------------------------------------------------
 --------------------------------------------------
+
 EID.DefaultConfig = {
     ["Language"] = "en_us",
     ["TranslateItemName"] = 2,
@@ -392,5 +398,5 @@ EID.DefaultConfig = {
     ["ErrorMessage"] = "[Effect not defined]",
     ["TextColor"] = "ColorEIDText",
     ["ErrorColor"] = "ColorEIDError",
-	["EnableEntityDescriptions"] = true,
+    ["EnableEntityDescriptions"] = true
 }