Straightened out the confusing and contradictory mess around the beha…

…vior of the name/bright/dim config settings. Expectations are now limited and clear.

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Middle Kingdom - v10 -> main branch
 
+### 2.18.0 - January 12, 2025 - Dim/Bright config is now purely fallback
+- [FEATURE] Eliminated confusing name/bright/dim override setting.
+  * On systems that have no sources configured, a source with this name and those light values becomes the sole source.
+  * On systems that have sources configured, the name specifies which source to use by default, rather than "just picking one." (The dim/bright values are completely ignored on these systems.)
+
 ### 2.17.0 - January 11, 2025 - Ignore Equipment flag
 - [FEATURE] New config flag to completely ignore user equipment. Users can turn on any light source defined for the system.
 - [FEATURE] Rearranged config settings in preparation for give the last three settings a clearer role.

README.md

@@ -1,6 +1,6 @@
 # Torch module for Foundry VTT
 
-This module provides a HUD toggle button for turning on and off a configurable radius of bright and dim light around you. This default source ("Self") is provided for any system for which we don't supply more specialized capabilities. (The bright and dim settings in the configuration are intended for use only in this case.)
+This module provides a HUD toggle button for turning on and off a configurable radius of bright and dim light around you. A default source can be configured in settings for any system for which we don't supply more specialized capabilities.
 
 However, we now have a variety of core light sources configured for D&D 5th Ed, Savage Worlds, Pathfinder 1st and 2nd editions, GURPS, and Earthdawn. You can select which light source the button will manipulate by right-clicking and clicking the desired source from the menu of buttons that appear for light sources in the actor's inventory or spell list. 
 
@@ -45,7 +45,7 @@ Besides the user light source file described in the following section:
 
 It all depends how you want to run your game.
 
-And, again, the bright and dim light settings are intended only as a fallback for use when you are playing in a system where nobody has supplied a set of light sources. (Ignore the name setting right above it. That is imminently about to go away.)
+The bright and dim light settings are intended only as a fallback for use when you are playing in a system where nobody has supplied a set of light sources. The settings will appear with the light source name specified with them. (In systems which *do* have a set of light sources, the fallback name identifies the source to use if the user hasn't yet selected a light source.)
 
 ## Customizing light sources
 
@@ -211,15 +211,15 @@ The following is the current status of translation. Some features have arrived,
 
 | Language | Completion | Contributors |
 | -------- | ---------- | ------------ |
-| de    | `[######################]` 22/23 (96%) | ToGreedy, Beff42 |
-| en    | `[######################]` 23/23 (100%) | deuce, lupestro |
-| es    | `[######################]` 22/23 (96%) | lozanoje, WallaceMcGregor |
-| fr    | `[##################----]` 18/23 (78%) | Aymeeric |
-| it    | `[######################]` 22/23 (96%) | GregoryWarn |
-| ja    | `[######################]` 22/23 (96%) | doumoku |
-| pt-br | `[######################]` 22/23 (96%) | Innocenti, Andersants |
-| zh-cn | `[##########------------]` 10/23 (43%) | xticime |
-| zh-tw | `[############----------]` 12/23 (52%) | zeteticl |
+| de    | `[################--------]` 16/24 (67%) | ToGreedy, Beff42 |
+| en    | `[########################]` 24/24 (100%) | deuce, lupestro |
+| es    | `[################--------]` 16/24 (67%) | lozanoje, WallaceMcGregor |
+| fr    | `[############------------]` 12/24 (50%) | Aymeeric |
+| it    | `[################--------]` 16/24 (67%) | GregoryWarn |
+| ja    | `[################--------]` 16/24 (67%) | doumoku |
+| pt-br | `[################--------]` 16/24 (67%) | Innocenti, Andersants |
+| zh-cn | `[######------------------]` 06/24 (25%) | xticime |
+| zh-tw | `[########----------------]` 08/24 (33%) | zeteticl |
 
 PRs for further translations will be dealt with promptly. While Korean is most especially desired (thank you, doumoku for Japanese, also on the short list) - all others are welcome. 
 

lang/cn.json

@@ -2,26 +2,26 @@
 	"I18N.LANGUAGE": "中文",
 	"I18N.MAINTAINERS": ["Chivell"],
 
-	"torch.playerTorches.name": "玩家火炬",
-	"torch.playerTorches.hint": "允许玩家自行开关自己的火炬。",
-	"torch.brightRadius.hint": "发出多少格单位的亮光。",
-	"torch.dimRadius.hint": "发出多少格单位的微光。",
-	"torch.gmUsesInventory.name": "使用库存",
-	"torch.gmUsesInventory.hint": "当GM开关火炬时，将使用角色库存。",
-	"torch.gmInventoryItemName.name": "Inventory item name to use",
-	"torch.gmInventoryItemName.hint": "Name of the inventory item to use if \"GM Uses Inventory\" is set.",
-	"torch.turnOffAllLights": "强制亮/微光设置为OFF",
-	"torch.holdCtrlOnClick": "按住 <span class=\"key\">Ctrl</span> 点击",
-	"torch.dancingLightVision.name": "Give Dancing Lights Vision.",
-	"torch.dancingLightVision.hint": "When enabled, each dancing light has vision so can be used to reveal areas of the map players can't actually see.",
-	"torch.playerUsesInventory.name": "Player Uses Inventory",
-	"torch.playerUsesInventory.hint": "If set, when the player toggles a torch, it will use the actors inventory.",
-	"torch.gameLightSources.name": "Additional Light Sources",
-	"torch.gameLightSources.hint": "JSON file containing additional light sources to use beyond those supplied",
-	"torch.brightRadius.name": "Bright Light Radius",
-	"torch.dimRadius.name": "Dim Light Radius",
-	"torch.ignoreEquipment.name": "Ignore Equipment",
-	"torch.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gameLightSources.name": "Additional Light Sources",
+	"torch.settings.gameLightSources.hint": "JSON file containing additional light sources to use beyond those supplied",
+	"torch.settings.playerTorches.name": "玩家火炬",
+	"torch.settings.playerTorches.hint": "允许玩家自行开关自己的火炬。",
+	"torch.settings.gmUsesInventory.name": "使用库存",
+	"torch.settings.gmUsesInventory.hint": "当GM开关火炬时，将使用角色库存。",
+	"torch.settings.playerUsesInventory.name": "Player Uses Inventory",
+	"torch.settings.playerUsesInventory.hint": "If set, when the player toggles a torch, it will use the actors inventory.",
+	"torch.settings.dancingLightVision.name": "Give Dancing Lights Vision.",
+	"torch.settings.dancingLightVision.hint": "When enabled, each dancing light has vision so can be used to reveal areas of the map players can't actually see.",
+	"torch.settings.ignoreEquipment.name": "Ignore Equipment",
+	"torch.settings.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.fallbackSourceName.name": "Fallback Source Name",
+	"torch.settings.fallbackSourceName.hint": "Name to show for fallback light source.",
+	"torch.settings.fallbackBrightRadius.name": "Fallback Bright Light Radius",
+	"torch.settings.fallbackBrightRadius.hint": "How many grid units of bright light to emit on systems without light source configuration.",
+	"torch.settings.fallbackDimRadius.name": "Fallback Dim Light Radius",
+	"torch.settings.fallbackDimRadius.hint": "How many grid units of dim light to emit on systems without light source configuration.",
+	"torch.help.turnOffAllLights": "强制亮/微光设置为OFF",
+	"torch.help.holdCtrlOnClick": "按住 <span class=\"key\">Ctrl</span> 点击",
 	"torch.help.supplyExhausted.title": "Supply Exhausted",
 	"torch.help.supplyExhausted.body": "<p>Your light source is consumable and your quantity has dropped to zero. Increase the quantity of the item to light a fresh one.</p>",
 	"torch.help.setupSources.title": "Setting Up Light Sources",

lang/de.json

@@ -2,26 +2,26 @@
 	"I18N.LANGUAGE": "Deutsch",
 	"I18N.MAINTAINERS": ["ToGreedy"],
 
-	"torch.playerTorches.name": "Spieler Fackeln",
-	"torch.playerTorches.hint": "Erlaubt es Spielern, ihre eigenen Fackeln umzuschalten.",
-	"torch.brightRadius.hint": "Wie viele Rastereinheiten helles Licht sollen ausgestrahlt werden.",
-	"torch.dimRadius.hint": "Wie viele Rastereinheiten gedämpftes Licht sollen ausgestrahlt werden.",
-	"torch.gmUsesInventory.name": "GM verwendet Inventar",
-	"torch.gmUsesInventory.hint": "Wenn diese Option gesetzt ist, verwendet der GM beim Umschalten einer Fackel das Inventar des Spielers.",
-	"torch.gmInventoryItemName.name": "Name des Inventargegenstandes",
-	"torch.gmInventoryItemName.hint": "Name des zu verwendenden Inventargegenstandes, wenn \"GM verwendet Inventar\" eingestellt ist.",
-	"torch.turnOffAllLights": "Erzwingen Sie Hell- und Dimmwerte für die konfigurierten Werte \"Aus\".",
-	"torch.holdCtrlOnClick": "Halte <span class=\"key\">Ctrl</span> beim Klick",
-	"torch.dancingLightVision.name": "Sicht für \"Dancing Lights\".",
-	"torch.dancingLightVision.hint": "Wenn diese Option gesetzt ist, hat jedes \"Dancing Light\" sicht und kann dazu verwendet werden, Bereiche der Karte aufzudecken, die Spieler nicht sehen können.",
-    "torch.playerUsesInventory.name": "Spieler verwendet Inventar",
-    "torch.playerUsesInventory.hint": "Wenn diese Option gesetzt ist, verwendet der Spieler beim Umschalten einer Fackel sein Inventar.",
-    "torch.gameLightSources.name": "Zusätzliche Lichtquellen",
-    "torch.gameLightSources.hint": "JSON Datei mit zusätzlichen Lichtquellen, die über die mitgelieferten hinaus verwendet werden sollen",
-    "torch.brightRadius.name": "Radius des hellen Lichts",
-    "torch.dimRadius.name": "Radius des gedämpften Lichts",
-	"torch.ignoreEquipment.name": "Ignore Equipment",
-	"torch.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+    "torch.settings.gameLightSources.name": "Zusätzliche Lichtquellen",
+    "torch.settings.gameLightSources.hint": "JSON Datei mit zusätzlichen Lichtquellen, die über die mitgelieferten hinaus verwendet werden sollen",
+	"torch.settings.playerTorches.name": "Spieler Fackeln",
+	"torch.settings.playerTorches.hint": "Erlaubt es Spielern, ihre eigenen Fackeln umzuschalten.",
+	"torch.settings.ignoreEquipment.name": "Ignore Equipment",
+	"torch.settings.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gmUsesInventory.name": "GM verwendet Inventar",
+	"torch.settings.gmUsesInventory.hint": "Wenn diese Option gesetzt ist, verwendet der GM beim Umschalten einer Fackel das Inventar des Spielers.",
+    "torch.settings.playerUsesInventory.name": "Spieler verwendet Inventar",
+    "torch.settings.playerUsesInventory.hint": "Wenn diese Option gesetzt ist, verwendet der Spieler beim Umschalten einer Fackel sein Inventar.",
+	"torch.settings.dancingLightVision.name": "Sicht für \"Dancing Lights\".",
+	"torch.settings.dancingLightVision.hint": "Wenn diese Option gesetzt ist, hat jedes \"Dancing Light\" sicht und kann dazu verwendet werden, Bereiche der Karte aufzudecken, die Spieler nicht sehen können.",
+	"torch.settings.fallbackSourceName.name": "Fallback Item Name",
+	"torch.settings.fallbackSourceName.hint": "Name to show for fallback light source.",
+	"torch.settings.fallbackBrightRadius.name": "Fallback Bright Light Radius",
+	"torch.settings.fallbackBrightRadius.hint": "How many grid units of bright light to emit on systems without light source configuration.",
+	"torch.settings.fallbackDimRadius.name": "Fallback Dim Light Radius",
+	"torch.settings.fallbackDimRadius.hint": "How many grid units of dim light to emit on systems without light source configuration.",
+	"torch.help.turnOffAllLights": "Erzwingen Sie Hell- und Dimmwerte für die konfigurierten Werte \"Aus\".",
+	"torch.help.holdCtrlOnClick": "Halte <span class=\"key\">Ctrl</span> beim Klick",
 	"torch.help.supplyExhausted.title": "Vorrat erschöpft",
 	"torch.help.supplyExhausted.body": "<p>Die Lichtquelle ist ein Verbrauchsgegenstand und es sind keine Gegenstände mehr übrig. Erhöhe die Anzahl der Gegenstände, um eine neue zu entzünden.</p>",
 	"torch.help.setupSources.title": "Konfiguration von Lichtquellen",

lang/en.json

@@ -2,26 +2,26 @@
 	"I18N.LANGUAGE": "English",
 	"I18N.MAINTAINERS": ["Lupestro"],
 
-	"torch.playerTorches.name": "Player Torches",
-	"torch.playerTorches.hint": "Allow players to toggle their own torches.",
-	"torch.brightRadius.hint": "How many grid units of bright light to emit.",
-	"torch.dimRadius.hint": "How many grid units of dim light to emit.",
-	"torch.gmUsesInventory.name": "GM Consumes Inventory",
-	"torch.gmUsesInventory.hint": "If set, when the GM toggles a torch, it will reduce the actor's inventory.",
-	"torch.gmInventoryItemName.name": "Inventory item name to use",
-	"torch.gmInventoryItemName.hint": "Name of the inventory item to consume if \"GM Consumes Inventory\" is set.",
-	"torch.turnOffAllLights": "Force bright and dim to configured \"off\" values.",
-	"torch.holdCtrlOnClick": "Hold <span class=\"key\">Ctrl</span> on Click",
-	"torch.dancingLightVision.name": "Give Dancing Lights Vision.",
-	"torch.dancingLightVision.hint": "When enabled, each dancing light has vision so can be used to reveal areas of the map players can't actually see.",
-	"torch.playerUsesInventory.name": "Player Consumes Inventory",
-	"torch.playerUsesInventory.hint": "If set, when the player toggles a torch, it will reduce the actor's inventory.",
-	"torch.gameLightSources.name": "Additional Light Sources",
-	"torch.gameLightSources.hint": "JSON file containing additional light sources to use beyond those supplied",
-	"torch.brightRadius.name": "Bright Light Radius",
-	"torch.dimRadius.name": "Dim Light Radius",
-	"torch.ignoreEquipment.name": "Ignore Equipment",
-	"torch.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gameLightSources.name": "Additional Light Sources",
+	"torch.settings.gameLightSources.hint": "JSON file containing additional light sources to use beyond those supplied",
+	"torch.settings.playerTorches.name": "Player Torches",
+	"torch.settings.playerTorches.hint": "Allow players to toggle their own torches.",
+	"torch.settings.ignoreEquipment.name": "Ignore Equipment",
+	"torch.settings.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gmUsesInventory.name": "GM Consumes Inventory",
+	"torch.settings.gmUsesInventory.hint": "If set, when the GM toggles a torch, it will reduce the actor's inventory.",
+	"torch.settings.playerUsesInventory.name": "Player Consumes Inventory",
+	"torch.settings.playerUsesInventory.hint": "If set, when the player toggles a torch, it will reduce the actor's inventory.",
+	"torch.settings.dancingLightVision.name": "Give Dancing Lights Vision.",
+	"torch.settings.dancingLightVision.hint": "When enabled, each dancing light has vision so can be used to reveal areas of the map players can't actually see.",
+	"torch.settings.fallbackSourceName.name": "Fallback Source Name",
+	"torch.settings.fallbackSourceName.hint": "Name to show for fallback light source.",
+	"torch.settings.fallbackBrightRadius.name": "Fallback Bright Light Radius",
+	"torch.settings.fallbackBrightRadius.hint": "How many grid units of bright light to emit on systems without light source configuration.",
+	"torch.settings.fallbackDimRadius.name": "Fallback Dim Light Radius",
+	"torch.settings.fallbackDimRadius.hint": "How many grid units of dim light to emit on systems without light source configuration.",
+	"torch.help.turnOffAllLights": "Force bright and dim to configured \"off\" values.",
+	"torch.help.holdCtrlOnClick": "Hold <span class=\"key\">Ctrl</span> on Click",
 	"torch.help.supplyExhausted.title": "Supply Exhausted",
 	"torch.help.supplyExhausted.body": "<p>Your light source is consumable and your quantity has dropped to zero. Increase the quantity of the item to light a fresh one.</p>",
 	"torch.help.setupSources.title": "Setting Up Light Sources",

lang/es.json

@@ -2,26 +2,26 @@
 	"I18N.LANGUAGE": "Español",
 	"I18N.MAINTAINERS": ["Deuce", "@Viriato139ac#0342"],
 
-	"torch.playerTorches.name": "Antorchas de los jugadores",
-	"torch.playerTorches.hint": "Permite que los jugadores activen y desactiven sus propias antorchas",
-	"torch.brightRadius.hint": "Número de unidades en la rejilla en las que se emite luz brillante",
-	"torch.dimRadius.hint": "Número de unidades en la rejilla en las que se emite luz tenue",
-	"torch.gmUsesInventory.name": "El GM consume el inventario",
-	"torch.gmUsesInventory.hint": "Si se activa, cuando el GM activa una antorcha, reducirá el inventario del actor.",
-	"torch.gmInventoryItemName.name": "Nombre del objeto en el inventario",
-	"torch.gmInventoryItemName.hint": "Nombre del objeto en el inventario que se consume cuando se activa \"El GM consume el inventario\"",
-	"torch.turnOffAllLights": "Forzar a valores \"off\" tanto en la emisión brillante como en la tenue",
-	"torch.holdCtrlOnClick": "Mantener pulsado <span class=\"key\">CTRL</span> al hacer clic",
-	"torch.dancingLightVision.name": "Dar visión a las luces danzantes",
-	"torch.dancingLightVision.hint": "Cuando se activa, cada luz danzante tendrá visión, por lo que puede utilizarse para revelar zonas del mapa que los jugadores no pueden ver.",
-	"torch.playerUsesInventory.name": "El jugador consume el inventario",
-	"torch.playerUsesInventory.hint": "Si se activa, cuando el jugador activa una antorcha, reducirá el inventario del actor.",
-	"torch.gameLightSources.name": "Fuentes de luz adicionales",
-	"torch.gameLightSources.hint": "Archivo JSON que contiene fuentes de luz adicionales a las especificadas",
-	"torch.brightRadius.name": "Radio de luz brillante",
-	"torch.dimRadius.name": "Radio de luz tenue",
-	"torch.ignoreEquipment.name": "Ignore Equipment",
-	"torch.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gameLightSources.name": "Fuentes de luz adicionales",
+	"torch.settings.gameLightSources.hint": "Archivo JSON que contiene fuentes de luz adicionales a las especificadas",
+	"torch.settings.playerTorches.name": "Antorchas de los jugadores",
+	"torch.settings.playerTorches.hint": "Permite que los jugadores activen y desactiven sus propias antorchas",
+	"torch.settings.ignoreEquipment.name": "Ignore Equipment",
+	"torch.settings.ignoreEquipment.hint": "Offer light sources regardless of actor's owned equipment",
+	"torch.settings.gmUsesInventory.name": "El GM consume el inventario",
+	"torch.settings.gmUsesInventory.hint": "Si se activa, cuando el GM activa una antorcha, reducirá el inventario del actor.",
+	"torch.settings.playerUsesInventory.name": "El jugador consume el inventario",
+	"torch.settings.playerUsesInventory.hint": "Si se activa, cuando el jugador activa una antorcha, reducirá el inventario del actor.",
+	"torch.settings.dancingLightVision.name": "Dar visión a las luces danzantes",
+	"torch.settings.dancingLightVision.hint": "Cuando se activa, cada luz danzante tendrá visión, por lo que puede utilizarse para revelar zonas del mapa que los jugadores no pueden ver.",
+	"torch.settings.fallbackSourceName.name": "Fallback Source Name",
+	"torch.settings.fallbackSourceName.hint": "Name to show for fallback light source.",
+	"torch.settings.fallbackBrightRadius.name": "Fallback Bright Light Radius",
+	"torch.settings.fallbackBrightRadius.hint": "How many grid units of bright light to emit on systems without light source configuration.",
+	"torch.settings.fallbackDimRadius.name": "Fallback Dim Light Radius",
+	"torch.settings.fallbackDimRadius.hint": "How many grid units of dim light to emit on systems without light source configuration.",
+	"torch.help.turnOffAllLights": "Forzar a valores \"off\" tanto en la emisión brillante como en la tenue",
+	"torch.help.holdCtrlOnClick": "Mantener pulsado <span class=\"key\">CTRL</span> al hacer clic",
 	"torch.help.supplyExhausted.title": "Suministro agotado",
 	"torch.help.supplyExhausted.body": "<p>Tu fuente de luz es consumible y su cantidad ha bajado a cero. Aumenta la cantidad del objeto para encender una nueva.</p>",
 	"torch.help.setupSources.title": "Configuración de las fuentes de luz",