Difference between revisions of "Script:Example"
From Roll20 Wiki
m |
m (→Changelog) |
||
| Line 30: | Line 30: | ||
* Fixed formatting issues | * Fixed formatting issues | ||
'''v.1.0 (2015-01-06)''' | '''v.1.0 (2015-01-06)''' | ||
| − | * Release | + | * Release |
Revision as of 23:23, 8 January 2015
Version: 1.0
Last Modified: 2015-01-06
Code: The Darkness is Closing In
Dependencies: Bloodied and Dead Status Markers, Raise Count
Conflicts: Blood and Honor
This is an example of an API script listing to demonstrate the format we'd like contributors to mimic. Keeping a unified look will lower the barrier to entry for mentors just learning how to use API scripts in their games. In this space we're looking for a general description of the script and it's use. If there a specific installation instructions you should make a note of it here but detail them in the Readme.txt and optionally below in it's own section.
Please do not add a Code section to the wiki. Code listed here would become deprecated very easily and GitHub is the official source for that data. Please only link to the data from the menu to the right.
Contents |
Syntax
!example
!example 3
!example off
Installation and Configuration
Copy the script's code, available from the menu on the right and stored at Roll20's API GitHub Repository. Paste the code into a new script in your campaign's API Script Editor. Save the new script and it will be available inside your campaign.
Script Use
Start the script with the "!example" command and turn it off with "!example off". If you wish for the script to execute multiple times when called add a positive number after the on command, "!example 3".
Changelog
v.1.1 (2015-01-07)
- Included better documentation
- Fixed formatting issues
v.1.0 (2015-01-06)
- Release
