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
(API is mentors-only, not subscribers-only)
(section descriptions)
Line 2: Line 2:
 
{{Tocright}}
 
{{Tocright}}
  
This repository is the collection of all the community-contributed API scripts that are available for use on Roll20.
+
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.
 
+
== Contributing ==
+
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.
+
  
 
== 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 ====
 +
Combat scripts assist in making combat flow more easily. This can mean anything from automatically handling initiative to automating exchanges betwen combatants.
 
* [[Script:Auto Initiative|Auto Initiative]] -- Adds the players to the initiative tracker, rolls randomly for them and adds relevant modifiers.
 
* [[Script:Auto Initiative|Auto Initiative]] -- Adds the players to the initiative tracker, rolls randomly for them and adds relevant modifiers.
 
* [[Script:Automatic Initiative Roller and Round Counter|Automatic Initiative Roller and Round Counter]] --
 
* [[Script:Automatic Initiative Roller and Round Counter|Automatic Initiative Roller and Round Counter]] --
Line 22: Line 23:
  
 
==== Tokens - Conditions / Status / Health ====
 
==== Tokens - Conditions / Status / Health ====
 +
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.
 
* [[Script:Automatic Status Markers|Automatic Status Markers]] -- Automatically adjust status markers on tokens
 
* [[Script:Automatic Status Markers|Automatic Status Markers]] -- Automatically adjust status markers on tokens
 
* [[Script:Automatic Temp HP Management|Automatic Temp HP Management]] -- Uses temporary hit points and sets it to automatically remove them first.
 
* [[Script:Automatic Temp HP Management|Automatic Temp HP Management]] -- Uses temporary hit points and sets it to automatically remove them first.
Line 33: Line 35:
 
* [[Script:Target Marking|Target Marking]] -- System for marking tokens with status markerAuto create a token
 
* [[Script:Target Marking|Target Marking]] -- System for marking tokens with status markerAuto create a token
 
* [[Script:Updated Heal Chat Command|Updated Heal Chat Command]] --  
 
* [[Script:Updated Heal Chat Command|Updated Heal Chat Command]] --  
 
{{apibox top|right}}
 
{{apibox getting started}}
 
{{apibox reference}}
 
{{apibox bottom}}
 
  
 
==== Tokens - Movement ====
 
==== Tokens - Movement ====
 +
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
 
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
 
* [[Script:Auto Teleporting and Chat Based Teleporting|Auto Teleporting and Chat Based Teleporting]] -- Teleporting based on text commands or token locations.
 
* [[Script:Carrying Tokens|Carrying Tokens]] -- Tokens carrying other tokens such as torches.
 
* [[Script:Carrying Tokens|Carrying Tokens]] -- Tokens carrying other tokens such as torches.
Line 56: Line 54:
  
 
==== Lighting and Revealing ====
 
==== Lighting and Revealing ====
 +
Dynamic lighting is a subscriber feature that changes what parts of the map are visible to the players as they move their tokens around. The light-blocking walls are achieved by paths on the <code>walls</code> layer, and tokens are used as point light sources. Scripts which modify either the light emitted by tokens or the walls which block the light belong in this category.
 
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer
 
* [[Script:Dynamic Lighting Animation|Dynamic Lighting Animation]] -- Animate a sequence of changes to the dynamic lighting layer
 
* [[Script:Light Switch|Light Switch]] -- Script for turning on and off lights with chat commands.
 
* [[Script:Light Switch|Light Switch]] -- Script for turning on and off lights with chat commands.
Line 62: Line 61:
  
 
==== Characters - Equipment ====
 
==== Characters - Equipment ====
 +
Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.
 
* [[Script:Set Weapon Value Using The API|Set Weapon Values Using the API]] -- Tracks weapons equipped by characters.
 
* [[Script:Set Weapon Value Using The API|Set Weapon Values Using the API]] -- Tracks weapons equipped by characters.
 
* [[Script:Trader Joes|Trader Joes]] -- Inventory Management
 
* [[Script:Trader Joes|Trader Joes]] -- Inventory Management
  
 
==== Generators ====
 
==== Generators ====
 +
Random content generation can extend the reach of your campaign while minimizing the GM's prep time. It may be difficult to use these scripts for an in-depth story-driven game, but they'll be great for a random dungeon crawl!
 
* [[Script:Its the Monster Mash|It's the Monster Mash!]] -- It's the Monster Mash! An adventure in Encounters!
 
* [[Script:Its the Monster Mash|It's the Monster Mash!]] -- It's the Monster Mash! An adventure in Encounters!
 
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles
 
* [[Script:Random Dungeon Generator|Random Dungeon Generator]] -- Generates random dungeons with geomorphic tiles
 
* [[Script:Weather Generator Script|Weather Generator Script]] --
 
* [[Script:Weather Generator Script|Weather Generator Script]] --
 +
 +
==== Roleplay ====
 +
Scripts which attempt to make the game more immersive belong in this category.
 +
* [[Script:Language Script|Language Script]] -- A script for auto converting text to elven or dwarven.
 +
* [[Script:What Did He Say|What Did He Say?]] -- Language based scripting
  
 
==== System ====
 
==== System ====
 +
Scripts in this category are a bit more ''meta'' than the ones listed above. These scripts assist with Roll20 itself more than they assist the game you're playing.
 +
* [[Script:API Command Process Standard Model|API command process, standard model]] -- API command process, standard model.
 
* [[Script:Chat Command Script|Chat Command Script]] -- Script for standardizing and preventing duplication of chat commands.
 
* [[Script:Chat Command Script|Chat Command Script]] -- Script for standardizing and preventing duplication of chat commands.
 
* [[Script:Custom Power Cards|Custom Power Cards]] -- Format messages for chat in an compact and appealing manner
 
* [[Script:Custom Power Cards|Custom Power Cards]] -- Format messages for chat in an compact and appealing manner
Line 79: Line 87:
 
* [[Script:String Formatter|String Formatter]] -- Formats a string for printing.
 
* [[Script:String Formatter|String Formatter]] -- Formats a string for printing.
  
==== 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 ===
 
 
==== AD&D (Dungeons and Dragons 2e)  ====
 
==== AD&D (Dungeons and Dragons 2e)  ====
 
* [[Script:Character Sheet (AD&D)|Character Sheet (AD&D)]] --
 
* [[Script:Character Sheet (AD&D)|Character Sheet (AD&D)]] --
Line 104: Line 109:
 
* [[Script:Dice With Images In The Chat Window (EotE)|Dice with Images in the Chat Window]] --
 
* [[Script:Dice With Images In The Chat Window (EotE)|Dice with Images in the Chat Window]] --
  
==== Exalted Second Edition ====
+
==== Exalted, Second Edition ====
 
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.
 
* [[Script:Exalted Successes|Successes]] -- reports successes for d10 rolls per ''Exalted'' rules.
  

Revision as of 17:23, 22 January 2015


Contents


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

Scripts By Category

General Purpose Scripts

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

Combat Scripts

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

Tokens - Conditions / Status / Health

Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.

Tokens - Movement

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

Lighting and Revealing

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

Characters - Equipment

Most game systems have some form of equipment to make characters better. While scripts dealing with that equipment may necessarily bet system-specific, there are scripts which handle equipment in a more general fashion.

Generators

Random content generation can extend the reach of your campaign while minimizing the GM's prep time. It may be difficult to use these scripts for an in-depth story-driven game, but they'll be great for a random dungeon crawl!

Roleplay

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

System

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

Game Specific Scripts

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

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

AD&D (Dungeons and Dragons 2e)

Basic Fantasy Role Playing Game

DnD 4th Edition

Edge of the Empire

Exalted, Second Edition

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

Fantasy Craft 2nd Printing

HERO System

Pathfinder

Savage Worlds

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

Star Wars Saga

Zombie Dice

Utility Scripts

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

  • CommandShell -- Framework for marshalling chat commands with POSIX-shell-style arguments, permissions, and duplicate-command checking.
  • GMCode -- Generates a unique code to authenticate the GM.
  • Interpreted sendChat -- Send a message to the chat as the same person or character that triggered a chat event
  • IsGM Auth Module -- Provides a function isGM() for determining if a player id refers to a gm. Intended for use alongside other scripts.
  • levenshteinDistance -- Measure the difference between strings
  • splitArgs -- Split a string into arguments
  • Token Collisions -- A library for detecting collisions among tokens during movement.
  • Vector Math -- A library for vector mathematics.