Skip to content

Commit

Permalink
Updated the README.md to cover a variety of things that have come up …
Browse files Browse the repository at this point in the history
…in the issues discussions. (Also updated the language stats to reflect the new setting just added.)
  • Loading branch information
lupestro committed Jan 12, 2025
1 parent 363c75c commit f2f8397
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
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.)

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.

Expand All @@ -25,9 +25,27 @@ Out of the box, the following are available:
| demonlord | Candle, Lantern, Spotlight Lantern, Torch
| wwn | Torch, Lantern, Flamesight, The Light of Faith

This module just sheds light from the location of a player token upon demand based upon equipment inventory. It is recommended *not* to use this module for spells or equipment that have other capabilities you intend to use, like performing damage or setting down the equipment, but to rely upon other common approaches, like active effects or item piles, for those.
This module works by changing the token's light settings, so the only properties you can control are those available to a token, not those available to a light as created in Lighting Controls.

Because the light source to use is now user-configurable, we no longer select a light source for you based on fallbacks. As it stands, if you do not explicitly select your light source, it will pick any among the light sources you have equipped, in no particular order.
This module sheds light from the location of a player token upon demand based upon equipment inventory. It is recommended *not* to use this module for spells or equipment that have other capabilities you intend to use, like performing damage or setting down the equipment, but to rely upon other common approaches, like active effects or item piles, for those.

Because the light source to use is now user-configurable, we no longer select a light source for you based on fallbacks. As it stands, if you do not explicitly select your light source, it will pick any among the light sources you have equipped, in no particular order. To work around this, just right click the torch icon and select one.

Also, light source identification is by name and the built-in light sources are in English. This means you may need to create a custom light source file to supply aliases in the language in which you're playing the game. Of course, if I were provided the localized names, localized aliases *could* find their way into the built-in list over time as well, streamlining play.

When you turn off a light source, it resets the token's light settings to the settings of the actor's prototype token. This offers a footgun: If you "Assign Token" the prototype token from a token that has a torch turned on, those light settings end up in the prototype token and it will appear that you can no longer turn your torch offf. To correct this, you have to clean up the light settings on the prototype token by hand so that your token turns off properly. To avoid this hassle, "Torch off" the token you've so carefully prepared before clicking "Assign Token" on your prototype token.

## Game settings

Besides the user light source file described in the following section:

* We ordinarily decrease the quantity of consumable light sources on every use. We provide an option to suppress this, so characters don't have to keep track of how many they've got and buy more torches or candles when they're in town.
* We now also provide a game-wide option for completely ignoring the player's equipment list, making it possible for any player to pick any light source defined in the system.
* And, as has been true from the beginning, there is an option so that only a GM can light a character's torch, thereby ensuring the players are forced to rely upon the thief's flickering candle in that dark, spooky dungeon.

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.)

## Customizing light sources

Expand Down Expand Up @@ -193,15 +211,15 @@ The following is the current status of translation. Some features have arrived,

| Language | Completion | Contributors |
| -------- | ---------- | ------------ |
| de | `[######################]` 22/22 (100%) | ToGreedy, Beff42 |
| en | `[######################]` 22/22 (100%) | deuce, lupestro |
| es | `[######################]` 12/22 (100%) | lozanoje, WallaceMcGregor |
| fr | `[##################----]` 18/22 (82%) | Aymeeric |
| it | `[######################]` 22/22 (100%) | GregoryWarn |
| ja | `[######################]` 22/22 (100%) | doumoku |
| pt-br | `[######################]` 22/22 (100%) | Innocenti, Andersants |
| zh-cn | `[##########------------]` 10/22 (56%) | xticime |
| zh-tw | `[############----------]` 12/22 (45%) | zeteticl |
| 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 |

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.

Expand Down

0 comments on commit f2f8397

Please sign in to comment.