LordAshes-GMInfoPlugin icon

GMInfoPlugin

Allows GM to add text to minis and props similar to States Plugin but visible to GM only

Last updated 2 months ago
Total downloads 1622
Total rating 0 
Categories Minis Tools Integration Tweaks Networked
Dependency string LordAshes-GMInfoPlugin-3.0.0
Dependants 0 other mods depend on this mod

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-AssetDataPlugin-2.0.2 icon
LordAshes-AssetDataPlugin

Dependency plugin for subscription/notification based data storage and message exchange.

Preferred version: 2.0.2
LordAshes-FileAccessPlugin-1.4.1 icon
LordAshes-FileAccessPlugin

Provides standardized methods for accessing both local file and url resources. Automatically handles searching local folders for assets.

Preferred version: 1.4.1
HolloFox_TS-RadialUIPlugin-2.2.3 icon
HolloFox_TS-RadialUIPlugin

This is a developer tool based package used to help devs easily configure UI Radial Menus.

Preferred version: 2.2.3

README

GM Info Plugin

This unofficial TaleSpire plugin for adding text to minis and converted-props which only the GM can see. Can be used on player visible props like chests to provide GM only information about the player visible properly or on props that are hidden to provide the GM with notes (visible all the time).

Change Log

3.0.0: Streamlined for performance
2.3.0: Added manual re-apply
2.3.0: Streamlined processing
2.2.0: Optimized Lookup for GM States Text
2.1.0: Fix for Cyberpunk update
2.0.0: Fix for BR HF Integration update
1.0.0: Initial release

Install

Install using R2ModMan or similar.

Usage

Press the shortcut key to activate the GM Info or use the radial menu to select GM Tools and then Info. Enter the text to be shown at the prompt. To create multiple lines of text, use commas to seperate the each line.

Default: LCTRL+G

The Remove option on the prompt can be use to remove GM info.

To re-apply GM Info if it does not get applied automatically after board load, use the re-apply shortcut. Do to the way that the plugin now handles board loads, this should not be necessary but it is there just in case.

Default: RCTRL+G

Performance Optimization

The plugin only performs visual updates when necessary. While idle, the update loop does nothing but check for the keyboard triggers and for mouse movement.

When GM Info is added to an asset it is always fully refreshed.

When the GM/Player Mode changes, the visibility of all assets is updated.

When the mouse is dragged or when the keyboard is used, the rotation of assets is updated based on the update setting set in the configuration for the plugin. These settings are follows:

None = Text Blocks rotation (to face the screen) is not done. Selected = Text Blocks rotation (to face the screen) is done to the currently selected mini only. All = Text Blocks rotation (to face the screen) is done to all mini that have Text Blocks.

This setting can be further used to control performane. With on-demand updates only this plugin should run fairly smooth on most device but this configuration can be used to tweak performance. If you have a high performance device then set this option to "all". This will keep all Text Block rotated towards the screen at all times. If you have a medium performance device, try the "selected" option. This will lower the CPU requirement but at least keep the selected mini's Text Block facing the screen. If you have a low performance device then try the "none" setting. This will not rotate Text Block to face the screen but will use the least amount of CPU.

Appearance

The size and offset of the text can be configured in the configuration. If you have a smaller or larger screen the font size can be adjusted but then the offset per line will need to also be adjusted in order to make the text appear correctly. To properly calibrate these settings, do the following:

  1. Add a single line of text and see that it shows up just above the mini.
  2. Change the text to 5 or more lines and see if the the bottom of the text still shows up just above the mini.

If the text increases the gap between the mini and the text when more lines are added the per line offset setting needs to be made smaller. If the lines of go into the mini, the per line offset needs to be increased.

Typical Scenario 1: Use With Player Visible Items

In this scenario the GM has a player visible prop like a chest and want to note down the contents of the chest. The GM can add a GM Info note to the chest which will be visible to the GM only but not to the players.

Typical Scenario 2: Use With Player Invisible Items

In this sceanrio the GM wants to leave some notes for himself but they are not assocaited with any particular visible prop. In such a case the GM can add a prop or mini, and a GM Info note to the prop or mini and then hide it. In such a case the players will not see either the prop or mini used for the note nor the note itself. Please note that in this scenario the note will be visible to the GM at all times.

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2022-10-13 3.0.0 266 Version 3.0.0 Install
2022-10-11 2.3.0 43 Version 2.3.0 Install
2022-10-11 2.2.0 13 Version 2.2.0 Install
2022-9-3 2.1.0 246 Version 2.1.0 Install
2022-6-5 2.0.0 401 Version 2.0.0 Install
2021-8-12 1.0.0 653 Version 1.0.0 Install