Revision as of 15:20, 17 June 2020

This is about a Roll20 feature exclusive to Pro-subscribers (and often to players in a Game created by a Pro-subscriber). If you'd like to use this feature, consider upgrading your account.

This page is severely out-of-date on what API Scripts are available in the One-Click Install menu, missing many new scripts and still listing some discontinued ones. Many of the pages linked from here are also out-of-date even if the API is still in use. The page could also do with a section for popular community API-scripts that aren't available in the One-Click Install menu. Priority should be to remove links to discontinued API over adding links or page for newer scripts.

The best instructions for most API Scripts can be found on the script's description when selected from the One-Click Install, or through installing it and using any "help/instuctions" command built into them.

The API Script Index is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the API GitHub Repository and follow the instructions in the README.md file at the bottom of the page.

Scripts available in the One-Click Install

Scripts By Category

General Purpose Scripts

If your script incorporates specific game system rules, consider listing the script under that game system instead of one of these general purpose categories.

Combat Scripts

Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.

• Group Initiative -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
• Critical -- Quick method of determining the outcome of a critical hit.
• Fumbler -- Quick method of determining the outcome of a fumble.

Tokens - Conditions / Status / Health

Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.

• Flight -- Mark how high tokens are flying
• Flip Tokens -- Flip graphics horizontally and/or vertically
• Mark -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
• Marking Conditions -- Set status markers on targeted on individual tokens

Tokens - Movement, Rotation, and Size

Scripts which are triggered by or change the location of tokens should generally be placed in this category.

• Collision Detection -- Handles collisions between player-controlled tokens and a subset of path objects on the page
• KABOOM -- Creates explosion effects that move tokens away from or towards a point.
• It's a Trap -- Script for setting traps and detecting collisions with them at any point during movement.
• Marching Order -- Makes tokens follow each other in some specified order.
• Move Lighting -- Move dynamic lighting polygon path objects between game layers.
• Random Rotate -- Allows the GM to easily rotate all selected tokens to a random angle.
• Token Lock -- Allows GMs to selectively lock the movement of Player Tokens.

Lighting and Revealing

Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the walls layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.

• DLEllipseDrawer -- Draw circles and ellipses on the dynamic lighting layer.
• LightCrumbTrails -- Produces lit, shared-vision breadcrumbs behind character tokens. This allows them to see where they've been on maps with dynamic lighting.
• One-Way Dynamic Lighting -- Allows you to set up dynamic lighting walls that allow you to see through one side, but not the other. (for Legacy DL)
• Torch -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
• Walls -- Builds dynamic lighting walls with an exported SVG path file.
• ShareVision -- Allows normal vision and darkvision to be shared.

Jukebox

The jukebox is a powerful tool for creating immersive gaming experiences. Make it even more powerful.

• Roll20 Audio Master -- Comprehensive jukebox control script; play, stop, and loop tracks. Adjust volume of tracks. Create, edit, play, stop, loop, and shuffle playlists.

Characters - Equipment

Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily be system-specific, there are scripts which handle equipment in a more general fashion.

• Ammo -- Provides inventory management for ammunition stored in an attribute of a character.

Characters - Attributes

Manipulate one or more characters' attributes. Anything that is system-specific should be placed in the system's category below; this section is for system-agnostic attribute manipulation.

• Conditions -- Track attribute-modifying conditions.
• ChatSetAttr -- Create, modify, and delete character attributes via chat commands or macros.
• EasyExperience -- Make awarding experience easy and choose your experience progression.
• Experience Tracker -- Automatic tracking of a Dungeons and Dragons 5e like experience system, aswell as level up announcement in chat. !xp handles experience and announces level up.

Generators

Content generation can extend the reach of your campaign while minimizing the GM's prep time.

• CharSheet -- Allow players to create their own character sheets.
• Dungeon Utils -- Generates random dungeons from wall and floor images.
• namegen -- Generates random names of People, Towns/Cities, and Taverns
• Terrain Generator -- Generate simple outdoor maps (forests, deserts, etc)

System

Scripts in this category are a bit more meta than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.

• Game Timer -- This is a simple script to court how long does player use the game room.
• Duplicate a Character and Token -- Duplicate and add identifying number to Character and Token.
• emas -- Provides player !emas and !as commands.
• MapLock -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.
• Message of the Day -- Greets players that log in with the contents of a particular note.
• MetaMacros -- Precompiler enabling C-style textual substitution macros in macro definitions.
• Page Navigator -- Easily move players from page to page, and allow players to move to pages by moving their tokens.
• Rollable Table Macros -- Use macros and chat commands with rollable tables
• Table Export -- A script for exporting Rollable Tables between accounts.
• Token Fate -- Let fate decide! Randomly selects a token from the selected group.
• Token Mod -- An interface to adjusting properties of a token from a macro or the chat area.
• TruePageCopy -- Duplicate page graphics by chat command, or with the Duplicate Page button.
• Customizable Roll Listener -- Customizable responses to API or non API chat messages.

Game Specific Scripts

Scripts that deal with specific rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.

Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).

13th Age

• 13th Age Official Character Sheet Companion -- Enhances the Official 13th Age Character Sheet with quick Escalation Die tracking, automatic recovery tracking, token setup, and automatic staggered and down icons.

Ars Magica

• Ars Magica 5e--Automated Stress Die -- Roll a stress die with automated printout, with or without modifiers. Botch dice count can be changed in both versions.

Chronique Oubliées

• COFantasy -- Combats, Skills and Spells support

Cypher System

• Cypher System Sheet -- Enables the applying of stat cost, recovery roll advance, auto calculation of PC state and damage track in the Cypher System Sheet, from the roll template or sheet buttons, for both the "English" and "French" versions.
• Cypher Systems by Roll20 Companion -- Enables the applying to characters of Stats costs and Recovery rolls advancement from the chat roll template, as well as applying Damage to NPCs.

d6 System

The "d6 System" includes a number of games from West End Games which utilize the same (or very similar) game mechanics. Scripts which are more specific to a single game than the system as a whole should be categorized there.

• Wild Dice -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space"

Dungeons & Dragons

5E

Many APIs beyond the ones listed here are made with 5E in mind, or have specific commands tailored to work with the most used D&D 5E by Roll20 character sheet.

• 5th Edition OGL by Roll20 Companion -- Companion script for D&D 5E by Roll20 character sheet
• 5e Shaped Companion -- Support script for the DnD5e Shaped Character Sheet - provides monster import, auto-ammo, auto-HD, auto-death saves, loads of config options and more

Earthdawn

• Earthdawn (FASA Official) -- A companion to the Earthdawn (FASA Official) and 1879 (FASA Official) character sheets, this provides many features such as automatically creating token actions and helping with accounting, calculating Target Numbers and checking for number of successes, Etc.

Exalted

• Exalted 3rd Edition Dice Roller -- A more robust dice rolling script for use with the Exalted Third Edition game system.
• exaltScript -- Adds general utility and automation to Exalted 3rd Edition campaigns.

FATE

• Fate Dots -- Provides numbered multi dots for Fate stress boxes.

HERO Systems

This includes Champions, Star HERO, Fantasy HERO, Traveller HERO, etc.

• Hero Roller (aka HeRoller) -- A comprehensive roller for HERO systems.

Numenera

• Cypher Roller -- Script to automatically roll Cyphers in Numenera, with full descriptions.
• Natha's Numenera -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: "Numenera (tabbed)" and "Numenera (French)".

Pathfinder

• Pathfinder Skillbook -- Generate token action to put API buttons for skills in chat window
• Pathfinder HeroLab Character Import -- Import characters from Hero Lab via XML
• Pathfinder Companion Script -- The Pathfinder Companion Script automates many of the day to day tasks of playing in and running a pathfinder game. The script is designed for the Neceros Pathfinder Sheet for Roll20

Pathfinder 2nd Edition

• Pathfinder 2 Utilities -- automatically roll Pathfinder 2 abilities and display their effect references, and track modifiers.

Savage Worlds

• Raise Count -- Counts raises on a roll against a given target number
• Savage Worlds Raise Roller -- Rolls for extra or wildcard and then shows a list of target numbers that are success or success with raises.
• Savage Worlds Status Changer -- This script makes it easy to assign a status to a set of selected tokens.

Star Wars

• Star Wars: FFG - Dice Roller -- Dice Roller for the Star Wars: FFG (API-Compatible)-character sheet
• Star Wars: Fantasy Flight Games - Destiny Tracker -- SW FFG Destiny Tracker provides a way to prompt, set and track destiny points for Star Wars: Edge of the Empire (Fantasy Flight Games)
• Wild Dice -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space"

Shadowrun

5E

• Shadowrun 5th Edition -- API helper for the "Shadowrun 5th Edition"-sheet by Cassie
• SR-RollExtender -- Deals with Shadowrun specific rules like glitches and extended rolls. For the "Shadowrun: 5th Edition (Advanced)" sheet.
• SR-NextPass -- GM aid to handle moving on to the next initiative pass

Trail of Cthulhu

• GUMSHOE -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.

Warhammer Fantasy Roleplay

2E

• WFRP 2E Actions (Havoc) -- Functions and Roll Templates in support of the Warhammer Fantasy Roleplay 2E Sheet by Paul "Havoc" Stein

4E

• WFRP4e -- Oops!, Critical Hit Location, and Critical Hit result support for Warhammer Fantasy 4th Edition.

Utility Scripts

These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.

• Base64 -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
• Command Shell -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.
• Extended Syntax Roll20 Objects -- Wraps objects to extend their functionality.
• GM Code -- Generates a unique code to authenticate the GM.
• Interpreted sendChat -- Send a message to the chat as the same person or character that triggered a chat event
• IsGM Auth Module -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.
• levenshteinDistance -- Measure the difference between strings
• splitArgs -- Split a string into arguments
• Token Collisions -- A library for detecting collisions among tokens during movement.
• Vector Math -- A library for vector mathematics.
• PowerCards -- Create nicely formatted output cards for attacks, spells, and other abilities.
• PowerCards Macro Helper -- Support the automatic generation of PowerCards for "D&D 5E by Roll20" character sheet actions.

Special Thanks

Roll20 wants to give special thanks to Brian and Aaron C. M. for their contributions to the community and this API script index.

API scripts elsewhere

This is an incomplete list of Roll20 API that aren't available in the One-Click Install menu in Roll20, but might be hosted elsewhere and manually installed.

Not available in the One-Click install

This is a list of API that are still hosted in Roll20's API script repository, but for one reason or other isn't available in the One-Click install.

• Spin Tokens -- Allows the GM to toggle spinning of selected tokens.
• Dynamic Light Recorder -- Save dynamic lighting paths for map tiles and automatically regenerate later
• Token Name Number -- Automatic Numbering of tokens with special placeholder.
• API Heart Beat -- Provides an API Heartbeat by setting the requesting player's color continuously.

User-hosted API

• Random Dungeon Generator -- Generates random dungeons with geomorphic tiles. (link to a github gist of the API)
• Morality -- A dialog prompt that provides morality choices as decisions (link to github)