Difference between revisions of "ScriptCards Scripts"
From Roll20 Wiki
(→Template: Example Script Name) |
(→Template: Example Script Name) |
||
| Line 59: | Line 59: | ||
<span class="mw-customtoggle-SCRIPT_NAME" style="font-size:small; font-weight:normal; color:#003399;">[Expand/Collapse SCRIPT NAME]</span> | <span class="mw-customtoggle-SCRIPT_NAME" style="font-size:small; font-weight:normal; color:#003399;">[Expand/Collapse SCRIPT NAME]</span> | ||
<div class="mw-collapsible" id="mw-customcollapsible-SCRIPT_NAME" style="width: 100%;"> | <div class="mw-collapsible" id="mw-customcollapsible-SCRIPT_NAME" style="width: 100%;"> | ||
| − | < | + | <!-- AFTER PASTING THE TEMPLATE: Delete any text between the symbols: <! -- -- > as these are "internal comments" and will not be seen by a typical viewer. They're intended to be a reminder to submitters in how to use this template only. |
This template represents some basic syntax to post a script on this page. Please be sure to copy and then paste this entire section at the end of the existing list of scripts. | This template represents some basic syntax to post a script on this page. Please be sure to copy and then paste this entire section at the end of the existing list of scripts. | ||
When updating your copy of the template, please remember the following tips: | When updating your copy of the template, please remember the following tips: | ||
| Line 65: | Line 65: | ||
span class="mw-customtoggle-SCRIPT_NAME" and id="mw-customcollapsible-SCRIPT_NAME" | span class="mw-customtoggle-SCRIPT_NAME" and id="mw-customcollapsible-SCRIPT_NAME" | ||
Capitals matter, so be sure to pay close attention. | Capitals matter, so be sure to pay close attention. | ||
| − | AFTER PASTING THE TEMPLATE: DELETE ABOVE THIS ROW so that "Author of script" comes right after the ''div class'' line above. | + | AFTER PASTING THE TEMPLATE: DELETE ABOVE THIS ROW so that "Author of script" comes right after the ''div class'' line above. --> |
| − | '''Author of script:''' <br/> | + | '''Author of script:''' <!-- Your Discord or Roll20 Forum name --><br/> |
| − | '''Game/System specific? Which one:''' <br/> | + | '''Game/System specific? Which one:''' <!-- Either put "Not specific" or put the name of the game/system your script work with --> <br/> |
| − | '''Purpose of script:''' | + | '''Purpose of script:''' <!-- Provide an overall description of the purpose of the script --> <br/> |
| − | '''Description of intended results:''' <br/> | + | '''Description of intended results:''' <!-- Describe how a user should expect to interact with your script and what they should expect to see when it works. Doesn't need to be too detailed; just enough for a user to know if the script is not working as intended. --> <br/> |
| − | '''Screenshots:''' | + | '''Screenshots:''' <!-- Initial screenshots; more can be added throughout the body of the contents if desired. --> <br/> |
| − | '''Caveats/ Notes:''' <br/> | + | '''Caveats/ Notes:''' <!-- N/A if none, otherwise please describe. Please put any important notes about the script's usage or behavior here. --> <br/> |
'''Script code:''' <!--Note: Be sure to keep the <pre>...</pre> tags around your main script code to prevent issues with anything in the script being considered as code to the Wiki page.--> | '''Script code:''' <!--Note: Be sure to keep the <pre>...</pre> tags around your main script code to prevent issues with anything in the script being considered as code to the Wiki page.--> | ||
<pre> Enter script code here</pre> | <pre> Enter script code here</pre> | ||
Revision as of 16:48, 15 June 2023
Related Links
Roll20 Forum Links:
ScriptCards Thread on the Roll20 Mod Forums
ScriptCards Mod Working and Sharing thread in the Roll20 Forums
GitHub Links:
ScriptCards Changelog on GitHub
ScriptCards API
ScriptCards Samples on the Official GitHub
Roll20 Wiki Links:
Main ScriptCards Wiki Page
ScriptCards User-submitted scripts
ScriptCards User-submitted Library Handouts
ScriptCards User-submitted Triggers
Official Discord:
ScriptCards Official Discord Channel
YouTube Tutorials:
ScriptCards Intro
ScriptCards Magic Missile Deep Dive
Working scripts for ScriptCards
Contents |
This page is intended to be a centralized repository of working scripts that have been tested and are working as expected. When adding a script, please copy the Template section starting with === Template Script Name === all the way down through the </div><br> at the end.
Please update the info section to provide your name, describe if the script is specific to a particular game/system, the purpose, description of intended results, screenshots, and any caveats or notes someone should be aware of up front.
Guide to completing the Info Section:
Author of script: Your Discord or Roll20 Forum name
Game/System specific? Which one: Either put "Not specific" or put the name of the game/system your script work with
Purpose of script: Provide an overall description of the purpose of the script
Example 1: This script attempts to haggle with vendors
Example 2: This script identifies the remaining health of combat targets
Description of intended results: Describe how a user should expect to interact with your script and what they should expect to see when it works. Doesn't need to be too detailed; just enough for a user to know if the script is not working as intended.
Example 1: The user will press a macro button to activate, which will generate several options for their attempt to haggle with vendors based on certain skills or attributes.
Example 2: This script will always be on once activated. It will outline combat targets with green/ yellow/ red based on remaining health being above 80%, 50% or below 25% respectively
Screenshots: Initial screenshots; more can be added throughout the body of the contents if desired.
Caveats/ Notes: N/A if none, otherwise please describe. Please put any important notes about the script's usage or behavior here.
Script code: insert the script code between the <pre> ... </pre> tags below this line.
Template: Example Script Name
[Expand/Collapse SCRIPT NAME]
Author of script:
Game/System specific? Which one:
Purpose of script:
Description of intended results:
Screenshots:
Caveats/ Notes:
Script code:
Enter script code here
Below you'll find the good stuff. You can use the table of contents for quick navigation. As long as the Script name is surrounded by "===" on both sides, it'll automatically be added to the table of contents.
