OverheadNotesPlugin

Overhead Notes Plugin

This unofficial TaleSpire plugin for adding text to minis and converted-props. Options are available for

player visible text above the mini and GM only text beside the mini. A mini can have either or both.

This plugin replaces the GM Info Plugin and the States Plugin by using the streamlined architecture of

GM Info Plugin 3.0.0 and combining it with the functionality of States Plugin also implemented using the

streamlined architecture.

Change Log

1.4.0: Updated for compatibility with VR Taleweaver update

1.1.0: Added clear notes function

1.0.1: Improved auto height detection

1.0.1: Added option for manual height

1.0.1: Unified visibility and rotation updates

1.0.0: Initial release

Install

Install using R2ModMan or similar.

Usage

Add Player Note

Press the shortcut key to activate the Player Note dialog or select the Player Note from the right click

radial context menu. Enter the desired note. Commas get translated to new lines. The text will appear above

the mini. If any of the keywords in the text matches the (optional) colorization file, the replacements

will be processed. This typiclaly allows keywords to be colorized.

To erase a Player Note, open the Player Note dialog (same as above) and then press the Clear button.

Player Notes are visible to all players (and the GM).

Default: `LCTRL+N`

Add GM Note

Press the shortcut key to activate the GM Note dialog or select the GM Note from the right click radial

context menu. Enter the desired note. Commas get translated to new lines. The text will appear beside

the mini. If any of the keywords in the text matches the (optional) colorization file, the replacements

will be processed. This typiclaly allows keywords to be colorized.

To erase a GM Note, open the Player Note dialog (same as above) and then press the Clear button.

GM Notes are visible to the GM only. Any player currently in the GM role will see these notes.

Default: `LALT+N`

Clear All Notes

Pressing the shortcut to activate this functions clears both the player and GM notes on the selected

mini. There is no undo so be careful with this feature.

Default: `RSHIFT+N`

Re-Apply Notes

Due to the way the streamline architecture handles board loads, this function should not be necessary.

However, if the notes fail to show, you can try re-applying them with this function.

Default: `RCTRL+N`

Performance

On Startup

When a board loads, the assets are not immediately available. This means that when a board loads the

plugin needs to try to figure out when all of the assets have properly loaded. This is basically a trial

and error process. There are two configruations associated with this process. The issue is that if the

plugin tries to hard, it will eat up all the CPU and TS will never actually be able to complete the board

load (or it will take a very long time). If the plugin doesn't try hard enough then it will take a long

time after the board load before all of the texts appear. The configurational parameters are:

Update Interval = The time that the plugin waits before trying to process texts. If it is unable to process

at least one text then it will try again, to do the remained, after the same update interval. It will

continue to try to process the board load texts at this interval until all have been processed. Setting this

value too low means that the plugin is constantly trying and not leaving CPU to TS to actually process the

board load. Setting this value too high means text will take a long time to load.

Update Throttle = This is the maximum number of text updates that the plugin performs per Update Interval.

Setting this value high will process more text per udpate cycle but use more CPU. Setting this value too

low will mean that it take a long time for text to be updated on board load.

On high performance devices, the Update Interval can be set low (e.g. 1 second) while the Update Throttle

can be set high (e.g. 100).

On low performance devices, the Update Interval can be set high