Character Vault
Any Concept / Any System
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "API:Script Index"

From Roll20 Wiki

Jump to: navigation, search
m (Combat Scripts)
(Tokens - Movement)
Line 48: Line 48:
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated
* [[Script:Patrolling Tokens|Patrolling Tokens]] -- Script for patrolling tokens.
* [[Script:Patrolling Tokens|Patrolling Tokens]] -- Script for patrolling tokens.
* [[Script:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.
* [[Script:Time Torch Tracker|Time/Torch Tracker]] -- Shrinking light auras of torches.
* [[Script:Time Torch Tracker|Time/Torch Tracker]] -- Shrinking light auras of torches.
* [[Script:Trap Script|Trap script]] -- Script for using traps.
* [[Script:Trap Script|Trap script]] -- Script for using traps.

Revision as of 10:08, 21 February 2015

Template:Mentors only


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 file at the bottom of the page.

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 betwen combatants.

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.

Tokens - Movement

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

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.

Characters - Equipment

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


Random content generation can extend the reach of your campaign while minimizing the GM's prep time. It may be difficult to use these scripts for an in-depth story-driven game, but they'll be great for a random dungeon crawl!


Scripts which attempt to make the game more immersive belong in this category.


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 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).

AD&D (Dungeons and Dragons 2e)

Basic Fantasy Role Playing Game

DnD 4th Edition

Edge of the Empire

Exalted, Second Edition

  • Successes -- reports successes for d10 rolls per Exalted rules.

Fantasy Craft 2nd Printing

HERO System

King Arthur Pendragon


Savage Worlds

  • Raise Count -- Counts raises on a roll against a given target number

Star Wars Saga

Zombie Dice

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.

  • CommandShell -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.
  • GMCode -- 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.