New Official API Repository

GenKitty said:

Tweak Requested: There needs to be an easy way for someone to get in touch with the script writer for help. Writers should be strongly urged to put contact info (Email, forum thread, Roll20 id) in their help/readme file at a minimum. Beyond that, I'm not sure how a newbie user can easily get help for issues, aside from starting a new thread in a forum.

Indeed, there is a template available on the wiki to make this fairly simple:

{{script overview
|name=Dynamic Lighting Animation
|author={{user profile|235259|Brian}}
|version=2.0
|dependencies={{api repository link|splitArgs}}, {{api repository link|IsGM Auth Module}}
|conflicts={{api repository link|Store Commands}}
|lastmodified=2015-01-08}}

(The dependencies and conflicts parameters can be omitted and they'll be filled in as "None")

The {{script overview}} template makes a little sidebar menu with relevant information about the script.

{{user profile}} links to a user's profile page (not their wiki userpage); you need to supply their userid (mine is 235259), and you ought to supply the name or else the link will appear as the id number.

{{api repository link}} links to an API script on the GitHub repo. You can either link to a file directly, or link to a directory.

Other useful templates available for documenting a script on the wiki include {{API command}}, {{API parameter}}, {{changelog version}}, {{deprecated}}, {{formal API command}}, {{param description}}, {{param description bottom}}, {{param description top}}, {{syntaxbox bottom}}, and {{syntaxbox top}}.

Ken L. said:

I'd like to contribute my Mob-gen script, but I'm a big GPL, FSF guy.

Scripts submitted to the repo use the MIT license, which is FSF-approved, as well as being GPL-compatible. I believe the biggest difference between MIT and GPL is that something with a GPL license can't be used in a piece of proprietary software. Meaning, to pull a relevant example out of my hat, if you submitted a useful and popular script, Riley wouldn't be able to use any of that code to incorporate the idea into Roll20 natively. (Granted, I'm sure native additions have better options than the API library affords us scripters and so using any of the submitted code would be unnessary, but the sentiment stands.)

Brian said:

Scripts submitted to the repo use the MIT license, which is FSF-approved, as well as being GPL-compatible. I believe the biggest difference between MIT and GPL is that something with a GPL license can't be used in a piece of proprietary software.

• Ammo -- Provides inventory management for ammunition stored in an attribute of a character.
• AmmunitionTracker -- A bunch of commands to track ammunition.
• AnnounceRoll -- Prints an extra announcment of a critical or fumble to the chat when using /roll
• APIHeartBeat -- Provides an API Heartbeat by setting the requesting player's color continuously.
• Base64 -- Base 64 encoding for Roll20 Scripts. (Adapted from http://www.webtoolkit.info/ )
• BashDice -- Rolls the Bash UE Dice format with exploding.
• Blood-and-Honor -- Automatic blood spatter, pooling and trail effects.
• Bloodied and Dead Status Markers -- This script automatically adds the Red marker to represent the 'bloodied' state for any tokens that drop below half their health, and the 'dead' marker for any that drop to 0 or less. It's assumed that health is stored in Bar 1.
• Collision Detection -- Watches for collisions between player-controlled tokens and a specified subset of path objects. When a collision is detected, the script may return the token to its position prior to the move, send a warning message to the token's controller, and/or halt the token at the path acting as a barrier to movement.
• CommandShell -- Framework for chat commands
• DarknessClosingIn -- A command wrapped version of the Darkness Closing In API sample script.
• Dynamic Lighting Animation -- Animates paths on the Dynamic Lighting layer.
• Emas -- Provides player !emas and !as commands.
• EotE Dice Roller -- A Dice roller for the Edge of the Empire/Age of Rebellion/Force and Destiny Roleplaying Game
• Escalation -- Simple Escalation Die handling script, using the new custom entries with formulae.
• Exalted Successes -- Reports successes on d10 rolls for use with the Exalted game system.
• FateDots -- Provides numbered multi dots for Fate stress boxes.
• Flight -- Adds 'fluffy-wings' status icon to selected token to represent some height.
• Flip Tokens -- Flips selected graphics horizontally and/or vertically. Especially useful for games with side-view tokens, and for players who do not have access to the same context menu as GMs.
• GMCode -- Generates a unique code to authenticate the GM. Has no use on it's own, to be used with other code to provide more power to the GM.
• GroupInitiative -- Adds the selected tokens to the turn order after rolling their initiative + configurable data.
• InitiativeTracker -- Initiative and status tracker. Round counter, optional round and turn announcements, management of limited-duration status effects (with countdown of last 9 rounds in status icon)
• Interpreted sendChat -- Provides a function for other scripts to use to assist in sending messages to the chat. This script is not intended to stand alone.
• InventoryManager -- A graphical inventory manager. Inspired by John C.
• IsGM -- Adds a function, isGM(id), which returns true for gms and false for players. GM database is built in the state object automatically as players and gms send chat messages.
• IsGreater -- Trivial little script to check if the first value is greater than the second and report it to chat.
• Its A Trap -- Provides a simple means to set traps and detect when tokens move across them.
• levenshteinDistance -- Provides a levenshteinDistance function for comparing strings. This script is not intended to stand alone.
• ManualAttribute -- Creates a manual copy of an autocalculated field, and assigns it to the bar of a token.
• MapLock -- Provides locking of graphics to prevent moving/resizing/rotating them. Also highlighting.
• Mark -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
• Marking Conditions -- Sets and removes statusmarkers on tokens.
• Measure -- Measure distances between multiple tokens, both from the corners and the center.
• MonsterHitDice -- Set Monster hit dice on add, usually via drag from journal.
• MonsterHitDice5e -- Set Monster hit dice on add, usually via drag from journal. Configured for Dungeons and Dragons 5e Character Sheet
• MotD -- Greets players that log in with the contents of a particular note.
• MovePlayers -- Allows macros to move the player ribbon for players.
• No Token Rotation -- Prevents tokens from being rotated by anyone.
• Raise Count -- Counts raises for the Savage Worlds system.
• Random Turnorder -- Shuffles items in the turnorder window, and adds any selected tokens if they are not already present.
• RandomDepth -- Randomly adjusts the depth of selected tokens.
• RandomRotate -- Allows the GM to easily rotate all selected tokens to a random angle.
• SizeLock -- Toggles a state which reverts any size changes automatically.
• Slide Tokens -- Move tokens with an API command, while showing the path and waypoints as though it had been moved manually.
• SpellLevel5e --
• SpinTokens -- Allows the GM to toggle spinning of selected tokens.
• splitArgs -- Provides a function for splitting arguments of an API command. This script is not intended to stand alone.
• Store Commands -- Stores a series of commands (potentially with delays between them) to be executed in sequence later. Opens up GM-only commands such as /direct and /emas to players.
• TableExport -- A script for exporting Rollable Tables between accounts.
• TableTokenSizer -- Simple script to scale rollable tokens added to the tabletop to a given size (defaults to 3x3) an set them as not drawings.
• TempHPAndStatus -- Temp hit point manager and bloodied/dying/dead status markers.
• The Darkness is Closing In -- This script reduces the light radius of a token by 10% every time that token moves. Great for simulating 'lamps running out of oil' or similar high-stress situations.
• Tile -- Create tiled arrays of grpahics on the map layer.
• Token Collisions -- A small library for detecting collisions among tokens.
• TokenLock -- Allows GMs to selectively lock the movement of Player Tokens.
• TokenMod -- An interface to adjusting properties of a token from a macro or the chat area.
• TokenNameNumber -- Automatic Numbering of tokens with special placeholder.
• Torch -- A simple script for giving lights to tokens and turning off and on dynamic lighting.
• TurnMarker1 -- Round counter and a moving marker that shows who's turn it is.
• Twins -- Links two tokens so that they mirror each other across pages.
• UsePower -- A script for instrumenting and tracking the use of encounter and daily powers.
• Vector Math --
• Walls -- Builds dynamic lighting walls with an exported SVG path file.
• WeightedDice -- Automated creation of rollable tables where a minimum value is weighted with values it replaces. (example d6min4 possible values: 4 4 4 4 5 6)
• ZombieDice -- Rolls canceling Zombie Dice

John K. said:

Why can't there just be a section of server space dedicated to holding the API code directly at Roll20 (instead of outer sources like GitHub). When a person would like to use any specific API, they go to a page of categories and open folder or something - Then they could possibly have a list and select check-boxes on the ones they want used in their campaign. Instead of uploading a copy of the same API over possibly thousands of campaigns, have a single version that can run in multiple instances from one set of codes.

Something like this is exactly why the GitHub repo was created. Much like how you can select a character sheet (which was created by the community and uploaded to GitHub), the intent is to eventually have a similar system for API scripts.

John K. said:

Brian:
I understand the tie-ins that are created (Roll20 / Roll20 Repository / Script Wiki Index / Campaign API) but is there a way to be notified if/when a script gets updated or do I just have to constantly keep checking on the ones that I use?

Matt O. said:

Can we host our own repos? I'd like to be able to enter an address, a public key, and a branch name and have it load any .js file contained.

Black Falcon said:

Steve - What is the expected time table of having this released?

Steve K. said:

Black Falcon said:

Steve - What is the expected time table of having this released?

The Repository is live. I'm assuming you mean one-click integration? The answer to that is "yes..."

The Aaron said:

The repo is in Github: https://github.com/Roll20/roll20-api-scripts

Scott S. said:

How do I use the measure API script?