Difference between revisions of "R20es Install Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (Supported Platforms)
m
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__INDEX__
 
__INDEX__
[[File:R20esLOGO.png|right|frameless|200px]]
+
{{R20esHeader}}
<p style="text-align:right;">'''VTTes/R20es''' {{R20esversion}}</p>
+
 
 +
[https://www.youtube.com/watch?v=Rcw8L6Vkocg A video walkthrough]
 +
<br>
  
 
=== Supported Platforms ===
 
=== Supported Platforms ===
Line 8: Line 10:
 
* [https://addons.mozilla.org/en-US/firefox/addon/roll20-enhancement-suite/ '''Firefox''']
 
* [https://addons.mozilla.org/en-US/firefox/addon/roll20-enhancement-suite/ '''Firefox''']
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">[https://www.google.com/chrome/ Chrome]</div>
+
<div style="font-weight:bold;line-height:1.6;">[https://ssstormy.github.io/roll20-enhancement-suite/chrome Chrome]</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
::'''NOTICE''': As of 2019-09-30, the extension has been taken down from the Chrome Web Store in fear of copyright violation.  
 
::'''NOTICE''': As of 2019-09-30, the extension has been taken down from the Chrome Web Store in fear of copyright violation.  
Line 16: Line 18:
  
 
:'''How to Install  
 
:'''How to Install  
:# Download the extension [https://github.com/SSStormy/roll20-enhancement-suite/raw/gh-pages/r20es_1.15.15_chrome.zip '''here''']
+
:# Download the extension [https://ssstormy.github.io/roll20-enhancement-suite/chrome here]
 
:# Extract the zip file somewhere permanent.
 
:# Extract the zip file somewhere permanent.
 
:# Copy & Paste <code>chrome://extensions</code> into the URL bar and press enter.
 
:# Copy & Paste <code>chrome://extensions</code> into the URL bar and press enter.
Line 23: Line 25:
 
:# Select the extracted extension folder and click the "Open"/"Select" button
 
:# Select the extracted extension folder and click the "Open"/"Select" button
 
:# ''Make sure to not delete the extension folder as that will remove the extension.''
 
:# ''Make sure to not delete the extension folder as that will remove the extension.''
 +
 +
Source [https://ssstormy.github.io/roll20-enhancement-suite/chrome Stormy's Site Notes]
  
 
::: This process disables the auto-update feature; and so it is advised you join the Discord Server for VTTes for notifications on new releases. (which will require you to revisit these steps to install the updated extension)
 
::: This process disables the auto-update feature; and so it is advised you join the Discord Server for VTTes for notifications on new releases. (which will require you to revisit these steps to install the updated extension)
 +
::: IF you modify/remove/relocate the directory or its contents inside the unpacked directory you will disable the extension. Please don't do that.
  
 
</div></div>
 
</div></div>
Line 50: Line 55:
  
 
<br/>
 
<br/>
If you do not, you'll want to visit the [[Troubleshooting:_R20es|'''Troubleshooting Guide for R20es''']].
+
If you do not, you'll want to visit the [[Troubleshooting:_R20es|'''Troubleshooting Guide for VTT ES (R20es)''']].
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div style="font-weight:bold;line-height:1.6;">Or click here for Basic Troubshooting</div>
 
<div class="mw-collapsible-content">
 
 
 
{{IdentifyR20Product}} [[Template:IdentifyR20Product]]
 
 
 
</div>
 
</div></div></div>
 
  
 
<br/>
 
<br/>
  
==== How to update the code ====
+
== How to update the code ==
The extension will update itself as Stormy updates the code automatically.
+
The extension will update itself as Stormy updates the code automatically for Firefox.
  
 
You'll receive a notification pop up (like this).
 
You'll receive a notification pop up (like this).
Line 70: Line 67:
  
 
<br/>
 
<br/>
 +
For '''Chrome''' you are advised to Join the VTTes Discord server to be made aware of updates; and to update you will need to follow the [[R20es Install Guide|installation instructions above]], and be sure to remove (or at least disable) the prior version of the extension.
  
 
==== How to Uninstall the Extension ====
 
==== How to Uninstall the Extension ====
Line 91: Line 89:
 
# Confirm by clicking Remove.
 
# Confirm by clicking Remove.
  
 +
 +
==== How to Roll Back====
 +
in process
 +
 +
link https://github.com/SSStormy/roll20-enhancement-suite/raw/gh-pages/r20es_1.15.15_chrome.zip '''here'''
 
</div></div>
 
</div></div>
  
Line 102: Line 105:
 
: Close browser then reopen and proceed with the installation process outlined above.
 
: Close browser then reopen and proceed with the installation process outlined above.
 
</div></div>
 
</div></div>
 
 
<br/>
 
<br/>
 +
:: Clear your browser cache
 +
:: Close completely your browser and reopen it
 +
:: Done
  
 
<br/><br/>
 
<br/><br/>
  
 
{{SupportR20esDisclaimer}}
 
{{SupportR20esDisclaimer}}

Latest revision as of 22:35, 6 March 2021

R20esLOGO.png
VTTes/R20es v1.20.00

A video walkthrough

Supported Platforms

You must use the current (non-ESR) version of one of the following browsers. If you are, click on the browser you're using

NOTICE: As of 2019-09-30, the extension has been taken down from the Chrome Web Store in fear of copyright violation.
The original takedown statement can be read here
Installing the extension is still possible but convoluted.
If this is daunting; We recommend using Firefox to avoid the extra steps.
How to Install
  1. Download the extension here
  2. Extract the zip file somewhere permanent.
  3. Copy & Paste chrome://extensions into the URL bar and press enter.
  4. Enable "Developer Mode" in the top right.
  5. Click "Load unpacked" in the top left.
  6. Select the extracted extension folder and click the "Open"/"Select" button
  7. Make sure to not delete the extension folder as that will remove the extension.

Source Stormy's Site Notes

This process disables the auto-update feature; and so it is advised you join the Discord Server for VTTes for notifications on new releases. (which will require you to revisit these steps to install the updated extension)
IF you modify/remove/relocate the directory or its contents inside the unpacked directory you will disable the extension. Please don't do that.

NOTE: this not supported on 5eTools/BetteR20.

Click Here

Then go get the Chrome compatibility extension, restart the browser.

then get the VTTes/R20es Extension for Chrome and Opera.


Visit the Roll20 Website.

If this is the first time you've installed the extension a popup notification will appear to begin familiarizing you with the extension and its features.

Otherwise, you'll see a notification in the chat dialog box like what is pictured on the below.

R20esConfirmation.PNG

If you see that then the extension has loaded correctly.


If you do not, you'll want to visit the Troubleshooting Guide for VTT ES (R20es).


How to update the code

The extension will update itself as Stormy updates the code automatically for Firefox.

You'll receive a notification pop up (like this).
R20esUpdateNotification.png


For Chrome you are advised to Join the VTTes Discord server to be made aware of updates; and to update you will need to follow the installation instructions above, and be sure to remove (or at least disable) the prior version of the extension.

How to Uninstall the Extension

From time to time want to uninstall and reinstall the extension for troubleshooting problems with errors in Roll20 that occur.

In Chrome.

Uninstall an extension

ChromeExtension.PNG
To the right of your address bar, look for the extension's icon.
Right-click the icon and select Remove from Chrome.


If you don't see the extension's icon:

  1. Open Chrome.
  2. At the top right, click More ChromeSettings.png More Tools > and then Extensions.
  3. Next to the extension you want to remove, click Remove.
  4. Confirm by clicking Remove.


How to Roll Back

in process

link https://github.com/SSStormy/roll20-enhancement-suite/raw/gh-pages/r20es_1.15.15_chrome.zip here

In Firefox.
Hit Ctrl + Shift + A or click on the hamburger click Add-ons
Find the VTT Enhancement Suite (below)

FirefoxExtensions.png

Choose "Remove"
Close browser then reopen and proceed with the installation process outlined above.


Clear your browser cache
Close completely your browser and reopen it
Done



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).