Skip to content

Commit 66b0c5a

Browse files
authored
Add connection timeout issue
1 parent 108b41b commit 66b0c5a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/Limitations-&-Common-Issues.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ When running a Unity Environment on macOS using Metal rendering, the application
1212

1313
## Python API
1414

15-
### Unity Environment Permission Error
15+
### Environment Permission Error
1616

1717
If you directly import your Unity environment without building it in the editor, you might need to give it additionnal permissions to execute it.
1818

@@ -26,6 +26,12 @@ or on Linux:
2626

2727
On Windows, you can find instructions [here](https://technet.microsoft.com/en-us/library/cc754344(v=ws.11).aspx).
2828

29+
### Environment Connection Timeout
30+
31+
If you are able to launch the environment from `UnityEnvironment` but then recieve a timeout error, there may be a number of possible causes.
32+
* _Cause_: There may be no Brains in your environment which are set to `External`. In this case, the environment will not attempt to communicate with python. _Solution_: Set the train you wish to externally control through the Python API to `External` from the Unity Editor, and rebuild the environment.
33+
* _Cause_: On OSX, the firewall may be preventing communication with the environment. _Solution_: Add the built environment binary to the list of exceptions on the firewall by following instructions [here](https://support.apple.com/en-us/HT201642).
34+
2935
### Filename not found
3036

3137
If you receive a file-not-found error while attempting to launch an environment, ensure that the environment files are in the root repository directory. For example, if there is a sub-folder containing the environment files, those files should be removed from the sub-folder and moved to the root.

0 commit comments

Comments
 (0)