Difference between revisions of "BetteRoll20 Install"

From 5etools Community Wiki
Jump to: navigation, search
m (***SEE ABOVE FIRST*** Trouble Shooting a Failed/Not working Installation of the script)
Line 129: Line 129:
[[Troubleshooting: BetteRoll20 | ***SEE ABOVE FIRST*** Troubleshooting ]]
<br /><br />
: Follow [[Troubleshooting: BetteRoll20 | '''this link''' ]]
Now you may wish to familiarize yourself with:
Now you may wish to familiarize yourself with:
[[Troubleshooting: BetteRoll20 | Troubleshooting ]] (***REVIEW ABOVE FIRST***)
[[Roll20 Features|Better20 Script's Features]]
[[Roll20 Features|Better20 Script's Features]]

Revision as of 01:13, 28 October 2019


Overview: The BetteR20 script works to modify the local session of Roll20's platform. While some of the script's abilities will seem to change Roll20, it more works as an interpreter changing what you see or it works behind the scenes taking actions as if you yourself had taken various steps. 

Getting Started/Checking your system

Are you on a Mobile, or a PC.

If on a PC

1️⃣ You must have either Chrome or Firefox as the browser.
You cannot use Waterfox, or Chrome for Opera, Internet Explorer, etc.
2️⃣ The Install must be the most current version of either.
3️⃣ Install TamperMonkey  (for Chrome / Firefox ) on your browser
4️⃣ Confirm it is installed (you may need to close all session of the browser and restart the browser)
5️⃣ Install R20ES
6️⃣ The Script(s)
BetteR20 comes in two "flavors", Better20 core and Better20 5eTools which you get by going to Get.5e.Tools
  • Choose which of the scripts you'll be using
  • Core (General UI features - not specific to 5e games)
  • 5eTools (Which already includes core + a set of 5eTools specific features)
  • If you install both - ensure only one BetteR20 script is enabled. (You may install both. It's not suggested, and you may only have one active).
  • Click on either BetteR20 Core or BetteR20 5eTools at the Get.5e.Tools  site.(versions will likely be different on the live site)

If things are set up correctly, you should get a screen like this:
(for new installs)
(for attempting to update via file link after installation the script, unless modified, or prevented by the user, should automatically update)
Forced Update

In the tampermonkey dashboard you should see a listing for the for the script you've chosen with the enabled toggle next to as green (ie enabled)
  • Head over to Roll20 and test if its working properly. If it is you'll see a message like this in the chat window.
Example notification
NOTE: The Versions of TamperMonkey and the script may have udpated since the photo was taken, both tampermonkey and BetteR20 will automatically update as new versions become available.

Now is a great time to...Give Thanks.
IF your script is not working.....

What to do if your script will not update/install.

(All of the following assume that you've not modified the default Tampermonkey settings. To Make sure when you click on a link it works (in Chrome)

Go into Chrome -> More Tools -> Extensions, then in the Tampermonkey section -> Details and under Site Access, click "On All Sites".

1️⃣ Confirm you have the latest version of (non beta) tampermonkey

2️⃣ Confirm you have the lastest of either FF or Chrome browsers (all other browsers, waterfox, opera, etc etc are not supported)

3️⃣ Confirm you are using only one instance of the Better20 script at a time. (delete others you are not using)

4️⃣ Go to https://get.5e.tools

does that work? (can you install the script? (see installation notes above)
if so. go no further, if not...

5️⃣Go to https://get.5e.Tools

does that work? (can you install the script? (see installation notes above)
if so. go no further, if not...

6️⃣ CTRL + F5

7️⃣ copy this https://get.5e.tools/script/betteR20-5etools.user.js?v=

paste it to the address bar in your browser, type something random -ie keyboard mash (example: `232qv5q3asdhiou9ajlk` or `mrtootsbutts`) at the end of that address
does that work? (can you install the script? (see notes above)
if so. go no further, if not...

8️⃣ Delete the script from tampermonkey's dashboard and try again from step 1 (ignoring this step on the second pass)

does that work? (can you install the script? (see notes above)
if so. go no further, if not try manually updating the script

Manually Updating the Script

This can be a bit technical for the unfamiliar. For this you will need a simple text editor. A simple text editor (such as Windows Notepad) will not offer to format text (no bold, italics, Colors, or even fonts).

🛆 If prompted to download the .js script, note the file name (often betteR20-<either core/5etools>-user.js, and then open it in a simple text editor

🛆 If the browser just shows the code.

Check to make sure Tampermonkey is installed, enabled and current.
If Chrome, make sure that in Chrome
> More Tools
> Extensions, then under
> Tampermonkey
> find the Details and under Site Access,
> click "On All Sites"
Copy the code presented to the browser into a simple text editor.

▶️Open Tampermonkey's Dashboard

right click tampermonkey,
choose dashboard

▶️Click the plus sign tab which will open the <New Userscript> Editor.

▶️Delete the prepopulated script code in the editor.

click in the text field and ctrl+A then delete, or
click at the beginning or end of the pre-populated text and hold down Del or Backspace until the text is erased.

Paste the code into tampermonkey's editor.

Click on and change <New Userscript> to betteR20- and then either core if using core, or 5etools if using the full tools.

Under File, -> Save

Now you may wish to familiarize yourself with:

Troubleshooting (***REVIEW ABOVE FIRST***)

Better20 Script's Features

VTT es Extension's Features

Roll20 (only better) FAQ