PDA

View Full Version : Combat Tracker Game Name and Session Number Extension



Wintermute
May 13th, 2018, 22:55
What It Does
This extension will override the Combat Tracker default title, replacing it with the adventure name and session number selected from the options menu.

The game name option has been pre-loaded with the module names from D&D 5e, Pathfinder adventure paths, Starfinder, and Call of Cthulhu. Game names also include generic ruleset names like Dungeons and Dragons, Pathfinder, Starfinder, Call of Cthulhu, Castles and Crusades, Fate, Numenera, Rolemaster Classic, Savage Worlds, Dungeons and Dragons 3.5, and Dungeons and Dragons 4E. This extension also allows for 10 custom game names. If you want to add your own custom title tag, see the "Adding Custom Game Names" further down this post.

This extension supports session numbers 0 - 1000.

Screenshots

23462

23464

Support Rulesets
This extension is based off the CoreRPG ruleset and should be compatible with all rulesets. I have tested it with 3.5e, 4e, 5e, CoreRPG, Fate Core, and PFRPG.

Installation
Download and copy the GMW-CT Session Number.ext file into your %appdata%\Fantasy Grounds\Extensions folder. Start Fantasy Grounds, and enable the extension when loading your campaign.

Usage
When you have opened your campaign, click the options button, and set the CT Session: Game Name and CT Session: Session Number options. Open the combat tracker and you will see the "Game Name - Session X" title based upon the options you have chosen.

This extension will modify the combat tracker title in 4 different ways:

1. If Game Name and Session Number are blank, tracker will show "Combat Tracker".

2. If Game Name selected and Session Number is blank, tracker will show the Game Name only.

3. If Game Name is blank and Session Number is set, tracker will show the Session Number only.

4. If Game Name is set and Session Number is set tracker will show "Game Name - Session Number".


Important Notice
Fantasy Grounds generates the title tag for the combat tracker when it is opened for the first time. You must set your options before opening the combat tracker for the first time during a session. If you change a CT Session option after opening the tracker, you must use the /reload command or restart Fantasy Grounds to update the combat tracker. Keep in mind that you cannot /reload if players are already connected.

Adding Custom Game Names
To add your own custom game names, you need to edit the following files:

1. strings/adventure-title-strings.xml

2. scripts/gmw-ct.lua

Replace "Custom Name X" with the name of your game.

DID YOU SEE IT?
Did you see and read the important notice above? Seriously, you need to read it. :)

Is Your Adventure Module Not Listed
I know that there are a bunch of modules not listed. If anyone has a list, or wants to compile one, of all the adventures available for Fantasy Grounds, please send it to me and I will update the extension. Otherwise, I will update as time permits.

Git Repo
Download the source code from Bitbucket (https://www.gmwintermute.com/b50n)

Download the extension below:

Halfront
May 13th, 2018, 23:38
Wow, this is really cool! Nice work!

edit: Just tested it out. I'm running LMoP and really nice to have it show there.

Trenloe
May 14th, 2018, 00:24
Nice one! Simple functionality, but a cool thing to have.

One thing to consider to make it truly universal for any adventure. Make the combat tracker title field editable by the GM, store the name in the campaign database and use that as the title for all combat trackers - both GM and players.

madman
May 14th, 2018, 03:18
Love It, Thanks

Madman..

Wintermute
May 14th, 2018, 18:42
Thanks Trenloe. I like your idea. Since FG doesn't allow Lua file i/o, I wasn't able to do my original idea of loading the values from a text file onInit. Any chance you could point me towards some documentation dealing with text input fields?

Trenloe
May 14th, 2018, 18:47
Any chance you could point me towards some documentation dealing with text input fields?
See the stringfield here: http://www.fantasygrounds.com/refdoc/stringfield.xcp It inherits various controls - so click through the inherits links.

Take a look at Damned's MoreCore ruleset - this has a few labels fields that can be edited in place - the fields in the combat section of the PC sheet, for example.

Wintermute
May 14th, 2018, 18:53
Thanks for the direction. I will check them out.

Lensman
February 4th, 2020, 20:12
Have you had any luck updating this extension to adapt the method Trenlore suggested?

Wintermute
February 4th, 2020, 23:52
No I haven't updated the extension in quite some time. There is an easier way to add custom labels to the combat tracker. Check out my toolkit (https://fantasygrounds.com/forums/showthread.php?48071-GMW-Campaign-Toolkit-A-Theme-Builder-for-Fantasy-Grounds&p=427427&viewfull=1#post427427), there is support for easily adding custom game names. Just add the names under a basic theme and hit publish, no xml coding at all. It will work with all the themes that I have tested with. The toolkit only generates a theme based on what elements you changed, so you do not have to create a full theme with images to use this function.

Lensman
February 5th, 2020, 04:23
No I haven't updated the extension in quite some time. There is an easier way to add custom labels to the combat tracker. Check out my toolkit (https://fantasygrounds.com/forums/showthread.php?48071-GMW-Campaign-Toolkit-A-Theme-Builder-for-Fantasy-Grounds&p=427427&viewfull=1#post427427), there is support for easily adding custom game names. Just add the names under a basic theme and hit publish, no xml coding at all. It will work with all the themes that I have tested with. The toolkit only generates a theme based on what elements you changed, so you do not have to create a full theme with images to use this function.

Downloading it now thanks!

ThatsSoNoc
November 23rd, 2020, 09:00
Is it Fantasy Grounds Unity compatible? I do not see the option listed.

Can confirm it works in Classic.

Klandare
March 16th, 2021, 23:17
Is it Fantasy Grounds Unity compatible? I do not see the option listed.

Can confirm it works in Classic.

Anyone know if this is still supported? Or has anyone gotten it to work in FGU? I see the ext available to click in FGU but it doesn't show up in the Options. I will have to try on a campaign with no other extensions running.

Klandare
March 16th, 2021, 23:41
Anyone know if this is still supported? Or has anyone gotten it to work in FGU? I see the ext available to click in FGU but it doesn't show up in the Options. I will have to try on a campaign with no other extensions running.

Ugh. Figured out the issue with FGU is that the script coding has to be adjusted. there are comment sections with <---------------------> in there which has to change to just <-- --> and then other locations have & and have to be changed to something else like and or n or something.

Naurthoron
March 18th, 2021, 00:39
I have fixed it for FGU and updated the main content with adventures published in the meantime