[Scripts] A Listing of All Available API Scripts

Combat Scripts

Auto Initiative
Adds the players to the initiative tracker, rolls randomly for them and adds relevant modifiers.

Initiative highlighter
Highlights a token whose turn it is with a flashing aura

Roll comparisons
Comparing roll results.

Tokens - Conditions / Status / Health

Conditions and Status Tracker
Tracks the status of tokens and announces them as the duration passes.

Automatic Status Markers
Automatically adjust status markers on tokens

HP change Announcement
Announces when tokens’ hit points changes.

Heal chat command
Use commands to heal characters

Automatic Temp HP Management
Uses temporary hit points and sets it to automatically remove them first.

Target Marking
System for marking tokens with status marker

Tokens - Movement

Auto Teleporting and Chat Based Teleporting
Teleporting based on text commands or token locations.

Marching order
Tracking marching order of characters

Carrying tokens
Tokens carrying other tokens such as torches.

Movement Tracker and Aura Highlighter
Uses auras to track character movement based on speeds.

Character token locator
Creates an aura and shrinks it slowly to help you find your token.

Time/Torch Tracker
Shrinking light auras of torches.

Units Moved
Tracks units moved.

Disable Rotation via Chat Window Command
Disable the rotation of tokens in the chat window.

Hourglass, Stopwatch, etc.
Visual UI interface. Uses for asking players to wait.

Patrolling Tokens
Script for patrolling tokens.

Trap script (like in vid)
Script for using traps.

Lighting and Revealing

Light Switch
Script for turning on and off lights with chat commands.

!reveal command
Automatically moves tokens from the GM layer to objects layer, making them reveal to players.

Light is Closing In...
A light reduction script for token movement.

Characters - Equipment

set weapon values using the API
Tracks weapons equipped by characters.

Generators

RPG Game Dependent

System

Graphic/Token snapshot saving/loading for building your own macros
System for tracking a loading token set ups

String Formatter
Formats a string for printing.

Detecting nearest token
Script for detecting the nearest token after one is moved.

Chat Command Script
Script for standardizing and preventing duplication of chat commands.

Roleplay

Misc

Great! Thank you Josh.

First link is broken.

So it is... ironically its the link to one of his own codes   :-)

Fixed

While this is cool, just wondering from the dev team if at some point you might have a "public" library of free API scripts that developers on Roll20 can push out to and then anyone could pull one into their campaigns, etc.  Would work better over the long run than just a "sticky" post.

I say "free" scripts, since, also wondering if at some point there might be "protected" scripts (the scripts run in the campaign, but, are not visible/editable) that can be used as part of a purchasable "Campaign Module" in the marketplace (so, even free players could use the APIs since they are part of a paid module, but, it wouldn't be viewable/editable).  Just was wondering about the vision, whether it was for that, or is the intent was all APIs scripts are intended to be free/open.

Dave C. said:

While this is cool, just wondering from the dev team if at some point you might have a "public" library of free API scripts that developers on Roll20 can push out to and then anyone could pull one into their campaigns, etc.  Would work better over the long run than just a "sticky" post.

I say "free" scripts, since, also wondering if at some point there might be "protected" scripts (the scripts run in the campaign, but, are not visible/editable) that can be used as part of a purchasable "Campaign Module" in the marketplace (so, even free players could use the APIs since they are part of a paid module, but, it wouldn't be viewable/editable).  Just was wondering about the vision, whether it was for that, or is the intent was all APIs scripts are intended to be free/open.

Thanks for the links Alex.... I totally just blew over the first link, I have actually read that, but, forgot that the public library of API scripts was #1 on the list.

The 2nd one, while the concept of putting APIs in campaign modules was mentioned by some, nobody officially has committed to it yet, so, I guess mine is just another voice approving of that concept.

Dave C. said:

The 2nd one, while the concept of putting APIs in campaign modules was mentioned by some, nobody officially has committed to it yet, so, I guess mine is just another voice approving of that concept.

Hello! Thank you for this very helpful list! I was wondering if anyone has used Joshuha O's Detecting Nearest Token Script. I would love to have this feature, but I am not sure how to use it without a command prompt. Does anyone happen to know? Thanks again!

Christopher said:

I was wondering if anyone has used Joshuha O's Detecting Nearest Token Script. I would love to have this feature, but I am not sure how to use it without a command prompt. Does anyone happen to know? Thanks again!

I'm not sure what you mean?

When a token is added to the map, the script builds a tree structure containing tokens on the map. When a token moves, it updates the tree and logs the token nearest to the one that moved. If you want to do something with that information, you should edit the findNearestToken function, which begins on line 137. The variable "token" is the nearest token to the one that moved. (If there are equidistant tokens, the northernmost one is chosen.)

Would it be possible to add a script to mass effect abilities? 

While DM-ing it would be nice to have a macro or script that would automate the distribution of xp, coins, damage/healing, AC loss/gain.

i.e. the party has defeated a band of thieves, 35xp needs to be added to every character. or due to an untimely roll the party falls off the worn rope bridge to the icy waters below. (i could hit my macro button and they could all take [ pop up variable ] amount of damage.

findObjs and filterObjs can both get you where you want to be, Mike. Both functions are documented on the wiki. Which one to use kinda depends on exactly what you're trying to do and what variety of similar types of objects are in your campaign. If you need help writing the script, more information would be helpful! =)

From the campaign info page, click "API Scripts" (below "Invite Players" on the left side).

Paste the script you want into the large black text area, give it a name, and click the Save button at the bottom.

The scripts will only be on in the campaign you paste them into. You can disable scripts individually in each tab (there's an enable/disable button next to Save). Scripts will not follow you between campaigns.

It's possible for a script to "mess a game up," although unlikely. The API can modify almost everything in the game (although it can only create characters and handouts, plus attributes/abilities for characters), but most scripts are written to do one specific thing (or a set of closely related things), and are usually tested before being posted as new threads in this forum. If a script has problems, people are usually quick to point them out.

More likely than messing up your maps would be a script running into errors (which turns off all of your scripts until the error is fixed or the script is disabled/removed), or a bug in a script which sends messages to the chat triggering on the messages it sends. (ex: a script waits for a player to post some kind of message, and posts another one in response... and then sees its own response, running the script a second time!)

It is a good idea to have a campaign to test out new scripts; a copy of your actual campaign or a simple sandbox campaign, whichever you prefer.

Jennifer L. said:

I have a question about the Updated Heal chat Command. I can't seem to get it to work with inputting an amount healed. What I've been trying:
!heal Minty 5
!heal Minty 5hp

All that happens is a chat line saying I healed him. If I leave the number blank, it does heal him completely. Sorry if I have this in the wrong place, but I couldn't find a forum post specifically referencing it.

Alicia G said:

Jennifer L. said:

I have a question about the Updated Heal chat Command. I can't seem to get it to work with inputting an amount healed. What I've been trying:
!heal Minty 5
!heal Minty 5hp

All that happens is a chat line saying I healed him. If I leave the number blank, it does heal him completely. Sorry if I have this in the wrong place, but I couldn't find a forum post specifically referencing it.

You're going to want to post your question in the thread for the API script rather than here.

Logan P. said:

While this is neat, why don't we see about getting a wiki page going for it? Some way for people with finished scripts to edit the list and offer what they have would be neat, plus I think it would be easier to find what you're looking for with the wiki, and no risk of 2 months of activity locking the thread...

1. Create a page for your script on the wiki (I recommend making it a subpage of your userpage, so for example my collision detection script is on User:235259/Collision Detection)
2. Add [[Category:User API Scripts|Script Name]] to the page. There's also [[Category:API Commands|Script Name]] for scripts which create a chat command (as opposed to scripts which do something automatically without any !command input from a user). Adding the script name allows the page to be indexed correctly in the category, otherwise it will be listed under "U" (for a User: subpage).
3. Your script is now listed on User API Scripts and/or API Commands.