LordAshes-AssetDataPlugin icon

AssetDataPlugin

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

Last updated 4 days ago
Total downloads 33241
Total rating 2 
Categories Tweaks Networked Tools Integration Assets
Dependency string LordAshes-AssetDataPlugin-3.5.0
Dependants 57 other packages depend on this package

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-LoggingPlugin-1.0.0 icon
LordAshes-LoggingPlugin

Provides unified logging functionality

Preferred version: 1.0.0

README

Asset Data Plugin

This unofficial TaleSpire dependency plugin for storing data regarding sources like minis, boards, campaigns, groups, and anything else that has a unique id associated with it. Provides subscription functionality for notifications when data has changed which supports both specific keys and key patterns allowing for a range of subscriptions ranging from very specific to very broad. Supports both persistent and non-persistent data. Persistent data will stay associated with the source until removed and thus can be reloaded on board load or when a client connects. Non-persistent data allows the exchange of messages which should not be store. Such messages can be processed by anyone subscribing to them but are not stored so late connecting client or board load will not re-trigger them.

Automatically implements package sending so that long messages are automatically broken up into smaller messages, sent and re-asselmbed by the recipient. This means there isn't any real limit on the size of the content that can be sent.

This plugin combines the functionality of Stat Messaging, Board Persistent and a small part of Chat Service into a single dependency plugin.

This plugin, like all others, is free but if you want to donate, use: http://LordAshes.ca/TalespireDonate/Donate.php

Change Log

3.5.0: Added Rebroadcast feature
3.5.0: Migrated missed log messages to use Logging Plugin
3.4.2: Migrated to using Logging Plugin
3.4.1: Added support for forcing campaign:board for SetInfo. Allows writing campaign:board data while in main menu.
3.4.0: Updated for compatibility with Taleweaver update
3.3.1: Updated keyboard handling code
3.3.0: Updated for compatibility with BR Slab Browser update
3.3.0: Added audio warning if no configured message distributor are present
3.2.1: Removed example message distributor plugin from warning popup
3.2.0: Removed BepInEx Config check after BepInEx was patched to remove the setting
3.1.0: Added BepInEx Config check
3.0.3: Bug fix for culture issues
3.0.1: Bug fix: Loofa Patch
3.0.0: Warning: Breaking change! Older boards will load but not apply any Asset Data notifications. See notes at end of file.
3.0.0: Data is now campaign:board specific as opposed to campaign specific. This prevents the need to time out notifications
       for assets that are in the campaign but not on the current board. (Increases performance)
3.0.0: Player data syncs to GM's data if the player joins a session late and Asset Data changes have occured. This allows
       late players to be processed correctly and allows GM to setup Asset Data based stuff before session without needing
	   to share the corresponding Asset Data files.
3.0.0: Added handing of Unique creatures. Asset Data associated with a unique creature will be restored when the creature is
       moved to a different board within the same campaign.   
2.1.3: Bug Fix: Sending short messages received corrupted data
2.1.2: Bug Fix: HF assets were not loading
2.1.1: Bug Fix: Data change previous value now has value when distributed
2.1.1: Bug Fix: Campaign change no longer causes an exception
2.1.1: Bug Fix: Checker for Source And Value fixed to support value@time format
2.1.0: Added backlog buffer implementation
2.1.0: Creature remove cleans up related messages
2.0.1: Bug fix on startup which prevents a SetInfo exception
2.0.0: Fix after BR HF Integration Update
1.3.0: Added on screen diagnostics similar to those offered by Stat Messaging.
1.2.6: Better checking for missing message distributor and legacy support. Avoids exception when not available.
1.2.5: Improved message distribution analysis
1.2.4: Minor bug fixes
1.2.3: Improved debug messages to better track flow
1.2.2: Added visual message if no message distribution plugins are found
1.2.2: Bug fix for CleaInfo not clearing persistence file 
1.2.1: Minor parameter type bug fix
1.2.0: Added Legacy Stat Messaging support if Stat Messaging is present. This allows Asset Data Plugin to get Stat Messaging
       messages and provide them to client via the Asset Data Plugin interface. Legacy write is also possible.
1.1.0: Added support for other message distribution systems besides ChatService such as RPC.
1.1.0: Migrated to Campaign files for storage.
1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

This is a dependency plugin and thus is not used directly by the user. It is used by other plugins to implement various communication and data storage features.

Warning: You need at least one message distribution plugin to make this plugin work. Like any mod, current message distributors (like Chat Service) can stop working any time due to updates and new message distributors (like the anticipated EOS message distributor can be created without this document being updated. Either try message distribuotrs until you find one that works or visit the Unofficial Talespire Modding Discord and check the General and Support pinned messages to see which message distributors are working). Currently the plugin will use the first plugin in the configured list that exists on the system. If you have multiple message distribution plugins or a new one that isn't in the list, you can select the preferred plugin by re-ordering or modifying the list.

Runtime Usage

RCTRL+D = Toggle on screen diagnostics
RCTRL+F = Display screen diagnostics for specified asset (selected by name dialog entry)
RCTRL+G = Dump selected mini asset data information to the log
RALT+G = Dump entire asset data for the board to the log
RSHIFT+G = Simulate Data
RSHIFT+A = Rebroadcast Data

Toggling the on screen diagnostics will cause all of the asset data messages for the currently selected assed to be written to the top of the screen unless the currently selected asset has been overridden using the specific asset selection in which case the information for that asset is displayed instead.

Triggering the specific asset shortcuts prompts for the identification of the desired asset. If the asset exists the corresponding asset data information for it will be displayed instead of the currently selected asset. To return back to dislaying information for the currently selected asset, use this function again and then press the Clear button. Asset Data allows the storage of assets which are not necessarily associated with a selected object. For example, the plugin can store information about the board or global user preferences. This function allows the displaying of such asset information by allowing the user to select it by its identity as opposed to clicking on it.

The dump to log trigger allows all of the current asset data information (for the current board) to be dumped to the log. This allows deep analysis of all information associated with all assets on the board.

The Rebroadcast functionality allows a GM to make many plugin changes while the players are not connected and then use this functionality to push the changes to the players when they connect. For example, the GM can set up a city that has multiple assets with the Light Plugin. If these lights are turn on when the players are not connected, those lights will not turn on for the players when they connect. In such a case, the GM can press the rebroadcast keyboard shortcut and re-send all the changes to the players. Warning: To ensure that this functionality does not trip the TS chat frequency cap, the changes will be pushed out with delays in between. The default is 0.1 seconds between each send. This means that a board with logs of changes will take some time to fully sync.

Development Usage

This plugin stores information about a source using keys. A key is just a name for a piece of information and is used to identify that piece of information in read requests, write requests and notifications. For example, consider a green ball object. The source or asset would the ball which may have multiple keys of information such as color, size, shape and so on. If we want to reference the color information, for example, we would need to provide the read request with both the source (asset), in this case the ball, and the piece of information (key), in this case color.

Subscribe(*key*, *callback*);
Subscribe(*key*, *callback*, *checker*);

This is a static method so you don't need to initialize any class to do it. This method triggers the specified callback when the specified key changes on any asset. The key can be a specific key or a key pattern that uses wild cards. The most generic pattern would be * which would subscribe to all messages being set. While each plugin can subscribe to all messages and then process the ones it is interested in, this is not efficient. So instead plugins will typically use more specific keys to narrow down the messgages. For example, if a plugin is only interested in its own messages then it typically uses the plugin GUI as the key. Since a plugin's guid is unique, it means it will only get its own messages. Similarly, if a plugin wants to read messages from a different plugin, it can narrow down the messages by subscribing to the key that matches the other plugin's Guid. This is the recommended convention but not a forced convention. If a plugin requires multple keys, typically the plugin Guid is followed by a dot and a further divison of the key. This allows easy subscription to all the plugin's messages by subscribing to the plugin Guid followed by a *.

Wildcards:

* = Any number of characters including none. ? = Any one character

The checker parameter is optional. If not specified a checker is not used. If a checker is provided, each data change is queued until the data change passes the checker evaluation. Typically this is used to ensure that an asset has fully loaded before processing the data change. While it is possible to use custom checkers, two commonly needed checkers have been provided:

AssetDataPlugin.Backlog.Checker.CheckSourceAsCreature AssetDataPlugin.Backlog.Checker.CheckSourceAndValueAsCreature

The first checker verifies that the source of the data change is a valid Creature Guid and that the corresponding asset's base and body has loaded. This is the most commonly used checker to esnure that assets have loaded before plugin functionality is applied to them (e.g. notes, states, icons, lights, etc). The second checker verfies both the source and the value assuming that the value is a Creature Guid or a Creature Guid with a timsestamp appended separated by an at sign (@).

Using a checker means that the plugin can assume all assets have fully loaded by the time the data change notification is received and thus don't need to implement a backlog queue of their own.

SetInfo(*asset*, *key*, *content*);

Sets the value of the specified key for the specified asset to specified content. Unlike subscriptions, when setting values, the key must be specific key and not a key pattern. This method causes notifications to be sent out to any clients that have subscribed to this key or whose key pattern matches this key. This method stores the value under the give key for the given asset for future use and thus the value will be available to new subscribers and or on board load.

The key can either be an ordinary key or prefixed by the campaign.board with a colon between that and the ordinary key. This allows keys for specific campaign.boards to be written even if that is not the current campaign.board. This is most commonly used to write data for a campaign.board while still in the main menu.

To clear a key that is no loner needed, use the following code:

ClearInfo(*asset*, *keyName*);

It should be noted that writing empty content and clearing the content are not the same. Writing an empty value is treated the same as writing a non-empty value, the asset key will still exist in memory. Clearing the key actually removes the key from the initernal memory and from the persistent storage.

SendInfo(*key*, *content*);

This method is similar to SendInfo except that the message is not releated to a specific asset and the message is not stored. Any subscribers that subscribed to the given key or whose ket patterns matches the given key will be notified with the contents but the contents will not be stored. This method is used for real-time messaging which is not to be retained.

Reset(*subscriptionId*);
Reset(*pattern*);

These methods perform a reset associated with the given subscription id (preferred method) or the key (or key pattern). A reset will cause all of the stored data to be re-evaluated and notifications re-sent for any data that matches the subscriptions. A subscription based reset will re-notify only notifications associated with the reset subscription. A patten based reset will re-notify about any data that matches the reset pattern. There is also a general reset which resets everything but this method should not be used and has been marked as obsolete because resetting all notifications can have adverse affects on other plugins who are not expected a notification update. For example, a plugin using a specific notification as a counter would advance its counter if another notification did a mass reset.

Callback Signature

private void Callback(AssetDataPlugin.DatumChange change)

Where DatumChange has the following properties:

action indicates if the change is initial info, new info, modified info or removed info.

source indicates the unique identification of the asset with which the information is associated.

key indicates the unique identification of the information that the change involves.

previous indicates the value prior to the change

value indicates the value after the change

Examples

Subscribe(MyCustomPlugin.Guid, Callback);

Subscribe(MyCustomPlugin.Guid+".MyKey1", Callback); Subscribe(MyCustomPlugin.Guid+".MyKey2", Callback);

Subscribe(MyCustomPlugin.Guid+".*", Callback);

SetInfo("1234-56789-9001", MyCustomPlugin.Guid+".MyKey1", "Hello!"); SetInfo("1234-56789-9001", MyCustomPlugin.Guid+".MyKey2", new List(){"A","B","C"} );

SendInfo(MyCustomPlugin.Guid+".MyKey2", "Good bye!")

ClearInfo("1234-56789-9001", MyCustomPlugin.Guid+".MyKey2");

Configuring Message Distribution Plugins

The R2ModMan configruation for this plugin has a configuration which holds a list (one or more) of message distribution plugins. The plugins are named using the full qualified name (without the version and culture) and entries are separated by pipe characters (since commas are use in the qualified name). When this plugins starts up it will read through the list, in order, and check if the corresponding plugin is installed. If so, it will do a basic check to see that the plugin had the correct methods and, if the test is passed, it will use that plugin for distributing content to other clients.

This leads to two important conclusions:

  1. Additional message distribution plugins can easily be added by adding their fully qualified names into the list.
  2. The preference of which plugin to use (if multiple are installed) can be changed by re-ordering the list order.

Legacy Support

When StatMessaging is present, Asset Data will make a single subscription to Stat Messaging for all messages and then treat any noitifications as if they were Asset Data notifications. This allows Asset Data to work with plugins that use Stat Messaging.

For writing Legacy Stat Messaging messages, the SetInfo and ClearInfo methods have an optional Legacy boolean parameter which defaults to false. When set true, Asset Data will write the information out to Stat Messaging thus allowing Asset Data plugin to trigger plugins which use Stat Messaging.

Reflection Subscription

An alternative subscription method was added providing a relfection friendly subscription method. This method does the same a the regular subscription method except the instead of passing in the callback function itself, the method takes the name of the callback (static) type and the name of the callback (static) method. This allows this method to be used with reflection when trying to implement soft dependency on Asset Data plugin.

Backlog Queue

The backlog queue is transparent to the use of the Asset Data Plugin. Instead of data change notifications being sent out right away (like they were in previous versions). Data change notifications are placed in a backlog queue based on the subscription. Items in the queue are periodically processed which results in the actual notification. However, this allows the processing of the queue to implement a checker. If the subscription has not provided a checker then the data change sends out a data change notification (same as in previous versions). If a checker is provided during the subscription (either a custom one or one of the provided ones) then the data change is passed to the checker and a notification is sent out only if the checker returns true. If the checker returns false then the data change is placed on the back of the queue after having its failure count increased by one. If the failures exceeds the configured number of attemps then the item is, instead, removed from the queue.

This implementation resolves the common issue of plugins performing actions on assets during board load but the assets not being loaded yet. This normally means that the plugin either needs to detect this condition and delay processing of its requests or needs to have some sort of a delay and re-try key combination. The Asset Data Plugin solves this by not only implementing that backlog to queue data changes until the assets are ready but it does it in a transparent way to the plugin using it so that the plugin can just assume that the assets are ready when the data change notification is received. This make the code of the plugin much easier because the plugin does not need to have any code related to checking that the asset is available (beyond the specification of a checker in the subscribe).

Invalid Request

It is possible that a board can have invalid data change messages. For example, when minis are removed from a board in an unexpected way, the board no longer contains the mini but the Asset Data Plugin may still have information for it. This means on board load it will try to process that information but there is no corresponding mini for the request to be processed on. To address this, the Asset Data Plugin has a max attempt count. When it gets a data change request, it will attempt to process it up to a number of times equal to the max attempts. If it succeeds before that number of attempts then nothing else is done. If it fails on all those attempts then the request is dropped from the backlog. This ensures that the Asset Data Plugin does not continue to try to process these the whole session dramatically increasing CPU usage.

Backwards Compatibility - Restoring Old Boards

Version 3.0.0 moved from using campaign specific files to using campaign:board specific files. Previously when a board was loaded the plugin would send notifiations for all the assets in campaign because the content was stored in campaign specific files. Since many of these assets where present on one or more more boards but not all boards, when any particular board was loaded many of the campaign file notifications needed to time out because those assets were not present on that particular board. By moving to using campaign:board specific files, only the notifications for the assets on that particular board are generated and thus typically none of them need to time out.

This means that when loading boards made with earlier versions of this plugin, the plugin will not find the campaign:board specific file (since they will be campaign files) and thus none of the asset data for that board will be restored. All new boards, going forward, should would fine when loaded.

The data format used by the plugin has not changed and thus the data in the old files can actually be read by the plugin but it just does not know where to look for it. In addition, since the old files contained assets for multiple boards, using the old files will generate the timeouts that this version is trying to overcome.

The following steps can be used to restore old board configurations:

  1. Load the desired board with version 3.0.0. None of the asset data will be restored.
  2. Make any change that requires Asset Data (e.g. add a note with Overhead notes, add an icon, add a light, etc).
  3. This will create a corresponding campaign:board file in the AssetData folder.
  4. Stop Talespire.
  5. Replace the contents of the newly created campaign:board file with the contents of the old campaign file.
  6. Delete the old campaign file.
  7. Start TS and load the desired board. The asset data notifications should trigger.

To make the resulting file more efficient, remove any assets in the file which are not actually on the particular board.

The above process will need to be repeated for each board since the new version of the plugin uses campaign:board file meaning there is a file for each board.