Skip to content

Latest commit

 

History

History
170 lines (107 loc) · 7.91 KB

common_errors.md

File metadata and controls

170 lines (107 loc) · 7.91 KB
Raw
Troubleshooting

Common errors

This document is a list of common usage errors in TDW. This is not a comprehensive document. We are continuously expanding this document as our user base increases and we gain more information about beginner TDW users.

If after reading this document you're still unsure how to fix your error, please report the bug as a GitHub Issue.

General usage errors

The build or controller crashed

  • Make sure that your tdw Python module is at the latest release.
  • Make sure that the version of the TDW build matches the version of the tdw Python module.
  • See sections below for common controller and build problems.
  • Add a logger to your controller.

The simulation hangs indefinitely

  • Cause: This is usually because another process (such as another instance of a TDW build) that is using the same port and received a message intended for the TDW build.
  • Solution: Kill all controller processes and build processes.

The simulation behaves differently on different machines / Physics aren't deterministic

  • Cause: This is how the Unity physics engine works.
  • Solution: Differences in behavior between machines should be very minor. Because the issue is intrinsic to PhysX, we can reduce determinism problems but we can't totally fix them.

The simulation is slow

There are no shadows in the scene / rendering quality is generally poor

  • Cause: There are two common causes:
    • You're running TDW without a GPU or your GPU isn't powerful. Certain rendering steps won't occur if the GPU is incapable of doing them; some of the more obvious examples are shadows and reflections.
    • You're using a low render quality setting. Render quality settings can sometimes carry between build process instances; this appears to be a Unity Engine bug.
  • Solution:

[Linux:] Can't launch the simulation in a Docker container

  • Cause: Either there is a problem with your Docker image or you have launch_build=True in the Controller constructor.
  • Solution: TDW Docker image. Set launch_build=False in the Controller constructor.

[Linux:] Images are grainy / very dark / obviously glitchy

  • Cause: Check the player log. If there are thousands of repeating errors about OpenGL, this is a known issue when running TDW on certain Linux machines.

  • Solution: Run the build in OpenGL 4.2:

    ./TDW.x86_64 -force-glcore42

[Linux:] Nothing happens after launching a minimal controller + build

  • Cause: Check the player log. If you see Desktop is 0 x 0 @ 0 Hz, this means that your xorg isn't set up correctly.
  • Solution: Read the install guide for how to launch the build on a headless server; note that there must be a valid virtual display.

[OS X]: I can't run TDW.app in the terminal

  • Cause: There is a file within TDW.app that you need to launch in the terminal.
  • Solution:
    • You can launch TDW.app by double-clicking it.
    • To launch TDW.app in the terminal: Right-click on the TDW.app file. Click Show Package Contents. Find the executable in the MacOS folder (e.g. “TDW_v1.9.0”) and drag that to your bash shell window.

[OS X:] When I double-click TDW.app I get an error: TDW.app is damaged and can't be opened

  • Cause: This is a known Unity bug and it will occur if you download the build from TDW's releases page.
  • Solution: Run setup.sh (located in the same directory as TDW.app). This will repair TDW.app; you only need to run setup.sh once.

[OS X:] I can't run NVIDIA Flex

  • Cause: Flex doesn't run on OS X.

Errors in the Python (controller) console

zmq.error.ZMQError: Address in use

  • Cause: There is another controller process using this socket.
  • Solution: Kill all controller processes and build processes. Launch each controller + build on a separate port.

requests.exceptions.ConnectionError: HTTPSConnectionPool(host='github.com', port=443): Max retries exceeded with url:

  • Cause: You tried launching the build. Your build is out of date. The controller tried to get the latest version of TDW but failed due to an internet connection error.
  • Solution: Kill the controller process. Kill the build process. Either enable your Internet connection or set launch_build=False in the constructor. Note that if you don't have an Internet connection, you won't be able to add any objects to the scene.

The build quit due to an error. Check the build log for more info.

AttributeError: module 'enum' has no attribute 'IntFlag'

  • Cause: Class name clash in Python when trying to install tdw
  • Solution: pip3 uninstall enum34 and pip3 install tdw

Errors in the Player (build) log

NullReferenceException

  • Cause: This usually means that one or more fields in your commands is incorrect (i.e. you're sending the ID of an object that doesn't exist in the scene).
  • Solution: Proofread your commands. If problems still persist, add a GitHub Issue.

WARNING: Shader Unsupported

This warning is harmless; you can ignore it.

The referenced script on this Behaviour (Game Object '<NAME>') is missing!

This warning is harmless; you can ignore it.

Class not found: <type> [SerializationBinder]

  • Cause: You sent a command that doesn't exist.
  • Solution: Check the spelling of your commands.

Newtonsoft.Json.JsonSerializationException

  • Cause: At least one of your commands is invalid. Common mistakes:
    • A command name is spelled wrong.
    • You sent an array such as [0, 0, 0] instead of a dictionary such as {"x": 0, "y": 0, "z": 0}.
    • You sent the wrong type of parameter, such as sending a dictionary when the API expects a float.
  • Solution: Read the message carefully; it includes the last message sent to the build and indicates where in the string the error is.

[Linux:] Segfault

  • Cause: Segfaults are rare and relatively hard to debug. Below is a solution to the most common segfault; if that doesn't work, please post a GitHub Issue.

  • Solution: Make sure that unzip didn't fail and that the executable (TDW.x86_64) is in the same directory as TDW_Data:

    TDW/
....TDW_Data/
....TDW.x86_64

[OS X:] SocketException: Could not resolve host 'localhost'

  • Cause: localhost isn't a listed host.
  • Solution: To add localhost to your computer's list of hosts, read this.

[Windows:] The code execution cannot proceed because UnityPlayer.dll was not found. Reinstalling the program may fix this problem.

  • Cause: TDW.exe is in the wrong directory; it must be in the same directory as all of the other files from the .zip file.

  • Solution: Make sure that the executable TDW.exe is in the same folder as the other unzipped files:

    TDW/
....MonoBleedingEdge/
....TDW_Data/
....UnityCrashHandler64.exe
....UnityPlayer.dll
....TDW.exe

Next: Performance optimizations

Return to the README