Difference between revisions of "Mod:Script Index"
From Roll20 Wiki
Andreas J. (Talk | contribs) (→Scripts By Category: Major cleanup, organize categories & APIs to better match up with how things look in the one-click menu) |
Andreas J. (Talk | contribs) (More cleanup, reorganizing) |
||
| Line 1: | Line 1: | ||
{{pro only}} | {{pro only}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<div style="float:left;margin-right:15px">__TOC__</div> | <div style="float:left;margin-right:15px">__TOC__</div> | ||
{{apibox}} | {{apibox}} | ||
| Line 17: | Line 7: | ||
<br clear="both"> | <br clear="both"> | ||
| − | =Scripts available in the One-Click Install= | + | =Scripts available in the One-Click Install= |
| − | == Scripts | + | {{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. | 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. | Some great or popular APIs have their name highlighted in bold to stand out. | ||
| − | + | == Characters== | |
Various scripts related to [[Character Sheets]], and managing them. | Various scripts related to [[Character Sheets]], and managing them. | ||
| − | + | ||
| + | * [[Script:CharSheet|CharSheet]] -- Allow players to create their own character sheets. | ||
| + | * {{forum|post/5281433/slug} Welcome Package}} -- 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. | ||
| + | |||
| + | ===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. | 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:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character. | * [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character. | ||
| − | + | ===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. | 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:Conditions|Conditions]] -- Track attribute-modifying conditions. | * [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions. | ||
| Line 38: | Line 38: | ||
** {{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 | ** {{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 | ||
| − | + | == Chat == | |
Various APIs that primarily help you out by creating API commands & options that can be used in the {{Text Chat}}. | Various APIs that primarily help you out by creating API commands & options that can be used in the {{Text Chat}}. | ||
* '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- Create, modify, and delete character attributes via chat commands or macros. | * '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- Create, modify, and delete character attributes via chat commands or macros. | ||
| Line 47: | Line 47: | ||
* [[Script:Rollable_Table_Macros|Rollable Table Macros]] -- Use macros and chat commands with rollable tables | * [[Script:Rollable_Table_Macros|Rollable Table Macros]] -- Use macros and chat commands with rollable tables | ||
| − | + | == Combat== | |
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative, to automating exchanges between combatants. | Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative, to automating exchanges between combatants. | ||
* '''[[Script:Group Initiative|GroupInitiative]]''' -- Adds the selected tokens to the turn order after rolling their initiative + configurable data. | * '''[[Script:Group Initiative|GroupInitiative]]''' -- Adds the selected tokens to the turn order after rolling their initiative + configurable data. | ||
| Line 56: | Line 56: | ||
* [[Script:InitiativeTrackerPlus|InitiativeTrackerPlus]] -- Initiative and effect tracker with other features. | * [[Script:InitiativeTrackerPlus|InitiativeTrackerPlus]] -- Initiative and effect tracker with other features. | ||
| − | + | == 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 <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 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. | ||
| Line 63: | Line 63: | ||
* '''{{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}} | * '''{{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: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. | ||
* {{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]]) | * {{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. | * [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on dynamic lighting. | ||
| Line 70: | Line 71: | ||
* [[Script:ShareVision|ShareVision]] -- Allows normal vision and darkvision to be shared. | * [[Script:ShareVision|ShareVision]] -- Allows normal vision and darkvision to be shared. | ||
| − | + | == Jukebox == | |
The {{Jukebox}} is the music player, and some APIs interact with it | 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: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. | * [[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:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images. | * [[Script:Dungeon Utils|Dungeon Utils]] -- Generates random dungeons from wall and floor images. | ||
* [[Script:namegen|namegen]] -- Generates random names of People, Towns/Cities, and Taverns | * [[Script:namegen|namegen]] -- Generates random names of People, Towns/Cities, and Taverns | ||
* [[Script:Terrain Generator|Terrain Generator]] -- Generate simple outdoor maps (forests, deserts, etc) | * [[Script:Terrain Generator|Terrain Generator]] -- Generate simple outdoor maps (forests, deserts, etc) | ||
| − | |||
| − | + | ==Maps & Drawing== | |
Various this related to the Map that isn't related to Dynamic Lighting. | Various this related to the Map that isn't related to Dynamic Lighting. | ||
| − | * | + | * DryErase – An API that can stop players from drawing on the map. |
* [[Script:Map Lock|MapLock]] -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting. | * [[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: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. | * [[Script:TruePageCopy|TruePageCopy]] -- Duplicate page graphics by chat command, or with the Duplicate Page button. | ||
| − | + | ==Tokens== | |
===Movement, Rotation, and Size === | ===Movement, Rotation, and Size === | ||
| Line 101: | Line 101: | ||
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order. | * [[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:Move Lighting|Move Lighting]] -- Move dynamic lighting polygon path objects between game layers. | * [[Script:Move Lighting|Move Lighting]] -- Move dynamic lighting polygon path objects between game layers. | ||
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle. | * [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle. | ||
* {{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. | * {{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:Token Lock| | + | * [[Script:Token Lock|TokenLock]] -- Allows GMs to selectively lock the movement of Player Tokens. |
* [[Script:DupCharToken|DupCharToken]] -- Duplicate a Character and Token, and add identifying number to Character and Token. | * [[Script:DupCharToken|DupCharToken]] -- Duplicate a Character and Token, and add identifying number to Character and Token. | ||
* [[Script:tokenFate|Token Fate]] -- Let fate decide! Randomly selects a token from the selected group. | * [[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:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically | ||
| + | * [[Script:Spin Tokens|SpinTokens]] -- Allows the GM to toggle spinning of selected 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:Flight|Flight]] -- Mark how high tokens are flying | * [[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: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: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. | 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. | ||
| Line 126: | Line 128: | ||
| − | + | == 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 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). | 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. | |
| − | === | + | === D&D 5E === |
| − | Many APIs beyond the ones listed here are made with | + | 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 most used [[D&D 5E by Roll20]] character sheet. In the one-click menu, most should have a name starting with '''D&D 5E'''. 5E is the system that have most system-specific APIs by a large maraigin. |
* [https://github.com/Roll20/roll20-api-scripts/tree/master/5th%20Edition%20OGL%20by%20Roll20%20Companion 5th Edition OGL by Roll20 Companion] -- Companion script for '''[[D&D 5E by Roll20]]''' character sheet | * [https://github.com/Roll20/roll20-api-scripts/tree/master/5th%20Edition%20OGL%20by%20Roll20%20Companion 5th Edition OGL by Roll20 Companion] -- 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. | * [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. | ||
* [[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 | * [[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 | ||
| + | * '''5E BattleMaster''' | ||
| + | * '''CashMaster''' | ||
| + | * '''Concentration''' | ||
| + | * '''It's a Trap! - D&D 5E Generic''' (should detect automatically what sheet is used) | ||
| + | * '''ShortRest''' | ||
| + | * '''SpellMaster''' | ||
| + | * '''WildShape''' | ||
| − | + | === 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. | * ''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 === | |
* [[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: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. | ||
| − | + | === Chronique Oubliées === | |
* [[Script:COFantasy|COFantasy]] -- Combats, Skills and Spells support | * [[Script:COFantasy|COFantasy]] -- Combats, Skills and Spells support | ||
| − | + | === Cypher System === | |
* [[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. | * [[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. | * ''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 [[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. | 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, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space" | * [[Script:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space" | ||
| − | + | === Earthdawn === | |
* [[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. | * [[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=== | |
* ''Exalted 3rd Edition Dice Roller'' -- A more robust dice rolling script for use with the Exalted Third Edition game system. | * ''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. | * [[Script:exaltScript|exaltScript]] -- Adds general utility and automation to Exalted 3rd Edition campaigns. | ||
| − | + | === 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. | ||
| − | + | === HERO Systems === | |
This includes Champions, Star HERO, Fantasy HERO, Traveller HERO, etc. | This includes Champions, Star HERO, Fantasy HERO, Traveller HERO, etc. | ||
* [[Script:HeroRoller|Hero Roller (aka HeRoller)]] -- A comprehensive roller for HERO systems. | * [[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|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)"]. | * [[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 === | |
* [[Script:Skillbook|Pathfinder Skillbook]] -- Generate token action to put API buttons for skills in chat window | * [[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 | * [[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 | * ''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 === | |
* [[Script:Pathfinder_2_Utilities|Pathfinder 2 Utilities]] -- automatically roll Pathfinder 2 abilities and display their effect references, and track modifiers. | * [[Script:Pathfinder_2_Utilities|Pathfinder 2 Utilities]] -- automatically roll Pathfinder 2 abilities and display their effect references, and track modifiers. | ||
| − | + | === 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. | * [[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. | * ''Savage Worlds Status Changer'' -- This script makes it easy to assign a status to a set of selected tokens. | ||
| − | + | === Star Wars === | |
* [[Script:Star Wars: Fantasy Flight Games - Dice Roller|Star Wars: FFG - Dice Roller]] -- Dice Roller for the [[Star Wars: FFG (API-Compatible)]]-character sheet | * [[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) | * ''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" | * [[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''' | '''5E''' | ||
| Line 202: | Line 211: | ||
* [[Script:SR-NextPass|SR-NextPass]] -- GM aid to handle moving on to the next initiative pass | * [[Script:SR-NextPass|SR-NextPass]] -- GM aid to handle moving on to the next initiative pass | ||
| − | + | === 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. | ||
| − | + | ===Warhammer Fantasy Roleplay=== | |
'''2E''' | '''2E''' | ||
| Line 217: | Line 226: | ||
| − | + | == 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. | '''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. | ||
| Line 229: | Line 238: | ||
* [[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. | ||
| − | |||
| − | |||
| − | |||
=API scripts elsewhere= | =API scripts 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 the One-Click install== | ==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. | 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" | * {{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) | * [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks (Obsolete - no longer supported) | ||
| Line 249: | Line 251: | ||
* [[Script:Morality|Morality]] -- A dialog prompt that provides morality choices as decisions (link to github) | * [[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) | * [[Script:Track V20 Attributes|Track V20 Attributes]] -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.(link to Github) | ||
| + | = 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> | ||
<br> | <br> | ||
[[Category:API|Script Index]] | [[Category:API|Script Index]] | ||
Revision as of 18:34, 26 December 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. |
Roll20 Mod
Use Mods
- Use & Install
- Mod:Script Index & Suggestions
- Short Community Scripts
- Meta Scripts
- User Documentation
- Mod Scripts(Forum)
- Macro Guide
Mod Development
Reference
- Objects
- Events
- Chat Events & Functions
- Utility Functions
- Function documentation
- Roll20 object
- Token Markers
- Sandbox Model
- Debugging
Cookbook
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
 | 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. |
 | 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 Andreas J. (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.
Some great or popular APIs have their name highlighted in bold to stand out.
Characters
Various scripts related to Character Sheets, and managing them.
- CharSheet -- Allow players to create their own character sheets.
- Welcome Package(Forum) -- 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.
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.
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.
- GroupCheck -- A way to quickly roll a group check for everyone and see if they succeed
- ApplyDamage(Forum) -- 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
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.
- emas -- Provides player
!emasand!ascommands.(emote as) - 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
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.
- CombatMaster(Forum) -- 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. CombatMaster repo
- 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.
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.
- DoorKnocker(Forum) -- Script helps quickly open and close doors by controlling the dynamic lighting lines. sourcecode
- 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.
- One-Way Dynamic Lighting(Forum) -- 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.
- UDLWindows(Forum) -- 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.
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.
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)
Maps & Drawing
Various this related to the Map that isn't related to Dynamic Lighting.
- 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.
Tokens
Movement, Rotation, and Size
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
- TokenMod -- An interface to adjusting properties of a token from a macro or the chat area.
- 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. Has separate versions customised for specific games/sheets
- Marching Order -- Makes tokens follow each other in some specified order.
- Measure -- Measure distances between multiple tokens, both from the corners and the center.
- 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.
- Teleport(Forum) -- Teleports tokens within a page or between pages either by chat menu or token movement by using teleport tokens on the GM layer.
- TokenLock -- Allows GMs to selectively lock the movement of Player Tokens.
- DupCharToken -- Duplicate a Character and Token, and add identifying number to Character and Token.
- 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.
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
- 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.
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.
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.
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 most used D&D 5E by Roll20 character sheet. In the one-click menu, most should have a name starting with D&D 5E. 5E is the system that have most system-specific APIs by a large maraigin.
- 5th Edition OGL by Roll20 Companion -- 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 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
- 5E BattleMaster
- CashMaster
- Concentration
- It's a Trap! - D&D 5E Generic (should detect automatically what sheet is used)
- ShortRest
- SpellMaster
- WildShape
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"
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.
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.
- Base64 -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
- Extended Syntax Roll20 Objects -- Wraps objects to extend their functionality.
- Interpreted sendChat -- Send a message to the chat as the same person or character that triggered a chat event
- 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.
API scripts 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 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.
- Tracker Jacker(Forum) -- Combat API, formerly known as "Initiative Tracker Plus"
- Creature Gen -- Generate combat ready tokens from PRD and D20PFSRD statblocks (Obsolete - no longer supported)
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)
- Track V20 Attributes -- Track character Disciplines, Paths, and Backgrounds for use with macros and other scripts.(link to Github)
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.
