Reporting Bugs & Debugging for Wayward

The following is a guide on how to report and debug issues with Wayward.

Reporting that Wayward is not opening or does not function when launching

1. It's likely you are running on an unsupported operating system or your hardware is not compatible. To find out where the issue is, you can follow the steps within "Opening and sharing the Wayward log file" in this guide, or for advanced users, you can try alternate configuration/launch options as presented in "Opening and editing the launch_options.json", also in this guide.

2. Post a new thread in the forums with the information you have collected in the "Bug Reports" forum so that we may assist you: https://steamcommunity.com/app/379210/discussions/1/

Please provide the Wayward version you are running and your operating system (and any relevant hardware details).

To see the minimum/recommended system requirements for Wayward, please visit the Steam store page for Wayward and scroll down to the "SYSTEM REQUIREMENTS" section.

3. Another thing to try is verifying your game files to make sure everything was downloaded correctly. This is rarely the issue, but it has happened. Please view the instructions under "Verifying integrity of game cache".

4. Alternatively, you can try to run Wayward in a browser with the following method: https://steamcommunity.com/app/379210/discussions/0/276237094320223381/

Reporting that "An error has occured." has displayed while in-game

1. A full description of the error and issue will be found in the Wayward log files. Follow the steps in "Opening and sharing the Wayward log file" in this guide.

2. Post a new thread in the forums with the information you have collected in the "Bug Reports" forum so that we may assist you: https://steamcommunity.com/app/379210/discussions/1/

Reporting another bug or issue

Please describe in your best detail on what was done to produce the bug or issue. Please provide the Wayward version you are running and submit it to the "Bug Reports" forum: https://steamcommunity.com/app/379210/discussions/1/

Opening the Wayward Steam folder

1. Right-click on the Wayward entry in your Steam library and select "Properties.



2. Click on the "Local files" tab in the new window that opens up. Next, click on the "Browse..." button to open the Wayward Steam folder.

Opening and sharing the Wayward log file

1. Follow the steps presented in "Opening the Wayward Steam folder" in this guide.

2. Find the "logs" folder and open it. Inside you will find a "wayward.log" file. This can be opened with Notepad or another text editor. You may also have multiple log files. These are broken up into new files when they get too big.



3. New entries get added to the bottom of the file. You can copy and paste the lines needed for reporting, copy and paste the entire file, or send the entire file itself to us.

4. Use one of the following methods for sending us the information:

Text Sharing

You can use a service like http://pastebin.com/ to share the entire contents. Simply copy and paste it in to Pastebin and click "Create New Paste". Copy the URL that Pastebin provides you and share this with us. This is useful for reporting issues on the Steam forums.

Email

Send an email with the log file attached to [e-mail].

Discord

Drag and drop the log file into the #wayward channel on our Discord[discord.gg] server. This is especially useful if we are already helping you on Discord.

Opening and editing the launch_options.json

1. Follow the steps presented in "Open the Wayward Steam folder" in this guide.

2. Make sure Wayward is not running. These settings will not take effect or save if Wayward is running.

3. Find and open the launch_options.json file in Notepad or another text editor.



4. You will find the following options. Descriptions have been added to explain each option.

• "fullscreen": true, Whether the game opens in fullscreen or windowed mode. Possible values: true or false.
  
• "maximized": true, Whether the game is maximized while windowed. Possible values: true or false.
  
• "width": "max", The width of the window while windowed. Possible values: any integer or "max".
  
• "height": "max", The height of the window while windowed. Possible values: any integer or "max".
  
• "x": null, The left/right location of the window on your screen/desktop while windowed. Possible values: any integer or null.
  
• "y": null, The top/bottom location of the window on your screen/desktop while windowed. Possible values: any integer or null.
  
• "zoomFactor": 1, The scaling of the game interface. Possible values: any decimal or integer. For example: 0.5 or 1.5.
  
• "devtools": false, Whether the developer tools loads on launch. Possible values: true or false.
  
• "inProcessGpu": true, Used Steam Overlay compatibility. This option is disabled on Windows 7 and 8. To enable setting it to true on those operating systems, use the "forceInProcessGPU" option. Possible values: true or false.
  
• "extraGpuFlags": true, Used for compatibility testing. Try to set to false if you have issues running Wayward. Possible values: true or false.
  
• "ignoreGpuBlockList": true, Used to disable GPU hardware blocking. If set to false, the game may refuse to run on some hardware with potential rendering issues. Possible values: true or false.
  
• "disableGpuDriverBugWorkarounds": false, Used for compatibility testing. Try to set to true if you have issues running Wayward or if there are any graphical glitches or rendering issues. Possible values: true or false.
  
• "forceHighPerformanceGpu": true, When set to true, the game will attempt to force discrete GPU hardware to be used for the game. Set to the false to attempt to use integrated GPU solutions. Possible values: true or false.
  
• "additionalLogging": -1, Used for extra debugging. Different numbers (that are not -1) will produce different logging verbosity. Possible values: any integer.
  
• "renderer": "default", Used for changing which rendering mode to use in-game. Possible values are "default", "opengl" , "egl", "osmesa", and "swiftshader". Try changing this if your GPU/hardware doesn't support the default. Windows machines will default to "egl" (which uses ANGLE/Direct3D) with "default" set, and Mac OS X/Linux will default to "opengl" with "default" set.
  
• "angleBackend": "default", Used to switch the back-end renderer. Some of these values will only work with "renderer" changed to the appropriate framework. Possible values: "default", "d9", "d11", "software", "gl", "gles".
  
• "disableVSync": false, If set to true, VSync will be disabled (may impact performance). Possible values: true or false.
  
• "colorProfile": "srgb", Used to force a color profile (if the game is running too light/dark or is showing improper colors on your monitor). Possible values are "srgb" (default), "rgb", "gamma24", and "none" (will attempt to detect monitor's color profile).
  
• "webGlVersion": 2, Used for compatibility if your hardware does not support WebGL 2 (or has issues with rendering). Typically, Wayward will attempt to run WebGL 2, and fallback to 1, but you can change this so that 1 is forced. Possible values: 1 or 2.
  
• "forceWaveAudio": false, Set to true if you are having any kind of audio issues to see if it resolved with this setting which forces surround sound audio support. Possible values: true or false.
  
• "backgroundThrottling": false, Set to true if you want Wayward to consume less resources when in the background/not in focus. Not recommended for multiplayer as it can cause syncing and lag issues. Possible values: true or false.
  
• "openGpuInfoPage": false, Set to true if you want the GPU information page to open when launching Wayward. This GPU page will tell you what GPU Wayward detects for your system and all of its information. Possible values: true or false.
  
• "internalVersion": 2, Used internally for versioning this file. Should not be changed.
  
• "borderless": false, Set to true if you want Wayward to run as a borderless window. To be used in conjunction with the "x", "y", "width", and "height" options in this file. Wayward can be run in a normal window that can be changed in position and size by setting "fullscreen" to false or via in-game options. Possible values: true or false.
  
• "disableHardwareAcceleration": false, Set to true to disable any GPU acceleration (forces CPU for rendering). Useful for servers. Possible values: true or false.
  
• "savePath": "", Used for storing Wayward save data into a different directory, which is by default stored in the "save" folder inside the Wayward directory under Steam. Possible values: any accessible path on your computer/network or blank for the default, enclosed with "".
  
• "disableDirectComposition": true, To be used for debugging purposes. By default, and set to "true", this will potentially fix black screen rendering issues while in-game. Possible values: true or false.
  
• "forceInProcessGPU": false, To be used to force "inProcessGPU" on with Windows 7/8 which is forced off by default due to compatibility issues. Set this to true as well as the "inProcessGpu" option to force this on. Possible values: true or false.
  
• "disableES3GLContext": false, To be used to disable ES3GL, falling back to ES2GL if you are experiencing any issues with rendering. Possible values: true or false.
  
• "useVulkan": false, Set to true to enable experimental Vulkan support. This will only work on supported hardware, otherwise, it will fallback to whatever is used in "renderer" and "angleBackend" which this option would normally supersede. Using the "openGpuInfoPage" will confirm if this option is working and enabled. Possible values: true or false.
  
• "additionalChromiumSwitches": [], Use additional Chromium switches not specifically listed here. Possible values: an array of options, enclosed in "" and inside a [], for example: ["compile-shader-always-succeeds", "emulate-shader-precision"]. A list of possible values can be seen here: https://peter.sh/experiments/chromium-command-line-switches/
  
• "openWebGlReport": false To be used to launch a website ( https://webglreport.com/ ) that reports the status of WebGL support on your current hardware configuration on this version of Wayward. Possible values: true or false.

You can edit any option and save the file when done. You can make a back-up of the file in case you need to revert.

Exporting your game save

1. Open the game and click "Load Game".

2. Click the export icon of the game you wish to export:


3. You can choose either "Steam Workshop" or "Local File".

The Steam Workshop option will submit your save to the Wayward Workshop on Steam for anybody that owns Wayward to publicly use and download.

The Local File option will save the game as a file that you can send or back-up.

You can send this to [e-mail] via email or upload it to our Discord[discord.gg] server (by dragging and dropping it into the #wayward channel) for further diagnosis.

Opening the console and developer tools

You can open a console while Wayward is running to see a live log (to view errors/warnings), or the alter the game directly. You can do this one of two ways.

1. Set the "devtools" option to true within the launch_options.json. See "Opening and editing the launch_options.json" in this guide on how to do this.

2. Open Wayward and navigate to the Options menu. At the very bottom under "Developer Options", you will see a button to "Toggle Developer Tools".


If the "Developer Mode" is enabled (bound to F9 by default), you can also toggle the developer tools with F10 by default while in-game.

You can detach the developer tools to it's own window, change its position, navigate through the tabs: Elements, Console, Sources, etc. to access anything you wish internally.

Verifying integrity of game cache

Sometimes verifying the integrity of game cache is needed for Wayward to function normal. This is a common issue among all Steam games. This can also be used to force an update that isn't downloading.

1. Right-click on the Wayward entry in your Steam library and select "Properties.



2. Click on the "Local files" tab in the new window that opens up. Next, click on the "Verify integrity of game cache..." and close out of the window after it checks through the files and downloads any missing/corrupt content.

Deleting/resetting save data

To remove or reset save data, you can launch the game, open the "Options" menu, scroll down near the bottom under "Save Data", or click "Save Data" in the left hand menu to scroll automatically. You can then click on one of the following options:

1. Reset All Bindings
2. Reset All Options to Defaults
3. Remove Saved Games
4. Remove Saved Characters
5. Remove Highscores
6. Remove Milestone Progress
7. Reset Unlocked Crafting Recipes
8. Remove All Save Data


Click "Yes" on the confirmation screen to remove the data selected.

Alternatively, you can do one of the following to remove all save data (if you cannot get into the game):

1. Follow the steps presented in "Opening the Wayward Steam folder" in this guide.

Next, find a folder named "save" and delete it. This method may require you to disable Steam Cloud to work properly. See the note below.

2. Uninstall the game from Steam, then reinstall. This method may require you to disable Steam Cloud to work properly. See the note below.

* Please note that removing all save game data manually or uninstall/installing the game may not remove your save data due to Steam Cloud being activated. If you want to remove your save game data with these methods, you must also disable Steam Cloud from Wayward's properties. To do this:

1. Right-click on the Wayward entry in your Steam library and select "Properties.



2. Click on the "General" tab in the new window that opens up (if not already selected). Next, uncheck the "Keep games saves in the Steam Cloud for Wayward" checkbox as shown here:



* Please also note that If you want to keep individual game saves, you may export them. Please refer to the "Exporting your game save" section of this guide to find out on how to do this.

Disabling the Steam overlay

On certain configurations, hardware, and operating systems, Wayward may have trouble rendering the game or sometimes not even launching while the Steam overlay is enabled. To disable the Steam overlay in Wayward:

1. Right-click on the Wayward entry in your Steam library and select "Properties.



2. Uncheck the "Enable the Steam Overlay while in-game".



3. Click "CLOSE".