Character Vault
Any Concept / Any System
Compendium
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
(Roleplay)
(Removed all redlinks)
Line 13: Line 13:
  
 
==== Combat Scripts ====
 
==== Combat Scripts ====
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges betwen combatants.
+
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.
* [[Script:Automatic Initiative Roller and Round Counter|Automatic Initiative Roller and Round Counter]] --
+
* [[Script:Cone and Circle Templates|Cone and Circle Templates]] --
+
* [[Script:Initiative highlighter|Initiative Highlighter]] -- Highlights a token whose turn it is with a flashing aura.
+
 
* [[Script:InitiativeTracker|InitiativeTracker]] -- Round counter and status effect manager with optional announcements to chat.
 
* [[Script:InitiativeTracker|InitiativeTracker]] -- Round counter and status effect manager with optional announcements to chat.
 
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.
 
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.
* [[Script:Range Finder|Range Finder]] -- Determines the distance between two named tokens
 
* [[Script:Roll Comparisons|Roll comparisons]] -- Comparing roll results.
 
  
 
==== Tokens - Conditions / Status / Health ====
 
==== 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 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.
* [[Script:Automatic Status Markers|Automatic Status Markers]] -- Automatically adjust status markers on tokens
 
* [[Script:Automatic Temp HP Management|Automatic Temp HP Management]] -- Uses temporary hit points and sets it to automatically remove them first.
 
 
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects
 
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects
 
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking
 
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking
Line 31: Line 24:
 
* [[Script:Flight|Flight]] -- Mark how high tokens are flying
 
* [[Script:Flight|Flight]] -- Mark how high tokens are flying
 
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically
 
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically
* [[Script:Heal Chat Command|Heal Chat Command]] -- Use commands to heal characters
 
* [[Script:HP Change Announcement|HP Change Announcement]] -- Announces when tokens' hit points changes.
 
 
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens
 
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens
* [[Script:Target Marking|Target Marking]] -- System for marking tokens with status markerAuto create a token
 
* [[Script:Updated Heal Chat Command|Updated Heal Chat Command]] --
 
  
 
==== Tokens - Movement ====
 
==== Tokens - Movement ====
 
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
 
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
 
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
 
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
* [[Script:Carrying Tokens|Carrying Tokens]] -- Tokens carrying other tokens such as torches.
 
* [[Script:Character Token Locator|Character Token Locator]] -- Creates an aura and shrinks it slowly to help you find your token.
 
 
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page
 
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page
* [[Script:Disable Rotation|Disable Rotation via Chat Window Command]] -- Disable the rotation of tokens in the chat window.
 
 
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.
 
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.
* [[Script:Marking Order|Marching Order]] -- Tracking marching order of characters
 
* [[Script:Movement Tracker and Aura Highlighter|Movement Tracker and Aura Highlighter]] -- Uses auras to track character movement based on speeds.
 
 
* [[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:Slide Tokens|Slide Tokens]] -- Use an API command to move tokens along a waypoint path, instead of dragging the token and hitting space.
 
* [[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:Trap Script|Trap script]] -- Script for using traps.
 
* [[Script:Units Moved|Units Moved]] -- Tracks units moved.
 
* [[Script:Visual Hourglass|Visual Hourglass]] -- Visual UI interface. Uses for asking players to wait.
 
  
 
==== Lighting and Revealing ====
 
==== 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 <code>walls</code> 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.
 
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 <code>walls</code> 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.
 
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer
 
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer
* [[Script:Light Switch|Light Switch]] -- Script for turning on and off lights with chat commands.
 
* [[Script:Reveal Command|Reveal command]] -- Automatically moves tokens from the GM layer to objects layer, making them reveal to players.
 
 
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.
 
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.
  
 
==== Characters - Equipment ====
 
==== 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.
 
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.
* [[Script:Set Weapon Value Using The API|Set Weapon Values Using the API]] -- Tracks weapons equipped by characters.
 
* [[Script:Trader Joes|Trader Joes]] -- Inventory Management
 
 
* [[Script:InventoryManager|Inventory Manager]] -- Inventory Management
 
* [[Script:InventoryManager|Inventory Manager]] -- Inventory Management
  
 
==== Generators ====
 
==== Generators ====
 
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!
 
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!
* [[Script:Its the Monster Mash|It's the Monster Mash!]] -- It's the Monster Mash! An adventure in Encounters!
 
 
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles
 
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles
* [[Script:Weather Generator Script|Weather Generator Script]] --
 
  
 
==== Roleplay ====
 
==== Roleplay ====
Line 82: Line 55:
 
==== System ====
 
==== 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.
 
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.
* [[Script:API Command Process Standard Model|API command process, standard model]] -- API command process, standard model.
 
* [[Script:Chat Command Script|Chat Command Script]] -- Script for standardizing and preventing duplication of chat commands.
 
* [[Script:Custom Power Cards|Custom Power Cards]] -- Format messages for chat in an compact and appealing manner
 
* [[Script:Detecting Nearest Token|Detecting Nearest Token]] -- Script for detecting the nearest token after one is moved.
 
* [[Script:Graphic Token Snapshot Saving and Loading|Graphic/Token snapshot saving/loading for building your own macros]] -- System for tracking a loading token set ups
 
* [[Script:Scrolling Macro_Bar|Scrolling Macro Bar]] --
 
 
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution
 
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution
* [[Script:String Formatter|String Formatter]] -- Formats a string for printing.
 
  
 
=== Game Specific Scripts ===
 
=== Game Specific Scripts ===
Line 95: Line 61:
  
 
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).
 
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)  ====
 
* [[Script:Character Sheet (AD&D)|Character Sheet (AD&D)]] --
 
 
==== Basic Fantasy Role Playing Game ====
 
* [[Script:BFRPG|Basic Fantasy Role-Playing Game]] --
 
 
==== DnD 4th Edition ====
 
* [[Script:Combat (D&D 4e)|Combat]] -- temporary hit points. Also prevents over healing.
 
* [[Script:Combat Engine (D&D 4e)|Combat Engine]] --
 
* [[Script:Helper (D&D 4e)|Helper]] -- 4th edition collection of scripts.
 
* [[Script:MM3 Monster Generator (D&D 4e)|Monster Generator]] --
 
* [[Script:Tools (D&D 4e)|Tools]] -- 4th edition. Adds marking to the Combat script.
 
 
==== Edge of the Empire ====
 
* [[Script:Dice (EotE)|Dice]] --
 
* [[Script:Dice With Images In The Chat Window (EotE)|Dice with Images in the Chat Window]] --
 
  
 
==== Exalted, Second Edition ====
 
==== Exalted, Second Edition ====
 
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.
 
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.
 
==== Fantasy Craft 2nd Printing ====
 
* [[Script:Damage Save (Fantasy Craft)|Damage Save]] --
 
* [[Script:Standard Character Token Management (Fantasy Craft)|Token Management]] --
 
 
==== HERO System ====
 
* [[Script:Automate Combat (HERO)|Automate Combat]] --
 
 
==== King Arthur Pendragon ====
 
* [[Script:Manual Attribute|Editable Hit Point Attribute]] -- Script to automate creating a manual hit point attribute while using the community character sheet.
 
  
 
==== Numenera ====
 
==== Numenera ====
Line 130: Line 69:
  
 
==== Pathfinder ====
 
==== Pathfinder ====
* [[Script:Pathfinder All In One|All In One]] --
 
* [[Script:Character Sheet (PF)|Character Sheet]] --
 
* [[Script:Inspired Collection|Inspired Collection]] --
 
 
* [[Script:CreatureGen|CreatureGen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks
 
* [[Script:CreatureGen|CreatureGen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks
  
 
==== Savage Worlds ====
 
==== Savage Worlds ====
 
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number
 
* [[Script:Raise Count|Raise Count]] -- Counts raises on a roll against a given target number
 
==== Star Wars Saga ====
 
* [[Script:Character Sheet (SWS)|Character Sheet]] --
 
 
==== Zombie Dice ====
 
* [[Script:Zombie Dice|Zombie Dice]] -- A Script for playing zombie dice
 
  
 
=== Utility Scripts ===
 
=== Utility Scripts ===

Revision as of 02:02, 20 March 2015


Contents

Roll20 API

Getting Started


Reference


Cookbook (Examples)


Community Scripts

  • Script Index

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

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.

Generators

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!

Roleplay

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

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

Exalted, Second Edition

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

Numenera

  • Cypher Roller -- Script to automatically roll Cyphers in Numenera, with full descriptions.

Pathfinder

  • CreatureGen -- Generate combat ready tokens from PRD and D20PFSRD statblocks

Savage Worlds

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

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.