README.md

Unreal PyCharm Remote Debug

A convenience plugin for connecting Unreal to a PyCharm remote debugger.

Report Bug · Request Feature · Docs · Quickstart Video

Table of Contents

1. About The Project
2. Getting Started
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Tip

Just want to use the plugin? Get it on FAB

Debug and interact with your Unreal Python tools at runtime, directly from PyCharm. Set breakpoints, step through your code, and inspect or modify state while your Python tool is running in Unreal. Local and remote debugging are both supported.

This is NOT an official JetBrains or Epic Games plugin.

(back to top)

Getting Started

See the documentation for prerequisites, installation, usage, and remote debugging setup.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

(back to top)

License

MIT, see LICENSE. No JetBrains code is redistributed - the debug egg is read from your own PyCharm install at runtime.

(back to top)

Contact

Please reach out via the request a feature or report a bug pages.

(back to top)

Acknowledgments

• deform.dev

(back to top)