Difference between revisions of "R20es: User Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (The tools)
m
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[File:R20esLOGO.png|right|frameless|250px]]
+
__INDEX__
<p style="text-align:right;">'''VTTes/R20es''' {{R20esversion}}</p>
+
{{R20esHeader}}
 
 
 
{{SupportR20esDisclaimer}}
 
{{SupportR20esDisclaimer}}
  
 
<br/>
 
<br/>
 
 
You ''may'' have been looking for help on the '''Roll20 Enhancement Suite''' (also known as VTTes or R20es) and if so, this will hopefully answer the common questions around such.
 
You ''may'' have been looking for help on the '''Roll20 Enhancement Suite''' (also known as VTTes or R20es) and if so, this will hopefully answer the common questions around such.
  
 
So, for that let's directly link to where you likely want to go...
 
So, for that let's directly link to where you likely want to go...
  
[[R20es Install Guide|'''💾Installation Guide''']] <br/> [[Troubleshooting: R20es|'''🔧Troubleshooting Guide''']] <br/> [[Feature: R20es|'''📋 Features Guide''']] <br/> [https://ssstormy.github.io/roll20-enhancement-suite '''🔖 Website'''] <br/> [https://ssstormy.github.io/roll20-enhancement-suite/contribute.html '''☕ Support development''']
+
: [[R20es Install Guide|'''💾Installation Guide''']]
 +
: [[Troubleshooting: R20es|'''🔧Troubleshooting Guide''']]  
 +
: [[Feature: R20es|'''📋 Features Guide''']]  
 +
: [https://ssstormy.github.io/roll20-enhancement-suite '''🔖 Website''']  
 +
: [https://ssstormy.github.io/roll20-enhancement-suite/contribute.html '''☕ Support development''']
  
 
<br/><br/>
 
<br/><br/>
 +
===What it's '''not'''===
 +
:The first thing you should know is that's ''not'' 5eTools, and not BetteR20. It's an extension made by [https://twitter.com/justas_dabrila '''Justas "Stormy" Dabrila''']. It is a way to enhance Roll20 with a number of usability and UI elements that expand, and even simplify running Roll20. His work stands alone, and so these pages reflect users understanding of his work.
  
==='''NOT''' BetteR20 or 5eTools===
+
:Errors made here in the wiki are reflective only of the wiki's author(s), and not of the work Stormy has done.
The first thing you should know is that's ''not'' 5eTools, and not BetteR20. It's an extension made by [https://twitter.com/justas_dabrila '''Justas "Stormy" Dabrila''']. It is a way to enhance Roll20 with a number of usability and UI elements that expand, and even simplify running Roll20. His work stands alone, and so these pages reflect users understanding of his work.
 
 
 
Errors made here are reflective only of the author(s), and not of the work Stormy has done.
 
  
 
<br/>
 
<br/>
  
===How do I get it?===
+
===What it is===
First... can you run it?
+
:The [https://ssstormy.github.io/roll20-enhancement-suite/ VTT Enhancement Suite] (aka VTT es and R20es) is according to its creator <code>An unofficial quality of life and workflow extension for Roll20.</code>
  
{{Supportedbrowserversion}}
+
<br/>
 +
:In reality its a work of passion and no small amount of effort and genius made by a single person, Stormy (Justas Dabrila). R20es is an extension written in javascript and is an open-source project under GPL-3.0.
  
 
<br/>
 
<br/>
 +
:It is an extension for the browser, which is to say - it's a program that runs only in the browser and only when you access Roll20.net. It does not monitor or share your information nor does it ''hack'' the Roll20 website, what it does do it modify the data the website provides to browser so that things work a bit different.
  
Then, it depends on what browser you are using.
+
<br/>
 +
:R20es is, in short, safe. Better yet, it makes Roll20 better.
  
:For ''Chrome'', you go [https://chrome.google.com/webstore/detail/vtt-enhancement-suite/fadcomaehamhdhekodcpiglabcjkepff?hl=en-GB '''here'''] <br/>
+
<br/>
:For ''Firefox'', you go [https://addons.mozilla.org/en-US/firefox/addon/roll20-enhancement-suite/ '''here'''] <br/>
 
  
For Opera ... realize you'll get NO support for BetteR20 if you are attempting to use it, but ...
+
===What this page is===
  
for a more detailed guide - see the [[R20es Install Guide|'''💾 R20es installation guide'''.]]
 
  
===How do you use it?===
+
===How do I get it?===
Mostly, it's going to be about how you play.
+
:First... can you run it?
There are LOTS of [[Feature: R20es|'''features''']] in VTTes/R20es, and you'll need to understand what you can do before anyone can tell you how to do what you may want to do with it...
+
:: See [[Template:Supportedbrowserversion|'''here''']]
  
 
<br/>
 
<br/>
 +
: Then, it will depend upon what browser you are using.
  
but chances are, you want to play with [[Feature: Animated Background|'''animated backgrounds''']], or [[Feature: Libre Audio|'''playlists/tracks''']].
+
::* For ''Chrome'', you go [https://chrome.google.com/webstore/detail/vtt-enhancement-suite/fadcomaehamhdhekodcpiglabcjkepff?hl=en-GB '''here''']  
 +
:: *For ''Firefox'', you go [https://addons.mozilla.org/en-US/firefox/addon/roll20-enhancement-suite/ '''here'''] <br/>
 +
:: For Opera ... realize you'll get NO support for BetteR20 if you are attempting to use it, but ... its covered in the [[R20es Install Guide|install guide.]]
  
or are looking [[Troubleshooting: R20es|'''some help with how to get things to work.''']]
+
: for a more detailed guide - see the [[R20es Install Guide|'''💾 VTTes installation guide'''.]]
  
 +
===How do you use it?===
 +
:Mostly, it's going to be about how you play.
 +
:There are LOTS of [[Feature: R20es|'''features''']] in VTTes/R20es, and you'll need to understand what you can do before anyone can tell you how to do what you may want to do with it...
  
===The tools===
+
<br/>
[[File:VTT_Enhancement_Suite_Configuration.PNG|center|frameless|600px]]
 
  
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
+
::''but chances are,''  you want to play with [[Feature: Animated Background|'''animated backgrounds''']], or [[Feature: Libre Audio|'''playlists/tracks''']].
<div style="font-weight:bold;line-height:1.6;">Canvas</div>
 
<div class="mw-collapsible-content">
 
  
* Remember Text Tool Settings
+
::or are looking [[Troubleshooting: R20es|'''some help with how to get things to work.''']]
  
Quickly browse the official classes, and their associated subclasses. Unearthed Arcana content can be accessed by cycling the "All Sources" button.
+
<br>
  
* Animated Backgrounds
+
:: <u>Video Guides for installation/overview of features</u>
 +
::: [https://www.youtube.com/watch?v=UMIyrOKP9Mg Corey Longnecker's Castle Class Presents: Roll20 - Class 2 - VTT Enhancement Suite for Roll20]
 +
::: [https://www.youtube.com/watch?v=P-qT3gfLcLg Eran Arbel's Roll20 Master Series]
 +
::: [https://www.youtube.com/watch?v=ksyBgnCk0Y4 en français]
 +
::: [https://www.youtube.com/watch?v=J5mhHALFVTw em português]
  
A list of the various Backgrounds for character development
+
===VTTes Configuration===
 +
:In Roll20, click the sidetoolbar's [[File:R20Settings.PNG|20px]] setting, and if VTTes/R20es is loaded properly (see Installation Guide) you will see the buttons for VTTes Tools and VTTes Config.
  
* Alternative Token Radial Menu
+
:Which will bring up the following dialog window that has three distinct parts.
  
* Arrow key Camera Controls
+
[[File:VTT_Enhancement_Suite_Configuration.PNG|frameless|center|600px]]
  
* Disable Animations
+
1️⃣ In this part are the specific features, listed by category.
A Basic tool for ability stats generation (point buy, array, dice roll)
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">Canvas</div>
 +
<div class="mw-collapsible-content">
  
* Night Mode (deprecated)
+
:[[File:Checkbox.png|x20px]] [[Feature: Disable Player Drawing|Disable Player Drawing]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Adjustable GM Layer opacity|Adjustable GM Layer opacity]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Remember Text Tool Settings|Remember Text Tool Settings]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Animated Background|Animated Backgrounds]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Alternative Token Radial Menu|Alternative Token Radial Menu]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Arrow key Camera Controls|Arrow key Camera Controls]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Disable Animations|Disable Animations]]
 +
:[[File:Checkbox.png|x20px]] Night Mode (deprecated)
 +
:[[File:Checkbox.png|x20px]] [[Feature: Display Current Layer on Canvas|Display Current Layer on Canvas]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Mouse Click to Switch to Token Layer|Mouse Click to Switch to Token Layer]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Scale Token Names by Size|Scale Token Names by Size]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Draw Token Layer on Tokens|Draw Token Layer on Tokens]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Transparent Canvas UI|Transparent Canvas UI Dialog]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Hide Player List|Hide Player List]]
 +
</div>
 +
----
 +
<div style="font-weight:bold;line-height:1.6;">Token</div>
 +
<div class="mw-collapsible-content">
  
An automated version of the character background generator from [https://5e.tools/book.html#xge ''Xanathar's Guide to Everything''].
+
:[[File:Checkbox.png|x20px]] [[Feature: Token Status Display Adjustment|Token Status Display Adjustment]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Bulk Macros|Bulk Macros]]
 +
:[[File:Checkbox.png|x20px]] Reassign "Represents" when duplicating
 +
:[[File:Checkbox.png|x20px]] [[Feature: Character Token Editor|Character Token Editor]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Roll & Apply Hit Dice|Roll & Apply Hit Dice]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Token Resize|Token Resize]]
  
* Display Current Layer on Canvas
+
</div>
 +
----
 +
<div style="font-weight:bold;line-height:1.6;">Libre</div>
 +
<div class="mw-collapsible-content">
  
A collection of racial name tables found in [https://5e.tools/book.html#xge ''Xanathar's Guide to Everything''].
+
:[[File:Checkbox.png|x20px]] [[Feature: Libre Audio|Libre Audio]]
 +
:[[File:Checkbox.png|x20px]] [[Feature: Create Token From URL|Create Token From URL]]
  
* Mouse Click to Switch to Token Layer
 
* Scale Token Names by Size
 
*Transparent Canvas UI Dialog
 
* Hide Player List
 
 
</div>
 
</div>
 
----
 
----
Line 87: Line 121:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
* Open Turn Tracker on Initiative
+
:[[File:Checkbox.png|x20px]] [[Feature: Open Turn Tracker on Initiative|Open Turn Tracker on Initiative]]
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Ping Visible Token|Ping Visible Token]]
A fully-customizable Dungeon Master's screen, featuring an initiative tracker; a unit converter, embedded images, videos, and sites; and the majority of 5etools' content.
+
:[[File:Checkbox.png|x20px]] [[Feature: Select Token|Select Token]]
Adventures
+
:[[File:Checkbox.png|x20px]] [[Feature: Automatically Sort Initiative|Automatically Sort Initiative]]
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Advanced Initiative Shortcut|Advanced Initiative Shortcut]]
* Ping Visible Token  
+
:[[File:Checkbox.png|x20px]] [[Feature: Move Camera to Token|Move Camera to Token]]
 
 
* Select Token
 
 
 
Objects are the Siege weapons currently.
 
 
 
* Automatically Sort Initiative
 
 
 
* Advanced Initiative Shortcut
 
 
 
A verbose, in-depth Challenge Rating calculator, for determining the CR of homebrew creatures.
 
 
 
* Move Camera to Token
 
  
 
</div>
 
</div>
 
----
 
----
<div style="font-weight:bold;line-height:1.6;">Token</div>
+
<div style="font-weight:bold;line-height:1.6;">Exporting/Importing</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
* Bulk Macros
+
:[[File:Checkbox.png|x20px]] [[Feature: Character Importer/Exporter|Character Importer/Exporter]]
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Jukebox Importer/Exporter |Jukebox Importer/Exporter]]
* Reassign "Represents" when duplicating
+
:[[File:Checkbox.png|x20px]] [[Feature: Player Macro Importer/Exporter|Player Macro Importer/Exporter]]
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Table Importer/Exporter|Table Importer/Exporter]]
* Character Token Editor
 
 
 
* Roll & Apply Hit Dice
 
 
 
* Token Resize
 
  
 
</div>
 
</div>
 
----
 
----
<div style="font-weight:bold;line-height:1.6;">Exporting/Importing</div>
+
<div style="font-weight:bold;line-height:1.6;">Journal</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
* Character Importer/Exporter
+
:[[File:Checkbox.png|x20px]] "Duplicate" in the Journal Context Menu
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Character Sheet Ability Macro Generator|Character Sheet Ability Macro Generator]]
* Jukebox Importer/Exporter (Libre Audioa)
 
 
 
* Player Macro Importer/Exporter
 
 
 
* Table Importer/Exporter
 
  
 
</div>
 
</div>
 
----
 
----
<div style="font-weight:bold;line-height:1.6;">Journal</div>
+
<div style="font-weight:bold;line-height:1.6;">Misc.</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
* "Duplicate" in the Journal Context Menu
+
:[[File:Checkbox.png|x20px]] [[Feature: Set Rollable Table Avatar By URL|Set Rollable Table Avatar By URL]]
 
+
:[[File:Checkbox.png|x20px]] [[Feature: Performance Improvements|Performance Improvements]]
* Character Sheet Ability Macro Generator
 
  
 
</div>
 
</div>
Line 147: Line 158:
  
 
<br/>
 
<br/>
 +
:2️⃣ This is the pane in which the individual settings are presented.
  
 +
::Note: ''clicking upon the checkbox will NOT initiate the update int this panel, for that you need to click upon the feature name directly in panel 1️⃣''.
 +
 +
<br/>
 +
:3️⃣ The [[Change Log |'''Change Log''']] for VTTes/R20es and the About dialog box, which lists the current version and provides links to the [{{r20esCommunitylink}}|'''Discord Server'''], [https://github.com/SSStormy/roll20-enhancement-suite '''Github'''] and [https://ssstormy.github.io/roll20-enhancement-suite/contribute.html '''Coffee''']
 
-----
 
-----
 +
 +
<br/>
 +
'''A note''' Each Feature's wiki page will denote which items are DM only, Requires the DM & Players to Run, or are will run for the PC (even if the DM doesn't use the script).
 +
::{| border="0" cellspacing="1" cellpadding="3" class="article-table"
 +
|-
 +
! scope="col"|Icon
 +
! scope="col"|Meaning
 +
|-
 +
|[[File:Dm.png|center|frameless|x30px]]
 +
|GM only feature
 +
|-
 +
|[[File:CharactersGroup.png|center|frameless|x30px]]
 +
|Requires Players Run the Script to make use of this feature.
 +
|-
 +
|[[File:EitherDMnPC.png|center|frameless|x30px]]
 +
|Either DM or PC can use this feature.
 +
|-
 +
|[[File:BothDMnPC.png|center|frameless|x30px]]
 +
|Requires DM to run this feature to for Players to use/have access to it.
 +
|}
 +
 +
<br/>
 +
 +
===Video Guides===
 +
 +
 +
: https://www.youtube.com/watch?v=UMIyrOKP9Mg
 +
: https://www.youtube.com/watch?v=4x2yy_MjhlA
 +
: https://www.youtube.com/watch?v=Hx2GI6JPC0c
 +
: https://www.youtube.com/watch?v=ksyBgnCk0Y4  (French)
 +
: https://www.youtube.com/watch?v=ztci2hZtU20
 +
: https://www.youtube.com/watch?v=syMk0D9MFKc

Latest revision as of 22:39, 6 March 2021

R20esLOGO.png
VTTes/R20es v1.20.00

PLEASE NOTE: Roll20 Enhancement Suite (aka VTT es/ R20es), is not part of BetteR20 or 5eTools. However; as BetteR20 installation is enhanced/simplified by already having VTT es/R20es installed, this Wiki covers its content to (HOPEFULLY) prevent BetteR20 users from requesting help on BetteR20 issues on the VTTes/R20es Discord server or other platforms (Reddit/Roll20.net Forum, etc).


You may have been looking for help on the Roll20 Enhancement Suite (also known as VTTes or R20es) and if so, this will hopefully answer the common questions around such.

So, for that let's directly link to where you likely want to go...

💾Installation Guide
🔧Troubleshooting Guide
📋 Features Guide
🔖 Website
☕ Support development



What it's not

The first thing you should know is that's not 5eTools, and not BetteR20. It's an extension made by Justas "Stormy" Dabrila. It is a way to enhance Roll20 with a number of usability and UI elements that expand, and even simplify running Roll20. His work stands alone, and so these pages reflect users understanding of his work.
Errors made here in the wiki are reflective only of the wiki's author(s), and not of the work Stormy has done.


What it is

The VTT Enhancement Suite (aka VTT es and R20es) is according to its creator An unofficial quality of life and workflow extension for Roll20.


In reality its a work of passion and no small amount of effort and genius made by a single person, Stormy (Justas Dabrila). R20es is an extension written in javascript and is an open-source project under GPL-3.0.


It is an extension for the browser, which is to say - it's a program that runs only in the browser and only when you access Roll20.net. It does not monitor or share your information nor does it hack the Roll20 website, what it does do it modify the data the website provides to browser so that things work a bit different.


R20es is, in short, safe. Better yet, it makes Roll20 better.


What this page is

How do I get it?

First... can you run it?
See here


Then, it will depend upon what browser you are using.
  • For Chrome, you go here
*For Firefox, you go here
For Opera ... realize you'll get NO support for BetteR20 if you are attempting to use it, but ... its covered in the install guide.
for a more detailed guide - see the 💾 VTTes installation guide.

How do you use it?

Mostly, it's going to be about how you play.
There are LOTS of features in VTTes/R20es, and you'll need to understand what you can do before anyone can tell you how to do what you may want to do with it...


but chances are, you want to play with animated backgrounds, or playlists/tracks.
or are looking some help with how to get things to work.


Video Guides for installation/overview of features
Corey Longnecker's Castle Class Presents: Roll20 - Class 2 - VTT Enhancement Suite for Roll20
Eran Arbel's Roll20 Master Series
en français
em português

VTTes Configuration

In Roll20, click the sidetoolbar's R20Settings.PNG setting, and if VTTes/R20es is loaded properly (see Installation Guide) you will see the buttons for VTTes Tools and VTTes Config.
Which will bring up the following dialog window that has three distinct parts.
VTT Enhancement Suite Configuration.PNG

1️⃣ In this part are the specific features, listed by category.


2️⃣ This is the pane in which the individual settings are presented.
Note: clicking upon the checkbox will NOT initiate the update int this panel, for that you need to click upon the feature name directly in panel 1️⃣.


3️⃣ The Change Log for VTTes/R20es and the About dialog box, which lists the current version and provides links to the Discord Server, Github and Coffee


A note Each Feature's wiki page will denote which items are DM only, Requires the DM & Players to Run, or are will run for the PC (even if the DM doesn't use the script).

Icon Meaning
Dm.png
GM only feature
CharactersGroup.png
Requires Players Run the Script to make use of this feature.
EitherDMnPC.png
Either DM or PC can use this feature.
BothDMnPC.png
Requires DM to run this feature to for Players to use/have access to it.


Video Guides

https://www.youtube.com/watch?v=UMIyrOKP9Mg
https://www.youtube.com/watch?v=4x2yy_MjhlA
https://www.youtube.com/watch?v=Hx2GI6JPC0c
https://www.youtube.com/watch?v=ksyBgnCk0Y4 (French)
https://www.youtube.com/watch?v=ztci2hZtU20
https://www.youtube.com/watch?v=syMk0D9MFKc