Difference between revisions of "Troubleshooting: 5eTools"

From 5etools Community Wiki
Jump to: navigation, search
m
Line 59: Line 59:
  
 
8️⃣ '''Check the Console Error Log'''
 
8️⃣ '''Check the Console Error Log'''
−
:: This is usually entered by hitting [[File:Ctrl-key.png|framless|x22px|Control]] + [[File:Shift key.png|framless|x22px|Shift]] + '''J''', consoles logs will look something like this;  
+
:: This is usually entered by hitting [[File:Ctrl-key.png|framless|x22px|Control]] + [[File:Shift key.png|framless|x22px|Shift]] + '''J''' or F12, consoles logs will look something like this;  
  
 
[[File:Errors in Console.png|framless|center|x450px|Console Errors]]
 
[[File:Errors in Console.png|framless|center|x450px|Console Errors]]

Revision as of 15:48, 28 March 2020

framless
v1.122.3


Troubleshooting the Website

(after each step attempt to reproduce your error)

1️⃣ Check 5eTools FAQ to see if your issue is listed.

2️⃣ Check your environment

Then you should confirm you are using either
Supported Browsers
MINIMUM REQUIRED BROWSERS:
Chrome : 87+
Firefox : 84+
LATEST VERSION BROWSERS:
Chrome : 88.0.4324.104
Firefox : 85.0.0


KNOWN PROBLEMS WITH BROWSER VERSIONS:
Chrome:
Brave; Avast; Edge are all offshoots of the base build for Chromium - they may work, but ... if you have issues, you will need to check against a current release of the main browser. If the issue does not persist on the current release of official Chrome... then you have found why they are not officially supported.
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 using a supported browser and version check the 5eTools' Homepage, at the bottom there is a version number. It should not be LESS than v1.122.3.


3️⃣ Clear Cache (Control + F5); Continue doing this until the homepage number is v1.122.3 or higher

4️⃣ Attempt using the site in the browser's Private/Incognito mode.

5️⃣ Check your Extensions (Turning off all your extensions)

We're looking for possible issues with browser extensions modifying or blocking site content

6️⃣ See if your issue presents in the other URL:

If you are using http://5e.Tools ; please use http://noads.5e.Tools
If you are using http://noads.5e.Tools ; please use http://5e.Tools
These sites don't use the same cache/locale store. If it doesn't show up; it suggests that your local data may need to be flushed.


THE FOLLOWING STEPS ARE POTENTIALLY DISTRUPTIVE TO CUSTOMIZED CONTENT please take the time to backup site data if you have custom settings for any of the following:

Blacklist
Homebrew Builder
DM Screen
How to Back up Site Content

How to Backup your 5eTools site Content


Site State:

Under Utilities; Choose to Save State to File
(A site save state includes the configuration settings. It will be saved as 5eTools.json to your local drive.)


DM Screen

Under Dungeon Master choose the DM Screen option
Move the mouse to left top of the screen, to expose the Menu Menu
Choose either Save to File Save to file or Save to URL button and save the file.
If you save to file it will be saved as dm-screen.json to your local drive.
If you save to URL it will be copied to your clipboard (you'll want to paste it into a text/email/note for you to reference later.)
framless


Homebrew Builder

Under Utilities choose the Homebrew Builder option
Move the mouse to left top of the screen, to expose the Menu Menu
Check Mode -> Spells
If there are names listed at the bottom (see below); Click the Download Spells as JSON button and save the file.
If the button is not there; or no files are listed you do not have a custom homebrew loaded, proceed to the next step
HomebrewBuilderSpell.png


Under Utilities choose the Homebrew Builder option
Move the mouse to left top of the screen, to expose the Menu Menu
Check Mode -> Monsters
If there are names listed at the bottom (see below); Click the Download Creature as JSON
If the button is not there; or no files are listed you do not have a custom homebrew loaded, proceed to the next step
HomebrewBuilderMonster.png


You have now backuped up your configuration Fully.



7️⃣ Flush Site Cache/LocalStore

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


check to see if the issue continues to present itself. If it continues to...


8️⃣ Check the Console Error Log

This is usually entered by hitting Control + Shift + J or F12, consoles logs will look something like this;
Console Errors
What is being sought is the message(s) that are in Red. Get a screenshot of that.

9️⃣ Then copy and fill out the following; Report the error on 5eTools community Discord in the #5eTools Issues channel. 

**Support Request**
<Statement_of_the_issue(s)>
**Browser (version)**:
**Extensions (Version)**:
**Reproduction Steps**: <List_all_steps_to_generate_the_issue>
----
Copy of console log attached

EXAMPLE

**Support Request**
The Bestiary is not showing any of the content, It appears to hang during loading the page
**Browser (version)**: Chrome (101.2.6987.132 (Official Build) (64-bit)
**Extensions (Version)**: Tampermonkey (5.9); VTTes 1.25.4; Ublock (2.25.2)
**Reproduction Steps**: 
Enter the site (http://5e.tools/))
Go to the Bestiary (http://5e.tools/bestiary.html#)
Site Loads successfully
Choose Manage Homebrew;
Inside Manage Homebrew choose Get Homebrew
Select VerySuspictious; CorruptMonster
Close Manage Homebrew;
Refresh Page
Site locks and errors out.
(Does not reproduce without the VerySuspicious file loaded)
----
Remember to attach the console log
Retrieved from "https://wiki.5e.tools/index.php?title=Troubleshooting:_5eTools&oldid=5561"