Difference between revisions of "R20es Install Guide"

From 5etools Community Wiki
Jump to: navigation, search
m
m (Supported Platforms)
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
You must use the ''current'' (non-ESR) version of one of the following browsers. If you are, click on the browser you're using
 
You must use the ''current'' (non-ESR) version of one of the following browsers. If you are, click on the browser you're using
  
:* [https://chrome.google.com/webstore/detail/vtt-enhancement-suite/fadcomaehamhdhekodcpiglabcjkepff?hl=en-GB '''Google's Chrome'''] <br/>
+
* [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 style="font-weight:bold;line-height:1.6;">[https://www.google.com/chrome/ Chrome]</div>
 +
<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.
 +
:: The original takedown statement can be read [https://ssstormy.github.io/roll20-enhancement-suite/takedown.png '''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
 +
:# Download the extension [https://github.com/SSStormy/roll20-enhancement-suite/raw/gh-pages/r20es_1.15.15_chrome.zip '''here''']
 +
:# Extract the zip file somewhere permanent.
 +
:# Copy & Paste <code>chrome://extensions</code> into the URL bar and press enter.
 +
:# Enable "Developer Mode" in the top right.
 +
:# Click "Load unpacked" in the top left.
 +
:# 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.''
 +
 
 +
::: 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)
 +
 
 +
</div></div>
 +
 
 
<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.opera.com/download Opera]</div>
 
<div style="font-weight:bold;line-height:1.6;">[https://www.opera.com/download Opera]</div>

Revision as of 17:10, 9 October 2019

R20esLOGO.png

VTTes/R20es v1.15.26

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

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

Or click here for Basic Troubshooting

If you are using BetteR20, you're using Roll20, VTTes/R20es, Tampermonkey and BetteR20, and sometimes things will occur that create problems in your gaming experience that you'll want to troubleshoot and report to the devs to get fixed.


Part of using 5eTools and by extension BetteR20; is the understanding that you're not going to be reporting on public posts, that you're having an issue, or to other discord servers.


BASIC TESTING PROCESS


1️⃣ Check to see if you are using a supported browser
MINIMUM REQUIRED BROWSERS:
Chrome : 78+
Firefox : 71+
LATEST VERSION BROWSERS:
Chrome : 80.0.3987.149
Firefox : 74.0.0



KNOWN PROBLEMS WITH BROWSER VERSIONS:
Chrome:
Update branch 73 is bugged, please update.
Firefox:
WaterFox is not supported. It runs on a dated branch of Firefox build
ESR release is also, NOT supported, it runs on version 60, which is lower than the minimum required version for Firefox. Consider switching to the default branch of Firefox.


if you are not, update your browser and then close and restart.

2️⃣ Then confirm you are using the current supported product version

5eTools v1.105.0
Plutoniumv1.1.0 | Rivet v1.2.0
BetteR20 v1.17.00 | R20ES v1.15.26
5eCrawler v1.5.3
Homebrew v1.1.0

if you are not, update your browser and then close and restart it.

3️⃣ Refresh the page by doing a ctrl + F5. Yes. It's simple, easy and resolves most of the issues.

4️⃣ Use both Chrome and Firefox (and their private/incognito modes) to see if the problem is unique to a single browser's settings.

5️⃣ If the problem exists between browsers, then it's likely, not just a local issue. Make sure you don't keep entering into the same game. Make sure your efforts to see what is happening include attempting to generate the error other games (even if you have to create a game to test.)


6️⃣ If the issue appears in only one browser, or even only on one computer (if you have more than one computer to test upon). You'll want to do the following.
👉 AGRESSIVELY Empty Cache:
WARNING: THIS WILL DELETE YOUR PASSWORD AND USERNAME FROM THE BROWSER,
BUT NOT THE ROLL20 SITE, IF YOU'VE LET THE BROWSER REMEMBER YOUR USERNAME/PASSWORD.
For Chrome

In Chrome (desktop)

On your computer, open Chrome.
At the top right, click More.
Click More tools Clear browsing data.
At the top, choose a time range. (To delete everything, select All time.)
Next to "Cookies and other site data" and "Cached images and files," check the boxes.
Click Clear data.


In the Chrome app (mobile - not supported)

On your Android phone or tablet, open the Chrome app .
At the top right, tap More .
Tap History Clear browsing data.
At the top, choose a time range. To delete everything, select All time.
Next to "Cookies and site data" and "Cached images and files," check the boxes.
Tap Clear data.


WARNING: Deleting cookies & cache will remove site specific data (homebrew; settings etc)


How to Clear LocalStorage in Google's Chrome Browswer

1️⃣ Open the Chrome browser and navigate to SiteData chrome://settings/siteData

2️⃣ Search for 5e.tools (or noads.5e.tools)

3️⃣ Select the site, and then click the delete Delete icon to empty Local Storage for the site.


ALTERNATIVELY


1️⃣ Open the Chrome browser and navigate to the 5eTools website

2️⃣ Press the F12

3️⃣ Select the Application item on the console's top menu

4️⃣ Select the Local Storage ; the 5eTools domain item under its left menu.

Chrome Local Store

5️⃣ Select the Local Storage entries with your mouse and delete them, select and press DELETE key.

For Firefox

In Firefox (desktop)

Click the Site Info Site Info Infobutton.png button at the left of the address bar while on the site.
Firefoxcache.png
Click Clear Cookies and Site Data.


FirefoxCacheSitelist.png
Select the site information (such as 5eTools.com or 5e.Tools)


Then click Remove FirefoxRemove.png
WARNING: Deleting cookies & cache will remove site specific data (homebrew; settings etc)


Delete site storage for individual website

  • Click the menu button menu button and select Options
  • In the Cookies and Site Data section, click Manage Data…. You'll see a list of sites and how much information each site is storing on your computer.
  • Click the site you want to remove and click Remove Selected (or click Remove All to remove all stored cookies and site data).
  • Click Save Changes to finish.

(For more information about clearing cookies for individual (or all) websites, see Clear cookies and site data in Firefox.)


In Chrome (desktop)
On your computer, open Chrome.
At the top right, click More.
Click More tools Clear browsing data.
At the top, choose a time range. (To delete everything, select All time.)
Next to "Cookies and other site data" and "Cached images and files," check the boxes.
Click Clear data.


In the Chrome app (mobile - not supported)

On your Android phone or tablet, open the Chrome app .
At the top right, tap More .
Tap History Clear browsing data.
At the top, choose a time range. To delete everything, select All time.
Next to "Cookies and site data" and "Cached images and files," check the boxes.
Tap Clear data.


WARNING: Deleting cookies & cache will remove site specific data (homebrew; settings etc)


How to Clear LocalStorage in Google's Chrome Browswer

1️⃣ Open the Chrome browser and navigate to SiteData chrome://settings/siteData

2️⃣ Search for 5e.tools (or noads.5e.tools)

3️⃣ Select the site, and then click the delete Delete icon to empty Local Storage for the site.


ALTERNATIVELY


1️⃣ Open the Chrome browser and navigate to the 5eTools website

2️⃣ Press the F12

3️⃣ Select the Application item on the console's top menu

4️⃣ Select the Local Storage ; the 5eTools domain item under its left menu.

Chrome Local Store

5️⃣ Select the Local Storage entries with your mouse and delete them, select and press DELETE key. Template:EmptyCacheChrome

In Chrome
Go to Settings
In Advanced
Site Settings
View permissions and data stored across sites
Locate Roll20
Click Clear Data
LocalStorage for Firefox

Uninstall script/extension

Template:ReinstallExtensions Reinstall Extensions
Template:ReinstallBrowser Reinstall Browser

caching issues chrome go to settings find a site settings option go to Storage go to 5etools.com delete everything

firefox in the clear private data menu for deleting offline website data


Isolate Cause


7️⃣

8️⃣

9️⃣



Then confirm you are using the current supported product version
Template:IdentifyR20Product


How to update the code

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

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


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




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