Difference between revisions of "ScriptCards Scripts"
From Roll20 Wiki
(→Template: Example Script Name) |
Zachary B. (Talk | contribs) (→Guide to completing the Info Section:) |
||
| Line 49: | Line 49: | ||
'''Author of script:''' Your Discord or Roll20 Forum name<br> | '''Author of script:''' Your Discord or Roll20 Forum name<br> | ||
| − | '''Game/System specific? Which one:''' Either put " | + | '''Game/System specific? Which one:''' Either put "System Neutral" or put the name of the game/system your script works with<br> |
'''Purpose of script:''' Provide an overall description of the purpose of the script<br> | '''Purpose of script:''' Provide an overall description of the purpose of the script<br> | ||
| Line 61: | Line 61: | ||
'''Screenshots:''' Initial screenshots; more can be added throughout the body of the contents if desired.<br> | '''Screenshots:''' Initial screenshots; more can be added throughout the body of the contents if desired.<br> | ||
| − | '''Caveats/ Notes:''' N/A if none, otherwise please describe. Please put any important notes about the script's usage or behavior here.<br> | + | '''Caveats/ Notes:''' N/A if none, otherwise please describe. Please put any important notes about the script's usage or behavior here, including other dependent API's such as Token Mod.<br> |
'''Script code:''' insert the script code between the ''<nowiki><pre> ... </pre></nowiki>'' tags below this line.<br><br> | '''Script code:''' insert the script code between the ''<nowiki><pre> ... </pre></nowiki>'' tags below this line.<br><br> | ||
| Line 74: | Line 74: | ||
2. Mock-up of Link to Variant Script #2 | 2. Mock-up of Link to Variant Script #2 | ||
}} | }} | ||
| − | |||
=== Template: Example Script Name === | === Template: Example Script Name === | ||
Revision as of 20:00, 17 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, and meaningful variations, that have been tested and are working as expected.
- When submitting an original script please edit the Template: Example Script Name section and then copy the entire section (starting with === Template Script Name === all the way down through the </div><br> at the end) and paste this at the end of the Shared Scripts section, after the final script shown.
- 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 a user should be aware of up front.
- There is a guide below to help you with filling out the information section in case you get stuck anywhere.
- 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 a user should be aware of up front.
- When submitting a variation of a shared script please submit by using the following steps:
- Use the link in the Template: Example Script Name navigation box on the right side of the screen to go to the sample variation Sub-page. Edit the page and copy the entire template from the sub-page.
- Navigate to the not-yet-created URL of the sub-page you will create: wiki.roll20.net/ScriptCards_Scripts/ (Original Script Name) _Variation_ (Simple Label of Changes)
(e.g. https://wiki.roll20.net/ScriptCards_Scripts/SmartAOE_Variation_Pathfinder2e)
- You should be brought to a blank Wiki-style page that says: There is currently no text in this page. You can search for this page title in other pages, search the related logs, or edit this page.
Either click the Create button or Edit this Page as they both do the same thing: Create the page and take you into edit mode
- Once in edit mode on the new sub-page, paste the template example you copied and then fill out all the juicy details. Be sure to give credit to the amazing work of the original author that inspired your variation!
- You can preview your work with the Preview button, or Save your work with the Save button and see the finished product!
- Mention in the official Discord ScriptCards channel that you added a new subpage and please provide the link so that the navigational links can be manually created for others to view your work!
Guide to completing the Info Section:
Author of script: Your Discord or Roll20 Forum name
Game/System specific? Which one: Either put "System Neutral" or put the name of the game/system your script works 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, including other dependent API's such as Token Mod.
Script code: insert the script code between the <pre> ... </pre> tags below this line.
Variations of karma827's Example Script
1. This is the template for submitting variants!
2. Mock-up of Link to Variant Script #2
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.
