Table of Contents
This is NOT an official JetBrains or Epic Games plugin.
- Select the Unreal Engine version required from the Releases page (installation instructions included on release page).
- Enable the Plugin in the Unreal "Plugin Settings" menu, and restart the editor.
-
- In the level editor you should have a new menu named "PyCharm".
-
- You can configure port number and debug egg file location (comes with PyCharm installation) by clicking on the PyCharm -> Configure menu.
-
- Select desired port number, and click "Find installed" to find the systems installed PyCharm. Alternatively you can manually enter a path to a desired pydevd-pycharm.egg file.
-
- In PyCharm, create a new Python Debug Server named Unreal, with the port number set in the previous step.
-
- In PyCharm click the Unreal debug icon.
-
- From the level editor click PyCharm -> Connect. This will freeze your Unreal session until the next step (or timeout)
-
- Switch back over to PyCharm and click "Resume Program" or press F9
-
PyCharm is now connected to Unreal, you can set break points in your code and interactively debug your Python tools, enjoy!
Note: Sometimes debug sessions can hang or become unstable. If this happens you can simply click the "Disconnect" button in Unreal and then start from step 4 again.
See the open issues for a full list of proposed features (and known issues).
If you have a suggestion that would make this better, please open an issue from the request a feature or report a bug pages.
Development and contribution guidelines can be found on the CONTRIBUTING.md page
Please reach out via the request a feature or report a bug pages.
- Project template by TechArtOps.