Troubleshooting: BetteRoll20

From 5etools Community Wiki
Revision as of 03:07, 24 July 2020 by Modnar (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision β†’ (diff)
Jump to: navigation, search

framless
v1.19.7

FOLLOW THESE INSTRUCTIONS CAREFULLY AND EXACTLY


Isolation Troubleshooting

Identify and isolate the problem so it's reproducible.

Determine if its a Roll20 Specific Issue, A R20ES/VTT ES issue or a BetteR20 Issue

πŸ‘‰ Make sure you are using the current browser version.
πŸ‘‰ Make sure you are using the most current extension versions (R20es/VTT es & Tampermonkey) and have the most current version of the BetteR20 Script (if you are using it)
πŸ‘‰ Check the FAQ and Known Limitations
πŸ‘‰ Don't keep entering into the same game. Make sure your efforts to see what is happening include attempting the same in other games (even if you have to create a game to test.) and try it as both GM and Player.
πŸ‘‰ Don't fail to try Firefox and Chrome in your identification steps -
ie if its happening in your favorite browser try seeing what happens in the one that isn't your favorite.
πŸ‘‰ Try Uninstalling and reinstalling the VTT ES (R20ES) extension, Tampermonkey and the script.



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


Ok, if you're here you've already installed or you are getting an error when you attempt to update the script you're getting an error or are being prompted to download a file (see image)

Better20Updateerror.png

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

Go into Chrome -> More Tools -> Extensions, then in the Tampermonkey section -> Details and under Site Access, click "On All Sites".
No instructions for FireFox on this step - proceed to step 1.


1️⃣ Confirm you have the latest version of (non beta) tampermonkey and are not using a different script manager (Greasemonkey; stylish or the like)

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

3️⃣ Please Confirm ..

You have VTTes installed and its enabled (if not, please install R20es.
You are either using only one instance of the Better20 script at a time. (deleting others version you are not using), OR have NO Script installed.
You have assigned a character sheet template in the Roll20 game's Settings (on Roll20's website) under Settings -> Game Settings -> under Character Sheet Template, if you do not, you'll get an error in the console (and likely the Chat) saying Character Sheet is not defined.

4️⃣ Go to https://get.5e.tools or (if wanting to use BetteR20 5eTools (for use with DnD 5e)) https://5e.Tools (see picture) and follow this | link

Where to download.gif


or go to the community discord and type !b20 into the #BetteR20 Issues channel and follow the guidance that results
did either of those work? (ie 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

THIS IS THE STEP THAT MOST OFTEN RESOLVES THE ISSUE, READ IT COMPLETELY and CAREFULLY BEFORE ACTING UPON IT

7️⃣ copy this

https://get.5e.tools/script/betteR20-5etools.user.js?v=
paste it to the address bar in your browser, AND' add to that something random -ie an alphanumerical keyboard mash (example: `232qv5q3asdhiou9ajl34aadgaeae43avasdfasfak` or `Mrt00tsbutt5`) at the end of that address (after the ?v=) to cache bust the ISP/CDN's stored information. It should be long enough to think your mash is unique from the several thousand possible users before you (7 or more characters at least).
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


Confirm you not done the following


BetteR20 Loading.png

DO NOT...

Do not disable the VTTes extension, or do not fail to install the R20ES (VTT Enhancement Suite), (see installation notes above) before attempting to Load Roll20.
If you do not do this, Roll20 will hang upon loading you MUST have the extension Installed and enabled,
if you do not have it installed you will hang on loading (see picture to the right), or get the error pictured below.
R20es NotLoaded.png



BetteR20 DUAL install.png

DO NOT...

Do not have both BetteR20 Core & BetteR20 5eTools enabled at the same time. If you do... you'll hang on load and get an error.










R20 failedloadBetteR20.png
R20Console NoCharacterSheet.png


DO NOT...

Do not fail to assign a character template in the game's Settings (on Roll20's website) under Settings -> Game Settings -> under Character Sheet Template, if you do not, you'll get an error in the console (and likely the Chat) saying Character Sheet is not defined.











Roll20 no API.png

DO NOT...

DO NOT take put the RAW text of the script's code into Roll20's API Scripts as an "untitled.js."
(if that means nothing to you, don't worry. Its only possible to make this mistake if you have a Roll20 Pro level subscription.. and the tampermonkey script is not a Roll20 API Script)

IF none of that applies, and is not answered in the FAQ and Known Limitations

1️⃣ CTLR + F5 - force refresh of site/code

2️⃣ Restart Browser.

3️⃣ Disable other extensions - Disable all other extensions or scripts beyond R20ES/VTT ES & Tampermonkey which should be only running one instance of the script as active.

Then attempt to reproduce, cause the error to occur again.
If you cannot, its something outside of the script - add things back one at time until the error presents and then report that to discord community (link under Support>Community)

4️⃣ Disable Tampermonkey - to that and do a ctrl + F5. If the problem or setting(s) you are attempting to work with are still present, the issue resides outside of Better20.

5️⃣ Disable R20ES / VTT ES - attempt to use Roll20 without it. (It may be that Roll20 has something going on with it independently.

If the problem persists, its a Roll20 issue.
If it does not, it a R20ES / VTT ES issue and should be reported to that discord's 'Issue' (see below)

6️⃣ Reporting - Once you've determined that there is a problem, how to reproduce it, and what system is causing it. Report it. To the correct location.

if it happens only with Tampermonkey and BetteR20 script enabled - go to 5eTool's Discord channel for BetteR20 Roll20
if it happens only with R20ES / VTT ES enabled go to their Discord channel for issues-and-support.
if it happens in Roll20 without anything else loaded, check the forums for it being reported. check with 5eTool's Roll20 channel and see if there is a workaround already.

In both cases provide the following:

Copy and fill out the segment below and paste it to the relevant group.

ISSUE: a brief summary of the issue
STEPS: what you need to do to generate it
BROWSER: what browser and version you are using
EXTENSION(s): what extensions are you running when the error presents.
CONSOLE: copy of what the console or error message(s) show

πŸ–₯️ You may not know how to get console error messages. To find and retrieve them, hit f12 or Ctrl+Shift+J and then make sure console is selected. the messages that are in Red are the ones being sought. Screen shot those.

Specify EVERYTHING,

declaring you have the "current version" doesn't mean you are using the current version, knowing what the current version is by stating it, does indicate that you've checked and confirmed such.

Use to https://www.whatismybrowser.com/ check if what you're using really is. *(and.. The ESR isn't the latest release, and it's often not the supported release)

Once you done that make sure you mention you were supposed to mention "legend...ary" so we know you are one of ones that can read and did what you could so its not necessary to assume you're not willing to listen/read/do what is asked.


A NOTE: saying "I did that", doesn't mean you did - often (to be honest) it means, "yeah, yeah, I'm sure its not whatever basic things you're saying to do, I'm already sure my problem is specific/unique" - and often, they are not, and the basic troubleshooting processes resolve them. Please state specifically what you did. Typing that out is a pain - for both sides of support - but, when reporting an issue means the person(s) supporting you can get to the heart of the matter versus and may help you faster since they don't have to explain they need information you've choosen to not provide and walking you thru - painfully slowly - the stuff you've already done and getting confirmation screenshots and lengthy explanations from you - honestly, at times to incentivize doing that instead next time.