Template:Supporters only

This repository is the collection of all the community-contributed API scripts that are available for use on Roll20.

Scripts By Category

General Purpose 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.
• Random Turn Order -- Randomly assigns a turn to selected tokens.
• Round Tracker -- Adds a marker in the initiative which increments automatically.
• Highlight Token at Top of Initiative -- Highlights the token at the top of initiative.
• Range Finder -- Determines the distance between two named tokens
• Automatic Initiative Roller and Round Counter --
• Cone and Circle Templates --

Tokens - Conditions / Status / Health

• Blood And Honor -- Automatic blood spatter, pooling and trail effects
• 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
• Updated Heal Chat Command --
• Automatic Temp HP Management -- Uses temporary hit points and sets it to automatically remove them first.
• Target Marking -- System for marking tokens with status markerAuto create a token

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.
• Interpolated trap detection --

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.
• Trader Joes -- Inventory Management

Generators

• It's the Monster Mash! -- It's the Monster Mash! An adventure in Encounters!
• Weather Generator Script --

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.
• Scrolling Macro Bar --
• IsGM Auth Module -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.

Roleplay

• Language Script -- A script for auto converting text to elven or dwarven.
• What Did He Say? -- Language based scripting

Misc

• API command process, standard model -- API command process, standard model.

Game Specific Scripts

Edge of the Empire

• Edge of the Empire Dice with Images in the Chat Window --
• Edge of the Empire Dice --

DnD 4th Edition

• Combat -- temporary hit points. Also prevents over healing.
• Tools -- 4th edition. Adds marking to the Combat script.
• 4e Helper -- 4th edition collection of scripts.
• 4e combat engine --
• 4e Monster generator based on MM3 math --

Zombie Dice

• Zombie Dice -- A Script for playing zombie dice

Basic Fantasy Role Playing Game

• Basic Fantasy Role-Playing Game --

HERO System

• Scripts to Automate the Combat --

AD&D (Dungeons and Dragons 2e)

• 2nd Ed Character Sheet --

Pathfinder

• All In One --
• Pathfinder Character Sheet Generator v3 --
• Character Sheet Generator --
• Inspired Collection --

Star Wars Saga

• Star Wars Saga Edition Character Sheet --

Fantasy Craft 2nd Printing

• Fantasy Craft (2nd printing) - Standard character token management --
• Fantasy Craft - Standard character damage save --

Utility Scripts

Contributing

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.

API Docs

Template:Apibox top Template:Apibox getting started Template:Apibox reference Template:Apibox bottom The Roll20 API provides a powerful way to customize and enhance your game. Write scripts that tell Roll20 what to do during gameplay (for instance, move a piece, add a status marker to a token, or even roll dice). It's simple and straightforward to get started, but the possibilities are endless.

The API is written using JavaScript, so a foundation in the language is extremely useful to becoming a script writer. However, almost any programming background can give you a leg up on learning to write Roll20 API scripts, and anyone can learn the skills necessary.

The links on the left will lead you to the API's documentation: what functions are available to you, and how to handle the objects returned from them. You also have access to the Underscore.js library.

API Cookbook

Main Page: API:Cookbook

This article is a stub. You can help the Roll20 Community Wiki by expanding it.

API Best Practices

Main Page: API:Best Practices

Include namespaces for your functions and variables, to avoid potential name collisions with other authors.

Use easy, short, readable function and variable names. Names like x1, fe2, and xbqne are practically meaningless. Names like incrementorForMainLoopWhichSpansFromTenToTwenty are overly verbose.

Keep your code legible, especially if you need to ask for help on the forums. Additionally, please write your code in English.

Comments! At the very least, comments describing your configuration variables are helpful to everyone who installs your script.

Learn to love _. You have access to Underscore.js, a library with many useful utility functions.