This section was created in order to document ongoing changes to the Fantasy Grounds API and CoreRPG base ruleset layer development that should be applied to rulesets going forward for the best compatibility with CoreRPG, standard themes, and new features.
We typically try to keep some backward compatibility for functions and features for at least 6 months (longer in some cases), in order to minimize disruption to ruleset and extension developers. However, we want to try to continuously raise the bar for what users can expect when they use Fantasy Grounds, as well as reduce overall code maintenance by retiring old code.
The SmiteWorks team will usually provide notification to rulesets that are included with the standard installation or in the SmiteWorks store; but does not attempt to provide proactive code analysis of extensions or any community/forge projects.
The notes will be provided by the month and year that the developer notes were provided to developers.
If you have any questions, please reach out to the SmiteWorks development team via the Workshop forum on the web site.
NOTE: This ruleset update is part of a larger push to standardize UI frames and fields for consistency for users, as well as making theming for ruleset creation and extensions much easier long term.
Review all subsections below.
Note specific ruleset changes indentified and called out in following three sections.
All themes should pay special attention to the Top Level Windows section in the guidelines linked below.
Migrate windows to use top-level window usage guidelines for these frames: utilitybox, tokenbag, referencelist, charselect
If frames used for other window types, migrate those windows to the correct top-level frame based on the guidelines.
Rebuild Top-Level Windows with chatbox/charselect/referencelist frames
chatbox - Use/define new anchoring templates for any windows defined using chatbox frame
Remove “basicchat*” template overrides; and use standard top/bottom anchors to adjust placement [SDL, ]
charselect - Use/define new anchoring templates for any windows defined using charselect frame
referencelist - Use/define new anchoring templates for any windows defined using referencelist frame
Review Specific/Auxiliary Asset Definitions (Per Frame) section in the Top Level Windows guidelines to implement all the primary and auxiliary requisite assets to go with any frames redefined in the ruleset or theme.
Remove calendar/utilitybox2/utilitybox3 frame definitions and graphics; as well as help_*/close_*/resize_* templates
Use new anchoring templates for any windows defined using utilitybox frame (see link above, and see examples in CoreRPG)
Update anchor templates as needed for utilitybox/tokenbag (if frames or windowtitle position updated by ruleset/extension) (i.e. anchor_content_utilitybox_top/anchor_content_utilitybox_bottom) (i.e. anchor_content_tokenbag_top/anchor_content_tokenbag_bottom)
Already defined in all official themes
Remove deprecated templates (or copy to ruleset locally)
template: anchor_title_utilitybox (Migrate to anchor_content_utilitybox_top)
template: anchor_title_utilitybox3 (Migrate to anchor_content_utilitybox_top)
template: anchor_bottom_utilitybox3 (Migrate to anchor_content_utilitybox_bottom)
template: close_utilitybox3 (Migrate to close_utilitybox)
template: resize_utilitybox3 (Migrate to resize_utilitybox)
template: helper_effects (Migrate to help_utilitybox; Add window.helplinkres)