LichFactory-Games / TotM-Manager

A theatre of the mind manager for Foundry VTT
GNU General Public License v3.0
4 stars 2 forks source link

Theater of the Mind Manager (TotM Manager)

TotM Manager is designed to help you, the GM, manage visual and thematic elements for theater of the mind style play in Foundry VTT.

The module allows you to:

  1. Add individual images or directories of images to a tile
  2. Preview and switch between images on a tile
  3. Link specific light configurations, playlists, or macros to specific images or tiles
  4. Select between tiles via tags (and the Tagger module)
  5. Add effects to a tile (via Token Magic)

You can also tag lights and sounds to run with particular images, so that when you switch to those images the lighting changes, or sounds are played, or macros run (or all three). All this effectively allow you to change the scenery without changing the Foundry scene.

All tags and image data are stored in the metadata of the tiles, so nothing is altered in your actual files. To add the module in Foundry go to the Foundry "Manifest URL" field in the "Install Module" window and paste: https://raw.githubusercontent.com/LichFactory-Games/TotM-Manager/latest/module.json. Or you can manually download a release from the releases tab.

As mentioned above, the module has three dependencies for proper functioning -- Tagger, Token Magic, and libWrapper.

Here you can see an example of a scene set using three tiles and the TotM Manager.

TotM Overview

How To Use TotM Manager

The manager is designed to work with tagged tiles you create. First you need to create a tile (or tiles) on canvas as you normally would, adding a tagger tag. Then you may open TotMM and create tiles in the tiles tab. Tile names that you make in TotMM have to match tiles that have been tagged by Tagger. You won't be able to save a tile configuration in TotMM unless you have tiles with matching tags that exist on the game canvas. Here is a video showing a simple setup case.

TotM Creating Tiles

There are three tabs. The 'stage' tab is where you can add, cycle through, and delete images from tiles. You may also hide or reveal a tile from this tab. The 'tiles' tab is where you add or delete tiles from the manager (though not from the canvas itself). You can also control the opacity or tint of a tile from here. Finally, the 'effects' tab allows you to add or delete effects from a tile. You may select from any of the effects provided by token magic. You can also modify the effects before you apply them by directly changing the json data. You can see some examples of adding images and effects below.

TotM Adding Images TotM Add Effects

In the center of the stage tab's window is the image list itself. Images may be reordered by dragging and dropping. Each image may be previewed by hovering over its name field. If the user would like to link a particular light setup or anything else that can be tagged, the next field allows a list of tags.

Tag Example

For example, let's say you have two images, A and B. You want image A to have pulsing red lighting, while image B should be placid with normal white light. You can accomplish this by setting up the pulsing red lighting for A and the normal white lighting for B (positioned however you want). You then tag all the lights with the tag "totmLight" and use a specific tag, such as "pulse" for A's lights, and another tag, such as "normal", for B's lights. In the tag fields for the images in the TotM Manager window you would put "totmLight" and the respective tags for A and B. Then, when activating each image only lights matching the tags in that image's tag field will light. You can do something similar for sounds or anything else that takes a tag.

TotM Manager can also attach specific playlists or macros to images so long as you have their respective IDs. In the image tags field you can add playlists by using the tag 'play-ID' and call a macro using the tag 'macro-ID'. This allows you to, for example, have images where the lights do a flicker effect while a thunder playlist plays.

Note that the scene must be active for lights and related effects to trigger by image.

Be sure to save any changes you make to an image by pressing the 'Save' button!

Search

If you have a tile with a lot of images you may find searching by image name or tag helpful. There is a search bar immediately above the image list that you can use to navigate images. It will give you a preview of all candidates. Press Enter to activate the first image in the list. You may also click on any image returned in the search to activate it.

Settings

Settings right now are limited to keybindings (Ctrl-T for the window; Ctrl-F for search), initial tile name, and image preview size.

Feature Roadmap

The following features are ones I would consider adding at some point.

Thanks

Special thanks to Monk's Active Tile Triggers and this youtube video by Axium for giving me the original idea to run theater of the mind in Foundry by manipulating tiles.

Support

Buy Me A Coffee

If you find this project helpful, please consider supporting me.