Skip to content

Commit

Permalink
v2.0.1 (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
EddieDover authored Feb 5, 2024
1 parent 9e546be commit d270ac4
Show file tree
Hide file tree
Showing 40 changed files with 866 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
labels: 'bug'
assignees: ''

---
Expand Down
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/template_submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Submit a template
about: Submita template for a new or existing system.
title: 'Template Submission: <SYSTEM_NAME>'
labels: 'new_template'
assignees: ''

---

Please attach a zip file with the following:
- Your tested & working JSON file, filename all lowercase.
- A jpg of your template where the file name is the same as your json but ending in jpg.

E.g. if you submit eddies-dnd5e-template.json, then your image file should be named eddies-dnd5e-template.jpg

**If you feel so inclined, you may also opt to submit your json and image file as a Pull Request.**

If you do, please also edit the TEMPLATE_LIST.json, following the existing standards provided.
47 changes: 21 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Foundry Hub Endorsements](https://img.shields.io/endpoint?logoColor=white&url=https%3A%2F%2Fwww.foundryvtt-hub.com%2Fwp-json%2Fhubapi%2Fv1%2Fpackage%2Ftheater-of-the-mind%2Fshield%2Fendorsements)](https://www.foundryvtt-hub.com/package/theater-of-the-mind/)
[![Foundry Hub Comments](https://img.shields.io/endpoint?logoColor=white&url=https%3A%2F%2Fwww.foundryvtt-hub.com%2Fwp-json%2Fhubapi%2Fv1%2Fpackage%2Ftheater-of-the-mind%2Fshield%2Fcomments)](https://www.foundryvtt-hub.com/package/theater-of-the-mind/)

This module provides a GM with a table of characters, online only, or all, configurable in settings, in order to quickly see important stats, traits, abilites, etc. of all characters. Originally 5e only, it is now system agnostic and you can create easy to make .json templates for your system. It supports native Foundry and The Forge. Complete instructions for creating templates and placing them in the right folder on Foundry and Forge are included in the [SYSTEMS.MD] file.
This module provides a GM with a table of characters, online only, or all, configurable in settings, in order to quickly see important stats, traits, abilites, etc. of all characters. Originally 5e only, it is now system agnostic and you can create easy to make .json templates for your system. It supports native Foundry and The Forge. Complete instructions for creating templates and placing them in the right folder on Foundry and Forge are included in the [TEMPLATE_README.md] file.

The original intent of this module was to provide a 'party view' feature that I found missing when I first started using [FoundryVTT](https://www.foundryvtt.com) instead of [Fantasy Grounds](https://www.fantasygrounds.com). It will be updated with features that I personally want or need, or are requested of me by some poor soul. Several templates for various systems have been created, and more are already in the works with even more planned.

Expand All @@ -13,52 +13,47 @@ If you create a template, please submit it via email, Discord or GitHub as a Pul
## Features
- Adds a 'Party Sheet' similar to that provided by Fantasy Grounds. Just click the Party Sheet icon on the Tokens Controls sub-menu.

- The Party Sheet can be configured via the options to either display only currently connected players, or all non-npc characters. When using the all-characters display, there is a separate dialog to allow hiding of any characters the DM doesn't need to worry about. See the [SYSTEMS.md](SYSTEMS.md) file for instructions on how to create a json file for your own system.
- The Party Sheet can be configured via the options to either display only currently connected players, or all non-npc characters. When using the all-characters display, there is a separate dialog to allow hiding of any characters the DM doesn't need to worry about. See the [TEMPLATE_README.md](TEMPLATE_README.md) file for instructions on how to create a json file for your own system.

- Clicking a character portrait will open their sheet.

- The Party Sheet is no longer bound to simply the built-in dnd5e system. Additional systems can be supported by writing a JSON file following the guidelines in [SYSTEMS.md](SYSTEMS.md) and placing it in either:
- The Party Sheet is no longer bound to simply the built-in dnd5e system. Additional systems can be supported by writing a JSON file following the guidelines in [TEMPLATE_README.md](TEMPLATE_README.md) and placing it in either:

- Native Foundry: your <FOUNDRY_VTT/Data/totm/> folder.
- The Forge: the folder named [totm] at the top level of your assets library (created by the module).

- Sound effects support if you have Syrinscape ([fvtt-syrin-control](https://github.com/frondeus/fvtt-syrin-control)) and Midi QOL ([midi-qol](https://gitlab.com/tposney/midi-qol/)) installed.

# Support
## Systems & Templates

Feel free to file a Bug Report / Feature Request under the Issues tab of Github.
### Template Examples

Or you can join my **Discord** server here: https://discord.gg/XuGx7zNMKZ
For a comprehensive list of the pre-made templates provided by this module and screenshots of each, please see **[TEMPLATE_LIST.md](TEMPLATE_LIST.md)** or examine the contents of the [example_templates](https://github.com/EddieDover/Theater-of-the-Mind/example_templates) folder.

# Screenshots
### Making your own system template

Primary Icon:
Please see the [TEMPLATE_README.md](TEMPLATE_README.md) for information on how to create your own template.

![Party Sheet Icon](images/psi.png)
### Template Installation

Only Connected Players:
If using native **Foundry**, place the templates you wish to use in the <FOUNDRY_VTT/Data/totm/> folder.

![Preview of Plugin Party Sheet - Only Connected Players](images/preview1.png)
If using **The Forge**, this module will create a folder at the top level of your Assets Library named `totm`. Place your templates in this folder.

Specific Characters
If using The Forge, install the module on your local Foundry installation to have access to the [example_templates] folder, and to upload any you would like to use to your Assets Library in the <totm> folder at the top level. Or, if you haven't installed Foundry and only used the license key on The Forge, use the GitHub link above. In this case, you will have to download the file to your computer, then upload it to The Forge. If you create a template, please submit it via email, Discord or GitHub, and we will include it in future updates with full credit.

![Preview of Plugin Party Sheet - Specific Actors](images/preview2.png)
# Support

# Supported Systems
Feel free to file a Bug Report / Feature Request under the Issues tab of Github.

Built in (by Eddie Dover):
- DnD5e "dnd5e" - Note: this does not require any upload of a .json, but you can make your own or edit the example in the [example_templates] folder to your liking and it will show up in the dropdown of available .json files
Or you can join my **Discord** server here: https://discord.gg/XuGx7zNMKZ

Templates by Michael Card (Emo Cthulhu):
- Alien RPG "alienrpg"
- Blade Runner RPG "blade-runner"
- Dragonbane "dragonbane"
- Starfinder "sfrpg"
- The Walking Dead Universe RPG "twdu"
- Vaesen "vaesen"
# Screenshots

- In Progress: Coriolis "yzecoriolis", Fallout 2d20 "fallout", Cyberpunk RED "cyberpunk-red-core"
Primary Icon:

- Planned: Pathfinder 1e, Pathfinder 2e
![Party Sheet Icon](images/psi.png)

Party Sheet Window:

Please see the [SYSTEMS.md](SYSTEMS.md) file for how to use the provided templates and install them in the correct directory. Theater of the Mind supports Forge installations, and information in these documents will let you know what you have to do differently on native Foundry and The Forge.
![Preview of Plugin Party Sheet - Only Connected Players](images/preview1.png)
103 changes: 103 additions & 0 deletions TEMPLATE_LIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Theater Of the Mind Template List

Please unfold any entry to see a screenshot.

## DnD5e "dnd5e"

<details>

![](./images/preview1.png)
<summary>
Built-In & dnd5e_template.json (Eddie Dover)
<br/>
- Note: this does not require any upload of a .json, but you can make your own or edit the examples in the [example_templates] folder to your liking and it will show up in the dropdown of available .json files
</summary>
</details>

<details>

![](./example_templates/dnd5e/dnd5e_modified.jpg)

<summary>dnd5e_modified.json - Michael Card (Emo Cthulhu)</summary></details>

## Alien RPG "alienrpg"

<details>

![](./example_templates/alienrpg/alienrpg.jpg)

<summary>
alienrpg.json - Michael Card (Emo Cthulhu)<br/>_Note: any changes needed for Building Better Worlds will be available in next update._</summary>
</details>

## Blade Runner RPG "blade-runner"

<details>

![](./example_templates/blade-runner/blade-runner-basic.jpg)

<summary>blade-runner-basic.json - Michael Card (Emo Cthulhu)</summary></details>

<details>

![](./example_templates/blade-runner/blade-runner-expanded.jpg)

<summary>blade-runner-expanded.json - Michael Card (Emo Cthulhu)</summary></details>

## Dragonbane "dragonbane"

<details>

![](./example_templates/dragonbane/dragonbane-name.jpg)

<summary>dragonbane-name.json - Michael Card (Emo Cthulhu)</summary></details>

<details>

![](./example_templates/dragonbane/dragonbane-no-name.jpg)

<summary>dragonbane-no-name.json - Michael Card (Emo Cthulhu)</summary></details>

## Fallout 2d20 "fallout"

<details>

![](./example_templates/fallout/fallout.jpg)

<summary>fallout.json - Michael Card (Emo Cthulhu)</summary></details>

## Starfinder "sfrpg"

<details>

![](./example_templates/starfinder/starfinder.jpg)

<summary>starfinder.json - Michael Card (Emo Cthulhu)</summary></details>

## The Walking Dead Universe RPG "twdu"

<details>

![](./example_templates/thewalkingdead/twdu-anchors.jpg)

<summary>twdu-anchors.json - Michael Card (Emo Cthulhu)</summary></details>

<details>

![](./example_templates/thewalkingdead/twdu-no-anchors.jpg)

<summary>twdu-no-anchors.json - Michael Card (Emo Cthulhu)</summary></details>

<details>

![](./example_templates/thewalkingdead/twdu-two-rows.jpg)

<summary>twdu-two-rows.json - Michael Card (Emo Cthulhu)</summary></details>

## Vaesen "vaesen"

<details>

![](./example_templates/vaesen/vaesen.jpg)

<summary>vaesen.json - Michael Card (Emo Cthulhu)</summary></details>
17 changes: 16 additions & 1 deletion SYSTEMS.md → TEMPLATE_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,20 @@ In this example, the system will contain a column named Career, but the column n

## Examples

### Example of array-string-builder:

Code:
```json
{
"name": "Statuses",
"type": "array-string-builder",
"header": "show",
"text": "statuses => value, "
}, // No comma if last item in the row
```

This example is used to display Active Status Effects on a character, such as burning, bleeding, prone, etc. They are stored by Foundry under the actor as `.statuses`, and the value is an array of strings. To display an array of values with no definite end or number of values or even empty sometimes, array-string-builder is your weapon of choice.

### Extremely Basic File Example
Code:
```json
Expand Down Expand Up @@ -327,7 +341,8 @@ Result:

* Module Conflicts:
- Arius Planeswalker's Stylish Journal for Monk's Enhanced Journal - changes the CSS so dramatically that tables will not render correctly.
- Possible issues with Token Attacher tokens - in testing some MAD Cartographer maps caused the tokens that come with the map modules would show up in the Party Sheet, despite having proper excludes in the header of the .json. It is not an issue with MAD Cartographer maps or their dependencies, it seems to be another module that causes these Actors not to import properly. As soon as the offending module is found it will be listed here.
- An issue with MAD Cartographer map modules. Due to sloppy data on the part of those at The MAD Cartographer, some of their modules have the `type` set to character for map actor tokens. These will show up in your player sheet, and you have to manually hide them. It varies from module to module. Deserts is one, luckily you only have to hide 4 actors by using the [Configure Hidden Actors] button, or doing it in settings.
- dnd5e system v3.0.0: sounds are unavaible currently due to the massive system overhaul breaking Dynamic Active Efects and thus MidiQoL. TotM will not render a table properly in v3.0.0 if Dynamic Active Effects is active. The author has recently made them unavailable in v3.0.0, but has not mentioned any timeline for making these modules compatible with 3.0.0.
* CSS:
- Some system developers are bound and determined to change everything about default Foundry css just because they can (I'm looking at you, Free League Publishing), so while every effort has been made to make the tables look the same between systems, you may see some that are quite different (I'm looking at you, Vaesen).
- That said, the module can only accommodate some minimal alignment and visual improvements. To try and override every system out there would be impossible. There is no intention to allow more than minwidth/maxwidth, align and valign.
Expand Down
Binary file added example_templates/alienrpg/alienrpg.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,15 @@
"valign": "top",
"header": "show",
"text": "WIT: system.attributes.wit {newline} {newline} Obs: system.skills.observation / system.skills.observation {+} system.attributes.wit {newline} Sur: system.skills.survival / system.skills.survival {+} system.attributes.wit {newline} CT: system.skills.comtech / system.skills.comtech {+} system.attributes.wit"
},
{
"name": "Statuses",
"type": "array-string-builder",
"align": "left",
"valign": "top",
"maxwidth": 125,
"header": "show",
"text": "statuses => value, "
}
]
]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,15 @@
"header": "show",
"text": "EMP: d system.attributes.emp {newline} {newline} Con: d system.skills.connections / d system.skills.connections.value + d system.attributes.emp.value {newline} Ins: d system.skills.insight / d system.skills.insight + d system.attributes.emp {newline} Man: d system.skills.manipulation / d system.skills.manipulation + d system.attributes.emp"
},
{
"name": "Statuses",
"type": "array-string-builder",
"align": "left",
"valign": "top",
"maxwidth": 70,
"header": "show",
"text": "statuses => value, "
},
{
"name": "Chin",
"type": "direct",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -1091,6 +1091,15 @@
}
]
},
{
"name": "Statuses",
"type": "array-string-builder",
"align": "left",
"valign": "top",
"maxwidth": 70,
"header": "show",
"text": "statuses => value, "
},
{
"name": "Chin",
"type": "direct",
Expand Down
Binary file added example_templates/dnd5e/dnd5e_modified.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d270ac4

Please sign in to comment.