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
(Add cron script)
m (Pathfinder 2nd Edition)
 
(138 intermediate revisions by 53 users not shown)
Line 1: Line 1:
{{mentors only}}
+
{{pro only}}
 
+
 
<div style="float:left;margin-right:15px">__TOC__</div>
 
<div style="float:left;margin-right:15px">__TOC__</div>
 
{{apibox}}
 
{{apibox}}
Line 8: Line 7:
  
 
<br clear="both">
 
<br clear="both">
 +
=APIs available in One-Click Menu=
 +
{{Ambox
 +
|nocat=true
 +
| type  = content
 +
| text  = 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.
 +
}}
 +
{{notebox|This list resemble the list found in the one-click menu, but currently lists only APIs that have their own wiki pages, or are otherwise popular enough. There are ''hundreds'' of APIs missing from this list, but an effort to update it have been started [[User:1223200|1223200]] ([[User talk:1223200|talk]]) 18:34, 26 December 2020 (UTC)}}
 +
If your script are designed for use with a ''specific'' game system ruleset or specific Roll20 character sheet, please  list the API under that game system, instead of listing under one of the generic categories. Some API are listed under more than one category.
  
== Scripts By Category ==
+
Some great or popular APIs have their name highlighted in bold to stand out.
  
=== General Purpose Scripts ===
+
== Characters==
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.
+
Various scripts related to [[Character Sheets]], and managing them.
  
==== Combat Scripts ====
+
* [[Script:CharSheet|CharSheet]] -- Allow players to create their own character sheets.
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.
+
* {{forum|post/5281433/slug} Welcome Package}} -- API create and assigns character sheet to new people who join a game
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
+
* PublicSheet -- Creates a "public" version of character sheets that players can't edit, which mirrors the ''actual'' character sheet.
* [[Script:Initiative Tracker|Initiative Tracker]] -- Round counter and status effect manager with optional announcements to chat.
+
* [[Script:Random Turnorder|Random Turnorder]] -- Randomly assigns a turn to selected tokens.
+
* [[Script:Turn Marker|Turn Marker]] -- Round counter and a moving marker that shows who's turn it is.
+
  
==== Tokens - Conditions / Status / Health ====
+
===Equipment===
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.
+
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.
* [[Script:Blood And Honor: Automatic blood spatter, pooling and trail effects|Blood And Honor]] -- Automatic blood spatter, pooling and trail effects
+
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.
* [[Script:Bloodied and Dead Status Markers|Bloodied and Dead Status Markers]] -- Automatic bloodied and down icons for HP tracking
+
* [[Script:Conditions and Status Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.
+
* [[Script:Flight|Flight]] -- Mark how high tokens are flying
+
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically
+
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
+
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens
+
* [[Script:Temp HP and Status|Temp HP and Status]] -- Temp hit point manager and bloodied/dying/dead status markers.
+
  
==== Tokens - Movement, Rotation, and Size ====
+
===Attributes===
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
+
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.
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
+
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page
+
* '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- Create, modify, and delete character attributes via chat commands or macros.
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.
+
* [[Script:EasyExperience|EasyExperience]] -- Make awarding experience easy and choose your experience progression.
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.
+
* '''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.
* [[Script:No Token Rotation|No Token Rotation]] -- Prevents tokens from being rotated
+
* '''[[Script:GroupCheck]]''' -- A way to quickly roll a group check for everyone and see if they succeed
* [[Script:Random Depth|Random Depth]] -- Randomly adjusts the depth of selected tokens.
+
** {{forum|permalink/4359153/ ApplyDamage}} -- Supplementary API to GroupCheck, which enables to automatically apply damage to a group of characters, based on failed/succeeded GroupCheck rolls. Example: Damage of an AoE Spell, based on success/fail on saving throw
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.
+
* [[Script:Size Lock|Size Lock]] -- Toggles a state which reverts any size changes automatically.
+
* [[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:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.
+
* [[Script:Table Token Sizer|Table Token Sizer]] -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.
+
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.
+
* [[Script:Twins|Twins]] -- Links two tokens so that they mirror each other across pages.
+
  
==== Lighting and Revealing ====
+
== Chat ==
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.
+
Various APIs that primarily help you out by creating API commands & options that can be used in the {{Text Chat}}.
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer
+
* '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- Create, modify, and delete character attributes via chat commands or macros.
* [[Script:The Darkness is Closing In|The Darkness is Closing In]] -- Example script for reducing light on a token every time it moves.
+
* '''ChatTurnManager''' -- A script to simplify Turn Order Management, and move it into chat.
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
+
* [[Script:emas|emas]] -- Provides player <code>!emas</code> and <code>!as</code> commands.(emote as)
* [[Script:Walls|Walls]] -- Builds dynamic lighting walls with an exported SVG path file.
+
* [[Script:ScriptCards|ScriptCards]] -- A scripting language in an API Script. Used to produce nicely formatted output cards for attacks, spells, and other abilities.
 +
* [[Script:PowerCards|PowerCards]] -- Create nicely formatted output cards for attacks, spells, and other abilities.
 +
* [[Script:PowerCards Macro Helper|PowerCards Macro Helper]] -- Support the automatic generation of PowerCards for '''"[[D&D 5E by Roll20]]"''' character sheet actions.
 +
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.
 +
* [[Script:Rollable_Table_Macros|Rollable Table Macros]] -- Use macros and chat commands with [[Roll Table|rollable tables]]
 +
* '''{{forum|permalink/9430875/ DiscreteWhisper}}''' -- multi-recipient whispers with asides and buttons
  
==== Characters - Equipment ====
+
== Combat==
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.
+
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative, to automating exchanges between combatants.
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.
+
* '''[[Script:Group Initiative|GroupInitiative]]''' -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
* [[Script:Ammunition Tracker|Ammunition Tracker]] -- A bunch of commands to track ammunition.
+
* '''{{forum|permalink/9441420/ CombatMaster}}''' -- API for improving various aspects of combat. Automating condition duration in combat, Initiative improvement, and more. Version of CombatMaster in API Drowdown might not be latest version, check thread/repo for latest version. {{repo|vicberg/CombatMaster CombatMaster repo}}
* [[Script:Inventory Manager|Inventory Manager]] -- Inventory Management
+
* [[Script:EncounterHelper|EncounterHelper]] -- Group tokens into encounters that can be shown, hidden, and reset to their initial values.
 +
* [[Script: Critical|Critical]] -- Quick method of determining the outcome of a critical hit.
 +
* [[Script: Fumbler|Fumbler]] -- Quick method of determining the outcome of a fumble.
 +
* [[Script:InitiativeTrackerPlus|InitiativeTrackerPlus]] -- Initiative and effect tracker with other features.
  
==== Characters - Attributes ====
+
== Dynamic Lighting ==
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.
+
[[Dynamic Lighting]] is a Plus/Pro 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:Manual Attribute|Manual Attribute]] -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.
+
  
==== Generators ====
+
Not all APIs, or all thier features work on both Legacy DL and [[UDL|Updated DL]], you have to check them closer to know that.
 +
 
 +
* '''{{forum|permalink/7698809/ DoorKnocker}}''' -- Script helps quickly open and close doors by controlling the dynamic lighting lines. {{repo|Roll20/roll20-api-scripts/tree/master/Door%20Knocker sourcecode}}
 +
* [[Script:DLEllipseDrawer|DLEllipseDrawer]] -- Draw circles and ellipses on the dynamic lighting layer.
 +
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later
 +
* LightCrumbTrails -- Produces lit, shared-vision breadcrumbs behind character tokens. This allows them to see where they've been on maps with dynamic lighting.
 +
* [[Script:Move Lighting|Move Lighting]] -- Move dynamic lighting polygon path objects between game layers.
 +
* {{forum|post/4932580/script-one-way-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. (Works for [[LDL|Legacy DL]])
 +
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
 +
* {{forum|post/9521203/script-udlwindows-dynamic-lighting-paths-that-block-movement-but-not-vision-or-light-warning-updated-dynamic-lighting-only#post-9532981 UDLWindows}} -- API for creating DL lines that blocks movement, but doesn't block vision. (for [[UDL|Updated Dynamic Lighting]]
 +
* [[Script:Walls|Walls]] -- Builds Dynamic Lighting walls with an exported SVG path file.
 +
* [[Script:ShareVision|ShareVision]] -- Allows normal vision and darkvision to be shared.
 +
 
 +
== Jukebox ==
 +
The {{Jukebox}} is the music player, and some APIs interact with it
 +
* [[Script:Roll20_Audio_Master|Roll20 Audio Master]] -- Comprehensive jukebox control script; play, stop, and loop tracks. Adjust volume of tracks. Create, edit, play, stop, loop, and shuffle playlists.
 +
* [[Script:PowerCards|PowerCards]] -- Create nicely formatted output cards for attacks, spells, and other abilities. Have options to interact with Jukebox.
 +
 
 +
== Generators ==
 
Content generation can extend the reach of your campaign while minimizing the GM's prep time.
 
Content generation can extend the reach of your campaign while minimizing the GM's prep time.
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles
+
* [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images.
* [[Script:Tile|Tile]] -- Create tiled arrays of graphics on the map layer.
+
* [[Script:namegen|namegen]] -- Generates random names of People, Towns/Cities, and Taverns
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.
+
* [[Script:Terrain Generator|Terrain Generator]] -- Generate simple outdoor maps (forests, deserts, etc)
  
==== Roleplay ====
+
==Maps & Drawing==
Scripts which attempt to make the game more immersive belong in this category.
+
Various APIs related to the Map that isn't related to Dynamic Lighting, or focused on Tokens.
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.
+
* ''Areas of Effect''
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting
+
* ''DryErase'' – An API that can stop players from drawing on the map.
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions
+
* [[Script:Map Lock|MapLock]] -- Provides locking of graphics to prevent moving/resizing/rotating them.  Also highlighting.
 +
* [[Script:MapChange|MapChange]] -- Provides an easy and user friendly way to move players between maps.
 +
* [[Script:Page Navigator|Page Navigator]] -- Easily move players from page to page, and allow players to move to pages by moving their tokens. '''Note:''' Version 2 have some known issues.
 +
* [[Script:TruePageCopy|TruePageCopy]] -- Duplicate page graphics by chat command, or with the Duplicate Page button. ''(Partially obsolete since Roll20 implemented their update to Copying Pages in Q4 2020)''
 +
* '''{{forum|permalink/9137492/ Radar}}''' -- to simulate various types of radar, tremor sense etc. Includes options for [[DL]].
  
==== System ====
+
==Tokens==
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 Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.
+
* '''[[Script:Token Mod|TokenMod]]''' -- An interface to adjusting properties of a token from a macro or the chat area. Very versatile and tons of options, and it can perform features of several other Token-related APIs.
* [[Script:cron|cron]] -- Schedule (possibly recurring) commands to run at some point in the future.
+
 
* [[Script:emas|emas]] -- Provides player !emas and !as commands.
+
===Movement, Rotation, and Size ===
* [[Script:Is Greater|Is Greater]] -- Trivial little script to check if the first value is greater than the second and report it to chat.
+
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
* [[Script:Map Lock|Map Lock]] -- Provides locking of graphics to prevent moving/resizing/rotating them.  Also highlighting.
+
 
 +
* '''[[Script:Token Lock|TokenLock]]''' -- Allows GMs to selectively lock the movement of Player Tokens.
 +
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page
 +
* [[Script:DupCharToken|DupCharToken]] -- Duplicate a Character and Token, and add identifying number to Character and Token.
 +
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement. Has separate versions customised for specific games/sheets
 +
* [[Script:KABOOM|KABOOM]] -- Creates explosion effects that move tokens away from or towards a point.
 +
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.
 
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.
 
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.
+
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.
* [[Script:Move Players|Move Players]] -- Allows macros to move the player ribbon for players.
+
* {{forum|post/9436375/script-teleport-from-scratch-teleport-token Teleport}} -- Teleports tokens within a page or between pages either by chat menu or token movement by using teleport tokens on the GM layer.
* [[Script:Store Commands|Store Commands]] -- Store a series of commands for repeated execution
+
* [[Script:tokenFate|Token Fate]] -- Let fate decide! Randomly selects a token from the selected group.
 +
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically
 +
* [[Script:Spin Tokens|SpinTokens]] -- Allows the GM to toggle spinning of selected tokens.
 +
* {{forum|permalink/9649899/ Spawn Default Token}}
 +
 
 +
===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.
 +
* ''Emojibubble'' -- System to easily display empjis in a bubble above Character Tokens, or on the map.
 +
* ''Aura/Tint HealthColors'' -- Script to set health indicator on tokens via aura or tint, based on a bars value.
 +
* [[Script:Flight|Flight]] -- Mark how high tokens are flying
 +
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
 +
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens
 +
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.
 +
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit points from hit dice on add, usually via drag from journal.
 +
 
 +
== Utility ==
 +
Scripts in this category are a bit more ''meta'', or does a variety of things, so they didn't fit neatly into any other category. These scripts assist with Roll20 itself more than they assist the game you're playing.
 +
 
 +
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat for how the APIs in the game perform,  by setting the requesting player's color continuously.
 +
* [[Script:Game Timer|Game Timer]] -- This is a simple script to court how long does player use the game room.
 +
* [[Script:MetaMacros|MetaMacros]] -- Precompiler enabling C-style textual substitution macros in macro definitions.
 
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.
 
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.
+
* [[Script:Customizable Roll Listener|Customizable Roll Listener]] -- Customizable responses to API or non API chat messages.
* [[Script:Weighted Dice|Weighted Dice]] -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)
+
* [[Script:StatusInfo|StatusInfo]] -- StatusInfo works nicely together with Tokenmod, DeathTracker, and InspirationTracker scripts. It shows condition descriptions whenever a statusmarker is set or when the command <code>!condition</code> is used, eg: <code>!condition prone</code>
 +
* {{forum|post/8824428/script-universalvttimporter-import-dd2vtt-files-to-create-dynamic-lighting-lines-and-lights UniversalVTTImporter}} -- for importing DL settings and other info from maps created with the <code>.dd2vtt</code>, as used by Dungeondraft.
  
=== Game Specific Scripts ===
+
== D&D 5E ==
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.
+
Many APIs( beyond the ones listed here) are made with '''Dungeons & Dragons 5th Edition''' in mind, or have specific commands tailored to work with the popular [[D&D 5E by Roll20]]-character sheet. In the one-click menu, most APIs made for 5E should have a name starting with '''D&D 5E'''. 5E is the system that have most system-specific APIs by a large margin. Several generic APIs have configuration settings tailored for the 5E sheets, such as '''[[Script:Group Initiative|GroupInitiative]]''' or '''GroupCheck'''.
  
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).
+
* '''[[D%26D_5E_by_Roll20#Utilizing_the_5th_Edition_OGL_by_Roll20_Companion_API_Script|5th Edition OGL by Roll20 Companion]]''' -- Official Companion script for '''[[D&D 5E by Roll20]]''' character sheet
 +
* [https://github.com/Roll20/roll20-api-scripts/blob/master/5E%20Resting%20in%20Style/README.md 5E Resting in Style] -- This script for the 5E OGL character sheet solves the error prone task of updating your character sheet when resting. Using !long-rest and !short-rest commands will update your sheet, and report to you everything it is doing.
 +
* ''5E BattleMaster'' -- streamlining combat with the 5E sheet. {{repo|iantoon0/5E-BattleMaster Readme}}
 +
* ''5E Dungeon Master Tools'' -- Tool Framework for extending Roll20, auto mark tokens dead, award xp, add on modules for Barbarian and Paladin abilities.  {{repo|Roll20/roll20-api-scripts/tree/master/RatWorkshop_DungeonMasterTools Readme}}
 +
* ''CashMaster'' -- for managing you currencies
 +
* ''Concentration'' -- Concentration keeps track of characters concentration, and reminds to do a concentration check.
 +
* ''It's a Trap! -- D&D 5E Generic''' (should detect automatically what sheet is used)
 +
* ''ShortRest'' -- Automating recovery of various resource during Short Rest
 +
* ''SpellMaster'' -- a high-performance total-replacement for the Spells page of the [[D&D 5E by Roll20]]-sheet, with several additional key features that go beyond the default spells page.
 +
* ''{{forum|forum/permalink/8652406/ Rest and Recovery}}'' -- Short & Long Rest automation, by Keith
 +
* ''Rest in Style'' -- Short & Long Rest automation
 +
* ''{{forum|permalink/8856337/ WildShape}}'' -- Managing Druid Wildshape, changing token image, setting HP and temporary stats, etc.
 +
* [[Script:5e Shaped Companion Script|5e Shaped Companion]] -- Support script for the [[DnD5e Shaped Character Sheet|DnD5e Shaped]] Character Sheet - provides monster import, auto-ammo, auto-HD, auto-death saves, loads of config options and more
 +
* '''D&D 5E - Token Action Maker''' - This script creates token actions on selected tokens for the [[D&D 5E by Roll20]] sheet, very helpful for both NPCs and Players.
 +
** {{forum|permalink/8458497 forum thread}} (Created by Kevin, modified by keithcurtis, {{user profile|157788|GiGs}}, & Bretmckee)
  
==== 13th Age ====
+
== System Toolbox ==
* [[Script:Escalation|Escalation]] -- Simple Escalation Die handling script, using the new custom entries with formulae.
+
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 sections above).
  
==== BASH! Ultimate Edition ====
+
'''It's A Trap!''' have several game-specific versions.
* [[Script:Dice (BASH!)|Dice]] -- Rolls the Bash UE Dice format with exploding.
+
=== 13th Age ===
  
==== d6 System ====
+
* ''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.
The "d6 System" includes a number of games from [[wikipedia:West End Games|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.
+
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic.
+
  
==== d20 System ====
+
=== Ars Magica ===
The "d20 System" includes Dungeons & Dragons and the games it spawned which utilize the same (or very similar) game mechanics. Scripts which are more specific to D&D or one of its spinoffs than the system as a whole should be categorized there.
+
* [[Script:Ars Magica 5e Stress Die|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.
* [[Script:Announce Roll|Announce Roll]] -- Prints an extra announcement of a critical or fumble to the chat when using /roll
+
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal.
+
  
==== Dogs in the Vineyard ====
+
=== Chronique Oubliées ===
* [[Script:Dice in the Vineyard|Dice in the Vineyard]] -- Dice tracker for Dogs in the Vineyard.  Stacks poker-chip-styled roll tokens in defined areas for characters to spend.
+
* [[Script:COFantasy|COFantasy]] -- Combats, Skills and Spells support
  
==== Dungeons & Dragons 4e ====
+
=== Cypher System ===
* [[Script:Use Power|Use Power]] -- A script for instrumenting and tracking the use of encounter and daily powers.
+
* [[Script:Cypher_System_Sheet|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 [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystem "English"] and [https://github.com/Roll20/roll20-character-sheets/tree/master/CypherSystemFrench "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.
  
==== Dungeons & Dragons 5e ====
+
=== D6 System ===
* [[Script:Monster Hit Dice (D&D 5e)|Monster Hit Dice]] -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet
+
The "D6 System" includes a number of games from [[wikipedia:West End Games|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.
* [[Script:Spell Level (D&D 5e)|Spell Level]] --
+
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space" 
  
==== Edge of the Empire ====
+
=== Earthdawn ===
* [[Script:Dice Roller (Edge of the Empire)|Dice Roller]] -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game
+
* [[Earthdawn - FASA Official|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, Second Edition ====
+
=== Exalted===
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.
+
* ''Exalted 3rd Edition Dice Roller'' -- A more robust dice rolling script for use with the Exalted Third Edition game system.
 +
* [[Script:exaltScript|exaltScript]] -- Adds general utility and automation to Exalted 3rd Edition campaigns.
  
==== FATE ====
+
=== FATE ===
 
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.
 
* [[Script:Fate Dots|Fate Dots]] -- Provides numbered multi dots for Fate stress boxes.
  
==== Numenera ====
+
=== HERO Systems ===
 +
This includes Champions, Star HERO, Fantasy HERO, Traveller HERO, etc.
 +
* [[Script:HeroRoller|Hero Roller (aka HeRoller)]] -- A comprehensive roller for HERO systems.
 +
 
 +
=== Numenera ===
 
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.
 
* [[Script:Cypher Roller|Cypher Roller]] -- Script to automatically roll Cyphers in Numenera, with full descriptions.
* [[Script:Numenera_Natha|Numenera Natha]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and  [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].
+
* [[Script:Numenera_Natha|Natha's Numenera]] -- Adds Numenera rolls and character update functions to the Natha's Numenera character sheets: [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_English "Numenera (tabbed)"] and  [https://github.com/Roll20/roll20-character-sheets/tree/master/Numenera_NathasNumenera_French "Numenera (French)"].
  
==== Pathfinder ====
+
=== Pathfinder ===
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks
+
* [[Script:Skillbook|Pathfinder Skillbook]] -- Generate token action to put API buttons for skills in chat window
 +
* [[Script:HL-Import|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
  
==== Savage Worlds ====
+
=== Pathfinder 2nd Edition ===
 +
* [[Script:Pathfinder_2_Utilities|Pathfinder 2 Utilities]] -- automatically roll Pathfinder 2 abilities and display their effect references, and track modifiers.
 +
* {{forum|post/9683168/script-pathfinder-2e-treat-wounds#post-9686795 Pathfinder 2E Treat Wounds}}
 +
* {{forum|post/9718635/script-pathfinder-2e-character-adjustments Pathfinder 2E Character Adjustments}}
 +
 
 +
=== 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
 +
* [[Script:Savage_Worlds_Raise_Roller|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 ===
 +
Scripts for the various Star Wars systems.
 +
 +
* [[Script:Star Wars: Fantasy Flight Games - Dice Roller‎|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)
 +
* [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space" 
 +
 +
=== Shadowrun===
 +
 +
'''5E'''
 +
 +
* [https://github.com/Roll20/roll20-api-scripts/tree/master/Shadowrun%205th%20Edition Shadowrun 5th Edition] -- API helper for the "Shadowrun 5th Edition"-sheet by Cassie
 +
* [[Script:SR-RollExtender|SR-RollExtender]] -- Deals with Shadowrun specific rules like glitches and extended rolls. For the "Shadowrun: 5th Edition (Advanced)" sheet.
 +
* [[Script:SR-NextPass|SR-NextPass]] -- GM aid to handle moving on to the next initiative pass
  
==== Trail of Cthulhu ====
+
=== Trail of Cthulhu ===
 
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.
 
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.
  
==== Zombie Dice ====
 
* [[Script:Zombie Dice|Zombie Dice]] -- Rolls canceling Zombie Dice
 
  
=== Utility Scripts ===
+
===Warhammer Fantasy Roleplay===
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.
+
 
 +
'''2E'''
 +
 
 +
* [[Script:wfrp2e-api|WFRP 2E Actions (Havoc)]] -- Functions and Roll Templates in support of the Warhammer Fantasy Roleplay 2E Sheet by Paul "Havoc" Stein
 +
 
 +
'''4E'''
 +
 
 +
* [[Script:WFRP4e|WFRP4e]] -- Oops!, Critical Hit Location, and Critical Hit result support for Warhammer Fantasy 4th Edition.
 +
 
 +
== Library==
 +
'''Library''' scripts are generally not intended to be used alone or directly by the user. These scripts will not do anything for your campaign directly, but rather they create functions to be used by other APIs.
 +
 
 +
APIs installed from the one-click menu should automatically install any Library scripts that are needed for them to work, or warn about needing additional APIs installed.
 +
 
 
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
 
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
* [[Script:Command Shell|Command Shell]] -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.
+
* [[Script:ESRO|Extended Syntax Roll20 Objects]] -- Wraps objects to extend their functionality.
* [[Script:GM Code|GM Code]] -- Generates a unique code to authenticate the GM.
+
 
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event
 
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event
* [[Script:IsGM Auth Module|IsGM Auth Module]] -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.
 
 
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings
 
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings
 
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments
 
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments
 
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.
 
* [[Script:Token Collisions|Token Collisions]] -- A library for detecting collisions among tokens during movement.
 
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.
 
* [[Script:Vector Math|Vector Math]] -- A library for vector mathematics.
 +
* '''{{forum|permalink/9771314/ APILogic}}''' -- Gives If/ElseIf/Else Processing to Other Scripts
 +
* '''{{forum|permalink/9770117/ libInline}}''' - provides an easy interface for inlinerolls
 +
* '''{{forum|permalink/9097236/ InsertArg}}''' -- script preamp, siege engine, menu maker, command line constructor
 +
* '''{{forum|permalink/9817678/ SelectManager}}''' -- Utility to Preserve the Selected Tokens For API-Generated Calls
 +
 +
=APIs elsewhere=
 +
Some known APIs aren't available in the One-Click Install menu in Roll20, but might be hosted elsewhere and manually installed. This is an attempt to list prominent ones.
 +
 +
==Not Available in One-Click Menu==
 +
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.
 +
* {{forum|permalink/9256621/ Tracker Jacker}} -- Combat API, formerly known as "Initiative Tracker Plus"
 +
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks (Obsolete - no longer supported)
  
=== Special Thanks ===
+
==APIs elsewhere==
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API script index.
+
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles. (link to a github gist of the API)
 +
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions (link to github)
 +
* [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.(link to Github)
 +
* [https://app.roll20.net/forum/post/5019325/slug%7D Matt's Door Script] -- Older Script that's somewhat popular, link to an version that The Aaron have updated in 2017.
 +
* [https://app.roll20.net/forum/post/9631549/idea-dimmerswitch Dimmerswitch] -- WIP API to handle changing of lighting intensity/color on the map, such as sunset/sunrise happening
 +
* [https://app.roll20.net/forum/post/6638045/script-simpleroofcontrol SimpleRoofControl] -- A roof "lifting" system to show/hide rooms or houses. It also gives the option to turn the Advanced Fog of War and Dynamic Lighting on or off so you can have those features enabled only inside the building. {{repo|blawson69/SimpleRoofControl sourcecode}}
  
 +
= Special Thanks =
 +
Roll20 wants to give special thanks to [https://app.roll20.net/users/235259/brian Brian] and [https://app.roll20.net/users/104025/the-aaron Aaron C. M.] for their contributions to the community and this API Script Index.
 +
<br>
 +
<br>
 
[[Category:API|Script Index]]
 
[[Category:API|Script Index]]

Latest revision as of 14:40, 19 February 2021

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.


[edit] APIs available in One-Click Menu

If your script are designed for use with a specific game system ruleset or specific Roll20 character sheet, please list the API under that game system, instead of listing under one of the generic categories. Some API are listed under more than one category.

Some great or popular APIs have their name highlighted in bold to stand out.

[edit] Characters

Various scripts related to Character Sheets, and managing them.

  • CharSheet -- Allow players to create their own character sheets.
  • -- API create and assigns character sheet to new people who join a game
  • PublicSheet -- Creates a "public" version of character sheets that players can't edit, which mirrors the actual character sheet.

[edit] 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.

[edit] 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.
  • Script:GroupCheck -- A way to quickly roll a group check for everyone and see if they succeed
    • -- Supplementary API to GroupCheck, which enables to automatically apply damage to a group of characters, based on failed/succeeded GroupCheck rolls. Example: Damage of an AoE Spell, based on success/fail on saving throw

[edit] Chat

Various APIs that primarily help you out by creating API commands & options that can be used in the q Text Chat.

  • ChatSetAttr -- Create, modify, and delete character attributes via chat commands or macros.
  • ChatTurnManager -- A script to simplify Turn Order Management, and move it into chat.
  • emas -- Provides player !emas and !as commands.(emote as)
  • ScriptCards -- A scripting language in an API Script. Used to produce nicely formatted output cards for attacks, spells, and other abilities.
  • 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.
  • Message of the Day -- Greets players that log in with the contents of a particular note.
  • Rollable Table Macros -- Use macros and chat commands with rollable tables
  • -- multi-recipient whispers with asides and buttons

[edit] Combat

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

  • GroupInitiative -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
  • -- API for improving various aspects of combat. Automating condition duration in combat, Initiative improvement, and more. Version of CombatMaster in API Drowdown might not be latest version, check thread/repo for latest version. GitHubLogo.png
  • EncounterHelper -- Group tokens into encounters that can be shown, hidden, and reset to their initial values.
  • Critical -- Quick method of determining the outcome of a critical hit.
  • Fumbler -- Quick method of determining the outcome of a fumble.
  • InitiativeTrackerPlus -- Initiative and effect tracker with other features.

[edit] Dynamic Lighting

Dynamic Lighting is a Plus/Pro 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.

Not all APIs, or all thier features work on both Legacy DL and Updated DL, you have to check them closer to know that.

  • -- Script helps quickly open and close doors by controlling the dynamic lighting lines. GitHubLogo.png
  • DLEllipseDrawer -- Draw circles and ellipses on the dynamic lighting layer.
  • Dynamic Light Recorder -- Save dynamic lighting paths for map tiles and automatically regenerate later
  • LightCrumbTrails -- Produces lit, shared-vision breadcrumbs behind character tokens. This allows them to see where they've been on maps with dynamic lighting.
  • Move Lighting -- Move dynamic lighting polygon path objects between game layers.
  • -- Allows you to set up dynamic lighting walls that allow you to see through one side, but not the other. (Works for Legacy DL)
  • Torch -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
  • -- API for creating DL lines that blocks movement, but doesn't block vision. (for Updated Dynamic Lighting
  • Walls -- Builds Dynamic Lighting walls with an exported SVG path file.
  • ShareVision -- Allows normal vision and darkvision to be shared.

[edit] Jukebox

The u Jukebox is the music player, and some APIs interact with it

  • Roll20 Audio Master -- Comprehensive jukebox control script; play, stop, and loop tracks. Adjust volume of tracks. Create, edit, play, stop, loop, and shuffle playlists.
  • PowerCards -- Create nicely formatted output cards for attacks, spells, and other abilities. Have options to interact with Jukebox.

[edit] Generators

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

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

[edit] Maps & Drawing

Various APIs related to the Map that isn't related to Dynamic Lighting, or focused on Tokens.

  • Areas of Effect
  • DryErase – An API that can stop players from drawing on the map.
  • MapLock -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.
  • MapChange -- Provides an easy and user friendly way to move players between maps.
  • Page Navigator -- Easily move players from page to page, and allow players to move to pages by moving their tokens. Note: Version 2 have some known issues.
  • TruePageCopy -- Duplicate page graphics by chat command, or with the Duplicate Page button. (Partially obsolete since Roll20 implemented their update to Copying Pages in Q4 2020)
  • -- to simulate various types of radar, tremor sense etc. Includes options for DL.

[edit] Tokens

  • TokenMod -- An interface to adjusting properties of a token from a macro or the chat area. Very versatile and tons of options, and it can perform features of several other Token-related APIs.

[edit] Movement, Rotation, and Size

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

  • TokenLock -- Allows GMs to selectively lock the movement of Player Tokens.
  • Collision Detection -- Handles collisions between player-controlled tokens and a subset of path objects on the page
  • DupCharToken -- Duplicate a Character and Token, and add identifying number to Character and Token.
  • It's a Trap -- Script for setting traps and detecting collisions with them at any point during movement. Has separate versions customised for specific games/sheets
  • KABOOM -- Creates explosion effects that move tokens away from or towards a point.
  • Marching Order -- Makes tokens follow each other in some specified order.
  • Measure -- Measure distances between multiple tokens, both from the corners and the center.
  • Random Rotate -- Allows the GM to easily rotate all selected tokens to a random angle.
  • -- Teleports tokens within a page or between pages either by chat menu or token movement by using teleport tokens on the GM layer.
  • Token Fate -- Let fate decide! Randomly selects a token from the selected group.
  • Flip Tokens -- Flip graphics horizontally and/or vertically
  • SpinTokens -- Allows the GM to toggle spinning of selected tokens.

[edit] 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.

  • Emojibubble -- System to easily display empjis in a bubble above Character Tokens, or on the map.
  • Aura/Tint HealthColors -- Script to set health indicator on tokens via aura or tint, based on a bars value.
  • Flight -- Mark how high tokens are flying
  • 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
  • Token Name Number -- Automatic Numbering of tokens with special placeholder.
  • Monster Hit Dice -- Set Monster hit points from hit dice on add, usually via drag from journal.

[edit] Utility

Scripts in this category are a bit more meta, or does a variety of things, so they didn't fit neatly into any other category. These scripts assist with Roll20 itself more than they assist the game you're playing.

  • API Heart Beat -- Provides an API Heartbeat for how the APIs in the game perform, by setting the requesting player's color continuously.
  • Game Timer -- This is a simple script to court how long does player use the game room.
  • MetaMacros -- Precompiler enabling C-style textual substitution macros in macro definitions.
  • Table Export -- A script for exporting Rollable Tables between accounts.
  • Customizable Roll Listener -- Customizable responses to API or non API chat messages.
  • StatusInfo -- StatusInfo works nicely together with Tokenmod, DeathTracker, and InspirationTracker scripts. It shows condition descriptions whenever a statusmarker is set or when the command !condition is used, eg: !condition prone
  • -- for importing DL settings and other info from maps created with the .dd2vtt, as used by Dungeondraft.

[edit] D&D 5E

Many APIs( beyond the ones listed here) are made with Dungeons & Dragons 5th Edition in mind, or have specific commands tailored to work with the popular D&D 5E by Roll20-character sheet. In the one-click menu, most APIs made for 5E should have a name starting with D&D 5E. 5E is the system that have most system-specific APIs by a large margin. Several generic APIs have configuration settings tailored for the 5E sheets, such as GroupInitiative or GroupCheck.

  • 5th Edition OGL by Roll20 Companion -- Official Companion script for D&D 5E by Roll20 character sheet
  • 5E Resting in Style -- This script for the 5E OGL character sheet solves the error prone task of updating your character sheet when resting. Using !long-rest and !short-rest commands will update your sheet, and report to you everything it is doing.
  • 5E BattleMaster -- streamlining combat with the 5E sheet. GitHubLogo.png
  • 5E Dungeon Master Tools -- Tool Framework for extending Roll20, auto mark tokens dead, award xp, add on modules for Barbarian and Paladin abilities. GitHubLogo.png
  • CashMaster -- for managing you currencies
  • Concentration -- Concentration keeps track of characters concentration, and reminds to do a concentration check.
  • It's a Trap! -- D&D 5E Generic' (should detect automatically what sheet is used)
  • ShortRest -- Automating recovery of various resource during Short Rest
  • SpellMaster -- a high-performance total-replacement for the Spells page of the D&D 5E by Roll20-sheet, with several additional key features that go beyond the default spells page.
  • -- Short & Long Rest automation, by Keith
  • Rest in Style -- Short & Long Rest automation
  • -- Managing Druid Wildshape, changing token image, setting HP and temporary stats, etc.
  • 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
  • D&D 5E - Token Action Maker - This script creates token actions on selected tokens for the D&D 5E by Roll20 sheet, very helpful for both NPCs and Players.
    • (Created by Kevin, modified by keithcurtis, GiGs, & Bretmckee)

[edit] System Toolbox

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

It's A Trap! have several game-specific versions.

[edit] 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.

[edit] Ars Magica

[edit] Chronique Oubliées

  • COFantasy -- Combats, Skills and Spells support

[edit] 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.

[edit] 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"

[edit] 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.

[edit] 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.

[edit] FATE

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

[edit] HERO Systems

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

[edit] Numenera

[edit] 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

[edit] Pathfinder 2nd Edition

[edit] 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.

[edit] Star Wars

Scripts for the various Star Wars systems.

  • 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"

[edit] 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

[edit] Trail of Cthulhu

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


[edit] 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.

[edit] Library

Library scripts are generally not intended to be used alone or directly by the user. These scripts will not do anything for your campaign directly, but rather they create functions to be used by other APIs.

APIs installed from the one-click menu should automatically install any Library scripts that are needed for them to work, or warn about needing additional APIs installed.

[edit] APIs elsewhere

Some known APIs aren't available in the One-Click Install menu in Roll20, but might be hosted elsewhere and manually installed. This is an attempt to list prominent ones.

[edit] Not Available in One-Click Menu

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.

  • -- Combat API, formerly known as "Initiative Tracker Plus"
  • Creature Gen -- Generate combat ready tokens from PRD and D20PFSRD statblocks (Obsolete - no longer supported)

[edit] APIs elsewhere

  • 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)
  • Track V20 Attributes -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.(link to Github)
  • Matt's Door Script -- Older Script that's somewhat popular, link to an version that The Aaron have updated in 2017.
  • Dimmerswitch -- WIP API to handle changing of lighting intensity/color on the map, such as sunset/sunrise happening
  • SimpleRoofControl -- A roof "lifting" system to show/hide rooms or houses. It also gives the option to turn the Advanced Fog of War and Dynamic Lighting on or off so you can have those features enabled only inside the building. GitHubLogo.png

[edit] 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.