https://github.com/mattdeform/unreal_pycharm_debug

An Unreal Engine plugin for connecting to a PyCharm debugger.
https://github.com/mattdeform/unreal_pycharm_debug

pycharm remote-debug unreal-engine-5

Last synced: about 2 months ago
JSON representation

An Unreal Engine plugin for connecting to a PyCharm debugger.

• Host: GitHub
• URL: https://github.com/mattdeform/unreal_pycharm_debug
• Owner: mattdeform
• License: mit
• Created: 2024-10-27T18:36:21.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-12T06:11:06.000Z (6 months ago)
• Last Synced: 2025-04-20T01:32:56.353Z (about 2 months ago)
• Topics: pycharm, remote-debug, unreal-engine-5
• Language: Python
• Homepage: https://www.deform.dev
• Size: 3.35 MB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        




[![CI](https://github.com/mattdeform/unreal_pycharm_debug/actions/workflows/ci-main.yml/badge.svg)](https://github.com/mattdeform/unreal_pycharm_debug/actions/workflows/ci-main.yml)

[![pytest][pytest-shield]][pytest-url]

[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)




  

    

  

[![Python][python_3-shield]][python-url]

[![Unreal][unreal_5-shield]][unreal-url]

Unreal PyCharm Debug

  An Unreal Engine plugin for connecting to a PyCharm debugger.

  


  


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    


      About The Project

    

    


      Getting Started

      


        
Prerequisites

        
Installation

        
Usage

      

    

    
Roadmap

    
Contributing

    
Contact

    
Acknowledgments

  


## About The Project

> __This is NOT an official JetBrains or Epic Games plugin.__







    

(back to top)


## Getting Started

### Prerequisites

* [Unreal Engine 5](https://www.unrealengine.com)

* [PyCharm Professional](https://www.jetbrains.com/pycharm/buy/)

(back to top)


### Installation

1. Select the Unreal Engine version required from the [Releases](https://github.com/mattdeform/unreal_pycharm_debug/releases) page (installation instructions included on release page).

2. Enable the Plugin in the Unreal "Plugin Settings" menu, and restart the editor.

    - 

3. In the level editor you should have a new menu named "PyCharm".

   - 

(back to top)


### Usage

1. You can configure port number and debug egg file location (comes with PyCharm installation) by clicking on the PyCharm -> Configure menu. 

    - 

2. 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.

    - 

3. In PyCharm, create a new Python Debug Server named ___Unreal___, with the port number set in the previous step.

    - 

4. In PyCharm click the Unreal debug icon.

    - 

5. From the level editor click PyCharm -> Connect. This will freeze your Unreal session until the next step (or timeout) 

    - 

6. 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.

    

(back to top)


## Roadmap

See the [open issues](https://github.com/mattdeform/unreal_pycharm_debug/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](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=enhancement&template=feature-request---.md) or [report a bug](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug&template=bug-report---.md) pages.

Development and contribution guidelines can be found on the [CONTRIBUTING.md](CONTRIBUTING.md) page

## Contact

Please reach out via the [request a feature](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=enhancement&template=feature-request---.md) or [report a bug](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug&template=bug-report---.md) pages.

(back to top)


## Acknowledgments

* Project template by [TechArtOps](https://www.techartops.com).

(back to top)


[python-shield]: https://img.shields.io/badge/python-3670A0?logo=python&logoColor=ffdd54

[python_2-shield]: https://img.shields.io/badge/Python-2.X-grey?logo=python&logoColor=ffdd54&labelColor=%233670A0

[python_3-shield]: https://img.shields.io/badge/Python-3.X-grey?logo=python&logoColor=ffdd54&labelColor=%233670A0

[python-url]: https://python.org/

[pytest-shield]: https://img.shields.io/badge/tests-pytest-%230A9EDC

[pytest-url]: https://docs.pytest.org/

[unreal_5-shield]: https://img.shields.io/badge/Unreal%20Engine-5.x-grey?logo=unrealengine&labelColor=%230E1128

[unreal-url]: https://www.unrealengine.com/en-US