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
(Basic Fantasy Role Playing Game)
m
(263 intermediate revisions by 54 users not shown)
Line 1: Line 1:
{{Tocright}}
+
{{pro only}}
 +
{{Ambox
 +
|nocat=true
 +
| type  = style
 +
| text  = '''This page is severely out-of-date on what API Scripts are available in the One-Click Install menu, missing many newer scripts.''' Many of the pages linked from here are also out-of-date even if the API is still in use.
 +
}}
 +
{{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.
 +
}}
 +
<div style="float:left;margin-right:15px">__TOC__</div>
 +
{{apibox}}
  
'''Work in Progress'''
 
  
 +
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 [https://github.com/Roll20/roll20-api-scripts API GitHub Repository] and follow the instructions in the README.md file at the bottom of the page.
  
 +
<br clear="both">
 +
=Scripts available in the One-Click Install=
 
== Scripts By Category ==
 
== Scripts By Category ==
 +
 
=== General Purpose Scripts ===
 
=== General Purpose Scripts ===
 +
If your script incorporates ''specific'' game system rules, consider listing the script under that game system instead of one of these general purpose categories.
 +
 
==== Combat Scripts ====
 
==== Combat Scripts ====
* [[Script:Auto_Initiative|Auto Initiative]] -- Adds the players to the initiative tracker, rolls randomly for them and adds relevant modifiers.
+
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges between combatants.
* [[Script:Initiative_highlighter|Initiative Highlighter]] -- Highlights a token whose turn it is with a flashing aura.
+
* [[Script:Group Initiative|Group Initiative]] -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
* [[Script:Roll_Comparisons|Roll comparisons]] -- Comparing roll results.
+
* [[Script: Critical|Critical]] -- Quick method of determining the outcome of a critical hit.
* [[Script:Random_Turn_Order|Random Turn Order]] -- Randomly assigns a turn to selected tokens.
+
* [[Script: Fumbler|Fumbler]] -- Quick method of determining the outcome of a fumble.
* [[Script:Round_Tracker|Round Tracker]] -- Adds a marker in the initiative which increments automatically.
+
* [[Script:Highlight_Token_at_Top_of_Initiative|Highlight Token at Top of Initiative]] -- Highlights the token at the top of initiative.
+
* [[Script:Range_Finder|Range Finder]] -- Determines the distance between two named tokens
+
* [[Script:Automatic_Initiative_Roller_and_Round_Counter|Automatic Initiative Roller and Round Counter]] --
+
* [[Script:Cone_and_Circle_Templates|Cone and Circle Templates]] --
+
  
 
==== Tokens - Conditions / Status / Health ====
 
==== Tokens - Conditions / Status / Health ====
* [[Script:Conditions_and_Status_Tracker|Conditions and Status Tracker]] -- Tracks the status of tokens and announces them as the duration passes.
+
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.
* [[Script:Automatic_Status_Markers|Automatic Status Markers]] -- Automatically adjust status markers on tokens
+
* [[Script:Flight|Flight]] -- Mark how high tokens are flying
* [[Script:HP_Change_Announcement|HP Change Announcement]] -- Announces when tokens’ hit points changes.
+
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically
* [[Script:Heal_Chat_Command|Heal Chat Command]] -- Use commands to heal characters
+
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
* [[Script:Updated_Heal_Chat_Command|Updated Heal Chat Command]] --
+
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens
* [[Script:Automatic_Temp_HP_Management|Automatic Temp HP Management]] -- Uses temporary hit points and sets it to automatically remove them first.
+
* [[Script:Target_Marking|Target Marking]] -- System for marking tokens with status markerAuto create a token
+
  
==== Tokens - Movement ====
+
==== Tokens - Movement, Rotation, and Size ====
* [[Script:Auto_Teleporting_and_Chat_Based_Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
+
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
* [[Script:Marking_Order|Marching Order]] -- Tracking marching order of characters
+
 
* [[Script:Carrying_Tokens|Carrying Tokens]] -- Tokens carrying other tokens such as torches.
+
* [[Script:API Heart Beat|API Heart Beat]] -- Provides an API Heartbeat by setting the requesting player's color continuously.
* [[Script:Movement_Tracker_and_Aura_Highlighter|Movement Tracker and Aura Highlighter]] -- Uses auras to track character movement based on speeds.
+
* [[Script:Collision Detection|Collision Detection]] -- Handles collisions between player-controlled tokens and a subset of path objects on the page
* [[Script:Character_Token_Locator|Character Token Locator]] -- Creates an aura and shrinks it slowly to help you find your token.
+
* [[Script:KABOOM|KABOOM]] -- Creates explosion effects that move tokens away from or towards a point.
* [[Time/Torch Tracker]] -- Shrinking light auras of torches.
+
* [[Script:It's a Trap|It's a Trap]] -- Script for setting traps and detecting collisions with them at any point during movement.
* [[Script:Units_Moved|Units Moved]] -- Tracks units moved.
+
* [[Script:Marching Order|Marching Order]] -- Makes tokens follow each other in some specified order.
* [[Script:Disable_Rotation|Disable Rotation via Chat Window Command]] -- Disable the rotation of tokens in the chat window.
+
* [[Script:Measure|Measure]] -- Measure distances between multiple tokens, both from the corners and the center.
* [[Script:Visual_Hourglass|Hourglass, Stopwatch, etc.]] -- Visual UI interface. Uses for asking players to wait.
+
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit points from hit dice on add, usually via drag from journal.
* [[Script:Patrolling_Tokens|Patrolling Tokens]] -- Script for patrolling tokens.
+
* [[Script:Move Lighting|Move Lighting]] -- Move dynamic lighting polygon path objects between game layers.
* [[Script:Trap_Script|Trap script (like in vid)]] -- Script for using traps.
+
* [[Script:Random Rotate|Random Rotate]] -- Allows the GM to easily rotate all selected tokens to a random angle.
* [[Script:Interpolated_Trap_Detection|Interpolated trap detection]] --
+
* [[Script:Token Lock|Token Lock]] -- Allows GMs to selectively lock the movement of Player Tokens.
  
 
==== Lighting and Revealing ====
 
==== Lighting and Revealing ====
* [[Script:Light_Switch|Light Switch]] -- Script for turning on and off lights with chat commands.
+
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.
* [[Script:Reveal_Command|!reveal command]] -- Automatically moves tokens from the GM layer to objects layer, making them reveal to players.
+
* [[Script:DLEllipseDrawer|DLEllipseDrawer]] -- Draw circles and ellipses on the dynamic lighting layer.
* [[Script:Light_Is_Closing_In|Light is Closing In...]] -- A light reduction script for token movement.
+
* ''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'' -- Allows you to set up dynamic lighting walls that allow you to see through one side, but not the other. (for Legacy DL)
 +
* [[Script:Torch|Torch]] -- A simple script for giving lights to tokens and turning off and on 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 a powerful tool for creating immersive gaming experiences. Make it even more powerful.
 +
* [[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.
  
 
==== Characters - Equipment ====
 
==== Characters - Equipment ====
* [[Script:Set_Weapon_Value_Using_The_API|Set Weapon Values Using the API]] -- Tracks weapons equipped by characters.
+
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:Trader_Joes|Trader Joes]] -- Inventory Management
+
* [[Script:Ammo|Ammo]] -- Provides inventory management for ammunition stored in an attribute of a character.
 +
 
 +
==== Characters - 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.
 +
* [[Script:Conditions|Conditions]] -- Track attribute-modifying conditions.
 +
* [[Script:ChatSetAttr|ChatSetAttr]] -- Create, modify, and delete character attributes via chat commands or macros.
 +
* [[Script:EasyExperience|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.
  
 
==== Generators ====
 
==== Generators ====
* [[Script:Its_the_Monster_Mash|It's the Monster Mash!]] -- It's the Monster Mash! An adventure in Encounters!
+
Content generation can extend the reach of your campaign while minimizing the GM's prep time.
* [[Script:Weather_Generator_Script|Weather Generator Script]] --
+
* [[Script:CharSheet|CharSheet]] -- Allow players to create their own character sheets.
 +
* [[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:Terrain Generator|Terrain Generator]] -- Generate simple outdoor maps (forests, deserts, etc)
  
 
==== System ====
 
==== System ====
* [[Script:Graphic_Token_Snapshot_Saving_and_Loading|Graphic/Token snapshot saving/loading for building your own macros]] -- System for tracking a loading token set ups
+
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:String_Formatter|String Formatter]] -- Formats a string for printing.
+
* [[Script:Game Timer|Game Timer]] -- This is a simple script to court how long does player use the game room.
* [[Script:Detecting_Nearest_Token|Detecting Nearest Token]] -- Script for detecting the nearest token after one is moved.
+
* [[Script:DupCharToken|Duplicate a Character and Token]] -- Duplicate and add identifying number to Character and Token.
* [[Script:Chat_Command_Script|Chat Command Script]] -- Script for standardizing and preventing duplication of chat commands.
+
* [[Script:emas|emas]] -- Provides player !emas and !as commands.
* [[Script:Scrolling_Macro_Bar|Scrolling Macro Bar]] --
+
* [[Script:Map Lock|MapLock]] -- Provides locking of graphics to prevent moving/resizing/rotating them.  Also highlighting.
 +
* [[Script:Message of the Day|Message of the Day]] -- Greets players that log in with the contents of a particular note.
 +
* [[Script:MetaMacros|MetaMacros]] -- Precompiler enabling C-style textual substitution macros in macro definitions.
 +
* [[Script:Page Navigator|Page Navigator]] -- Easily move players from page to page, and allow players to move to pages by moving their tokens.
 +
* [[Script:Rollable_Table_Macros|Rollable Table Macros]] -- Use macros and chat commands with rollable tables
 +
* [[Script:Table Export|Table Export]] -- A script for exporting Rollable Tables between accounts.
 +
* [[Script:tokenFate|Token Fate]] -- Let fate decide! Randomly selects a token from the selected group.
 +
* [[Script:Token Mod|Token Mod]] -- An interface to adjusting properties of a token from a macro or the chat area.
 +
* [[Script:TruePageCopy|TruePageCopy]] -- Duplicate page graphics by chat command, or with the Duplicate Page button.
 +
* [[Script:Customizable Roll Listener|Customizable Roll Listener]] -- Customizable responses to API or non API chat messages.
  
==== Roleplay ====
+
=== Game Specific Scripts ===
* [[Script:Language_Script|Language Script]] -- A script for auto converting text to elven or dwarven.
+
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.
* [[Script:What_Did_He_Say|What Did He Say?]] -- Language based scripting
+
  
==== Misc ====
+
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).
* [[Script:API_Command_Process_Standard_Model|API command process, standard model]] -- API command process, standard model.
+
  
=== Game Specific Scripts ===
+
==== 13th Age ====
==== Edge of the Empire ====
+
* [[Script:Edge_Of_The_Empire:Dice_With_Images_In_The_Chat_Window|Edge of the Empire Dice with Images in the Chat Window]] --
+
* [[Script:Edge_Of_The_Empire:Dice|Edge of the Empire Dice]] --
+
  
==== DnD 4th Edition ====
+
* ''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.
* [[Script:DnD4E:Combat|Combat]] -- temporary hit points. Also prevents over healing.
+
* [[Script:DnD4E:Tools|Tools]] -- 4th edition. Adds marking to the Combat script.
+
* [[Script:DnD4E:Helper|4e Helper]] -- 4th edition collection of scripts.
+
* [[Script:DnD4E:Combat_Engine|4e combat engine]] --
+
* [[Script:DnD4E:Monster_Generator_Base_On_MM3_Math|4e Monster generator based on MM3 math]] --
+
  
==== Zombie Dice ====
+
==== Ars Magica ====
* [[Script:Zombie_Dice:Zombie_Dice|Zombie Dice]] -- A Script for playing zombie dice
+
* [[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.
  
==== Basic Fantasy Role Playing Game ====
+
==== Chronique Oubliées ====
* [[Script:Basic_Fantasy_Role_Playing_Game:General|Basic Fantasy Role-Playing Game]] --
+
* [[Script:COFantasy|COFantasy]] -- Combats, Skills and Spells support
  
==== HERO System ====
+
==== Cypher System ====
[Script] HERO System scripts to automate the combat
+
* [[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.
  
==== AD&D (Dungeons and Dragons 2e)  ====
+
==== d6 System ====
2nd Ed 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:Wild Dice|Wild Dice]] -- Implements the Wild Dice rolling mechanic, used in "Star Wars D6", "D6 Adventure", "D6 Fantasy", and "D6 Space"  
 +
 
 +
==== Dungeons & Dragons ====
 +
 
 +
'''5E'''
 +
 
 +
Many APIs beyond the ones listed here are made with 5E in mind, or have specific commands tailored to work with the most used [[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
 +
* [[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
 +
 
 +
==== 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.
 +
 
 +
==== Exalted====
 +
* ''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 ====
 +
* [[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.
 +
* [[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: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 ====
PFRPG-ALL-IN-ONEPathfinder Character Sheet Generator v3Character sheet generator for PathfinderInspired Collection
+
* [[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
 +
 
 +
==== Pathfinder 2nd Edition ====
 +
* [[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: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 ====
 +
* [[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 ====
 +
* [[Script:GUMSHOE|GUMSHOE]] -- A point-spending script for GUMSHOE games. Integrates with supporting character sheets.
 +
 
 +
 
 +
====Warhammer Fantasy Roleplay====
 +
 
 +
'''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.
 +
 
 +
=== Utility Scripts ===
 +
These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.
 +
* [[Script:Base64|Base64]] -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
 +
* [[Script:ESRO|Extended Syntax Roll20 Objects]] -- Wraps objects to extend their functionality.
 +
* [[Script:Interpreted sendChat|Interpreted sendChat]] -- Send a message to the chat as the same person or character that triggered a chat event
 +
* [[Script:levenshteinDistance|levenshteinDistance]] -- Measure the difference between strings
 +
* [[Script:splitArgs|splitArgs]] -- Split a string into arguments
 +
* [[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: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.
 +
 
 +
=== 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.
 +
=API scripts elsewhere=
 +
This is an incomplete list of Roll20 API that aren't available in the One-Click Install menu in Roll20, but might be hosted elsewhere and manually installed.
 +
 
 +
==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.
  
==== Star Wars Saga ====
+
* [[Script:Spin Tokens|Spin Tokens]] -- Allows the GM to toggle spinning of selected tokens.
Star Wars Saga Edition Character Sheet
+
* [[Script:Dynamic Light Recorder|Dynamic Light Recorder]] -- Save dynamic lighting paths for map tiles and automatically regenerate later
==== Fantasy Craft 2nd Printing ====
+
* [[Script:Token Name Number|Token Name Number]] -- Automatic Numbering of tokens with special placeholder.
Fantasy Craft (2nd printing) - Standard character token managementFantasy Craft - Standard character damage save
+
* [[Script:MapChange|MapChange]] -- Provides an easy and user friendly way to move players between maps.
 +
* [[Script:Creature Gen|Creature Gen]] -- Generate combat ready tokens from PRD and D20PFSRD statblocks (Obsolete - no longer supported)
  
== API Docs ==
+
==User-hosted API==
== API Cookbook ==
+
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles. (link to a github gist of the API)
== API Best Practices ==
+
* [[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)
 +
<br>
 +
<br>
 +
[[Category:API|Script Index]]

Revision as of 16:32, 17 June 2020

Contents

Roll20 API

Getting Started


Reference


Cookbook (Examples)


Community Scripts

  • Script Index


The API Script Index is a listing of community-contributed API scripts that are available for use on Roll20. If you're interested in contributing to the Roll20 API Community Scripts please visit the API GitHub Repository and follow the instructions in the README.md file at the bottom of the page.


Scripts available in the One-Click Install

Scripts By Category

General Purpose Scripts

If your script incorporates specific game system rules, consider listing the script under that game system instead of one of these general purpose categories.

Combat Scripts

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

  • Group Initiative -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
  • Critical -- Quick method of determining the outcome of a critical hit.
  • Fumbler -- Quick method of determining the outcome of a fumble.

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
  • Flip Tokens -- Flip graphics horizontally and/or vertically
  • 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

Tokens - Movement, Rotation, and Size

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

  • API Heart Beat -- Provides an API Heartbeat by setting the requesting player's color continuously.
  • 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.
  • Marching Order -- Makes tokens follow each other in some specified order.
  • Measure -- Measure distances between multiple tokens, both from the corners and the center.
  • Monster Hit Dice -- Set Monster hit points from hit dice on add, usually via drag from journal.
  • 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.
  • Token Lock -- Allows GMs to selectively lock the movement of Player Tokens.

Lighting and Revealing

Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the walls layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.

  • DLEllipseDrawer -- Draw circles and ellipses on the dynamic lighting layer.
  • 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 -- Allows you to set up dynamic lighting walls that allow you to see through one side, but not the other. (for Legacy DL)
  • Torch -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
  • Walls -- Builds dynamic lighting walls with an exported SVG path file.
  • ShareVision -- Allows normal vision and darkvision to be shared.

Jukebox

The jukebox is a powerful tool for creating immersive gaming experiences. Make it even more powerful.

  • Roll20 Audio Master -- Comprehensive jukebox control script; play, stop, and loop tracks. Adjust volume of tracks. Create, edit, play, stop, loop, and shuffle playlists.

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

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

Generators

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

  • CharSheet -- Allow players to create their own character sheets.
  • 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)

System

Scripts in this category are a bit more meta than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.

  • Game Timer -- This is a simple script to court how long does player use the game room.
  • Duplicate a Character and Token -- Duplicate and add identifying number to Character and Token.
  • emas -- Provides player !emas and !as commands.
  • MapLock -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.
  • Message of the Day -- Greets players that log in with the contents of a particular note.
  • MetaMacros -- Precompiler enabling C-style textual substitution macros in macro definitions.
  • Page Navigator -- Easily move players from page to page, and allow players to move to pages by moving their tokens.
  • Rollable Table Macros -- Use macros and chat commands with rollable tables
  • Table Export -- A script for exporting Rollable Tables between accounts.
  • Token Fate -- Let fate decide! Randomly selects a token from the selected group.
  • Token Mod -- An interface to adjusting properties of a token from a macro or the chat area.
  • TruePageCopy -- Duplicate page graphics by chat command, or with the Duplicate Page button.
  • Customizable Roll Listener -- Customizable responses to API or non API chat messages.

Game Specific Scripts

Scripts that deal with specific rules of a game system should be listed in a sub-heading here. If the appropriate game system is not listed, feel free to create the appropriate heading.

Scripts under each system below may be designed for any use (in other words, had they been system-agnostic, they might fit under any of the sub-headings in the "General Purpose Scripts" section above).

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

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"

Dungeons & Dragons

5E

Many APIs beyond the ones listed here are made with 5E in mind, or have specific commands tailored to work with the most used D&D 5E by Roll20 character sheet.

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.

Numenera

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.

Utility Scripts

These scripts are generally not intended to be used alone, but are often instead required by some of the above scripts. Alone, these scripts will not do anything for your campaign, but rather they create functions to be used by other scripts.

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.

API scripts elsewhere

This is an incomplete list of Roll20 API that aren't available in the One-Click Install menu in Roll20, but might be hosted elsewhere and manually installed.

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.

  • Spin Tokens -- Allows the GM to toggle spinning of selected tokens.
  • Dynamic Light Recorder -- Save dynamic lighting paths for map tiles and automatically regenerate later
  • Token Name Number -- Automatic Numbering of tokens with special placeholder.
  • MapChange -- Provides an easy and user friendly way to move players between maps.
  • 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)