[Script] GMSheet - a simple GM Cheatsheet to display your party's most important stats at a glance

I'm still trying to create something reasonably useful with javascript. Here's my newest attempt: Some kind of simple GM dashboard to display the most important stats for your party (currently OGL sheet only). Something like this:



As you can see, it shows if a character has temporary hit points (I always forget about it), if a character is injured, or if he has inspiration (we all forget about our inspiration - so I put in a green/golden star). 

The script can be found on GitHub.

I now better bugger off and go to sleep before anybody has a chance to look more closely to my messy code... ;) Na, just joking - feedback is absolutely welcome!

But here's a quick description of all the current features:

Roll20-GMSheet

Version 0.1.4

A quick GM Cheatsheet for the D&D 5e OGL sheets on Roll20. Please use !gmsheet -h for inline help and examples.

Displayed information

The script currently shows

• name, race, level and (main) class, including the character's avatar
• inspiration!
• HP, also indicating temporary hitpoints and injuries
• speed, passive perception, initiative bonus
• main abilities + modifiers
• available spell slots
• class resources (as stored in the attributes class_resource and other_resource)

Usage

1. Select one or several tokens
2. Type !gmsheet in chat

Gozer the Gozerian said:

Just tried it "as is" on my Shaped Sheet testing campaign, and this was the chat output I got:

Not terrible - the main attributes are there, plus Race, Level, HP, AC and Speed.  Didn't pick up the class, Passive Perception, or Initiative bonus.  This particular character is multi-classed, I'm wondering how the script handles that.

Great script.  It's been an often requested feature by GM's.  It would be cool if the attributes used within the script could be made easily accessible(direct editing of the script, or perhaps via specially formatted handout...) so the that you could customize the attributes that are used for your particular sheet.  You know, just "Pie in the sky".  ;-)

keithcurtis said:

I'm not sure a port for Shaped is needed. The sheet has some pretty robust built-in reporting macros.

Arthur B said:

Vince said:

Great script.  It's been an often requested feature by GM's.  It would be cool if the attributes used within the script could be made easily accessible(direct editing of the script, or perhaps via specially formatted handout...) so the that you could customize the attributes that are used for your particular sheet.  You know, just "Pie in the sky".  ;-)

Well, I can't post complete forms in chat, afaik. So it would be some rather clunky approach with API buttons in the chat window... and then I don't see any benefit over just editing things in the proper sheet directly. Or am I missing something?

[AVATAR] [NAME_FULL]
[{race} Lvl {level_full} {class_list}]


HP: [{hp}/{hp|max}]
...

The Aaron said:

Arthur B said:

Vince said:

Great script.  It's been an often requested feature by GM's.  It would be cool if the attributes used within the script could be made easily accessible(direct editing of the script, or perhaps via specially formatted handout...) so the that you could customize the attributes that are used for your particular sheet.  You know, just "Pie in the sky".  ;-)

Well, I can't post complete forms in chat, afaik. So it would be some rather clunky approach with API buttons in the chat window... and then I don't see any benefit over just editing things in the proper sheet directly. Or am I missing something?

I think he's talking about the format of the output, like having a handout that sets up a template or something:

[AVATAR] [NAME_FULL]
[{race} Lvl {level_full} {class_list}]


HP: [{hp}/{hp|max}]
...

That sort of thing.

Arthur B said:

keithcurtis said:

I'm not sure a port for Shaped is needed. The sheet has some pretty robust built-in reporting macros.

If I find an easy way to auto-detect the sheet type, then it shouldn't be a big thing to add the support. Otherwise I agree with you.

Bug report (I think?)....

The sheet is reporting Channel Divinity for a Paladin player of mine.  Considering he's only level 2, this is incorrect.

Hi all,

I don't do much scripting, but my brother who is totally unfamiliar with Roll20 knows JavaScript quite well. I am trying to get some information together as I would like to get my brother to edit this to include All Skills. I am seeing some edits here that show people adding more skills, but I am not sure where specifically to put those into the base code. Is there anything I can tell him that would make it easier to figure out? I am guessing there is some specific name to skills that the script has to reference.

Currently, the skills are hardcoded.  Look at line 64:

    output += '<br><br>Speed: ' + resolveAttr(cid, 'speed').current + ' ft, Passive Perception: ' + resolveAttr(cid, 'passive_wisdom').current + '<br>Initiative bonus: ' + (resolveAttr(cid, 'initiative_bonus').current > 0 ? '+' + resolveAttr(cid, 'initiative_bonus').current : resolveAttr(cid, 'initiative_bonus').current) + ', Proficiency ' + (resolveAttr(cid, 'pb').current > 0 ? '+' + resolveAttr(cid, 'pb').current : resolveAttr(cid, 'pb').current);

Hi Craig L., 

yeah, that was actually quite a stupid mistake from my side. I'll fix it and will release a new version later.

Edit: Fixed in v0.1.4 now.

Craig L. said:

Bug report (I think?)....

The sheet is reporting Channel Divinity for a Paladin player of mine.  Considering he's only level 2, this is incorrect.

The Aaron said:

Currently, the skills are hardcoded.  Look at line 64:

    output += '<br><br>Speed: ' + resolveAttr(cid, 'speed').current + ' ft, Passive Perception: ' + resolveAttr(cid, 'passive_wisdom').current + '<br>Initiative bonus: ' + (resolveAttr(cid, 'initiative_bonus').current > 0 ? '+' + resolveAttr(cid, 'initiative_bonus').current : resolveAttr(cid, 'initiative_bonus').current) + ', Proficiency ' + (resolveAttr(cid, 'pb').current > 0 ? '+' + resolveAttr(cid, 'pb').current : resolveAttr(cid, 'pb').current);

Your brother probably wants to make his changes around that area.  Either by increasing the hard coded list of skills, or doing something a bit more dynamic.

Sesserdrix, TheAaron is right (as always). I handpicked some of the skills that I needed as GM all the time. But it's rather easy to add whatever skill you need.

There was a proposal for a more dynamic, template-based output, but I'm currently too busy with real life stuff to take care for any big changes. But when things are getting better, this is definitely something I'll have a look into!

Hi Craig L., 

yeah, that was actually quite a stupid mistake from my side. I'll fix it and will release a new version later.

Edit: Fixed in v0.1.4 now.

Craig L. said:

Bug report (I think?)....

The sheet is reporting Channel Divinity for a Paladin player of mine.  Considering he's only level 2, this is incorrect.

Woot!  Thank you, sir!

Arthur B said:

The Aaron said:

Currently, the skills are hardcoded.  Look at line 64:

    output += '<br><br>Speed: ' + resolveAttr(cid, 'speed').current + ' ft, Passive Perception: ' + resolveAttr(cid, 'passive_wisdom').current + '<br>Initiative bonus: ' + (resolveAttr(cid, 'initiative_bonus').current > 0 ? '+' + resolveAttr(cid, 'initiative_bonus').current : resolveAttr(cid, 'initiative_bonus').current) + ', Proficiency ' + (resolveAttr(cid, 'pb').current > 0 ? '+' + resolveAttr(cid, 'pb').current : resolveAttr(cid, 'pb').current);

Your brother probably wants to make his changes around that area.  Either byincreasing the hard coded list of skills, or doing something a bit more dynamic.

Sesserdrix, TheAaron is right (as always). I handpicked some of the skills that I needed as GM all the time. But it's rather easy to add whatever skill you need.

There was a proposal for a more dynamic, template-based output, but I'm currently too busy with real life stuff to take care for any big changes. But when things are getting better, this is definitely something I'll have a look into!

Thank you both! That is super helpful for someone as script incompetent as I am. :D Nevermind the question I had in here, apparently he can see the names in the website. Stuff is way over my head. Thank you both again!

Hello, nice script ! :)

Is there a way to avoid API console errors if the script doesn't find attributes ? (lvl3 spell slots when you are lvl1 for instance etc)
nothing big but wanted to know :)

Hi, unfortunately I haven't found a way around it yet.

I know it's quite annoying when the console is flooded with error lines, but right now there doesn't seem a way to suppress those. :-(

For the spell slot error, you can probably add after line 82/3:

spellLevelTotal = resolveAttr(cid, 'lvl' + parseInt(i, 10) + '_slots_total').current;
if(spellLevelTotal === undefined) break;

That will exit the While loop there. This is untested. But if thats where the script is generating invalid attribute names, something like this weill work. You need to identify exactly what the spellLevelTotal variable is when the attribute doesn't exist. I've guessed that it is undefined, but it might be something else. Construct the check accordingly.

Also I'm guessing it's the spellleveltotal variable that is erroring out - i dont know the sheet, but the problem will be in that section somewhere.

To handle the more generic case, you probably need to restructure the script quite a bit. You use resolveAttribute.current or .max a lot, without checking if the attributes exist.

It would be better to have a wrapper for resolveAttribute that checks if the attribute exists (or rewrite resolveAttribute to do it internally and report undefined or error if it doesnt exist), and then would need to rewrite every place in the script were resolveAttribute exists, to account for missing attributes.

That's probably going overboard though - since this is for a specific sheet, you know most of the attributes should always exist. If spells are the only ones that sometimes dont exist, then something like the approach I state at the start of this post should be fine.

G G, I think you're right. I need to rewrite the resolveAttr routine. I'll have a look into this now (the last two weeks were just too crazy here IRL - family visit from overseas plus an attention-seeking toddler plus Roll20 is too much to handle for me right now ;)) 

Great script,

I was able to adapt it for the Starfinder official sheet here's an out put: