{"id":22756316,"url":"https://github.com/matthewlee-dev/unreal_pycharm_debug","last_synced_at":"2026-06-24T12:01:38.888Z","repository":{"id":261877088,"uuid":"879377342","full_name":"mattdeform/unreal_pycharm_debug","owner":"mattdeform","description":"An Unreal Engine plugin for connecting to a PyCharm debugger.","archived":false,"fork":false,"pushed_at":"2024-12-12T06:11:06.000Z","size":3508,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T01:32:56.353Z","etag":null,"topics":["pycharm","remote-debug","unreal-engine-5"],"latest_commit_sha":null,"homepage":"https://www.deform.dev","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattdeform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T18:36:21.000Z","updated_at":"2025-04-08T06:45:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"e6b8bd2c-aa23-4b9a-8731-ec5edd0fbc94","html_url":"https://github.com/mattdeform/unreal_pycharm_debug","commit_stats":null,"previous_names":["mattdeform/unreal_pycharm_remote_debug"],"tags_count":1,"template":false,"template_full_name":"mattdeform/MayaPythonProjectTemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdeform%2Funreal_pycharm_debug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdeform%2Funreal_pycharm_debug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdeform%2Funreal_pycharm_debug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdeform%2Funreal_pycharm_debug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattdeform","download_url":"https://codeload.github.com/mattdeform/unreal_pycharm_debug/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250577525,"owners_count":21453135,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pycharm","remote-debug","unreal-engine-5"],"created_at":"2024-12-11T07:12:33.245Z","updated_at":"2026-06-24T12:01:36.622Z","avatar_url":"https://github.com/mattdeform.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003cdiv align=\"center\"\u003e\n\n[![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)\n[![pytest][pytest-shield]][pytest-url]\n[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n  \u003ca href=\"https://github.com/mattdeform/unreal_pycharm_debug\"\u003e\n    \u003cimg src=\"docs/resources/images/project_logo.png\" alt=\"Unreal\" width=\"50%\"\u003e\n  \u003c/a\u003e\n\n[![Python][python_3-shield]][python-url]\n[![Unreal][unreal_5-shield]][unreal-url]\n\n\u003ch3 align=\"center\"\u003eUnreal PyCharm Debug\u003c/h3\u003e\n  An Unreal Engine plugin for connecting to a PyCharm debugger.\n  \u003cbr /\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://youtu.be/xMF-_rmIiDE\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\u003e __This is NOT an official JetBrains or Epic Games plugin.__\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"docs/resources/images/screenshot.png\" alt=\"Unreal\" width=\"900\"\u003e\n\n\u003c/div\u003e\n    \n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Prerequisites\n\n* [Unreal Engine 5](https://www.unrealengine.com)\n* [PyCharm Professional](https://www.jetbrains.com/pycharm/buy/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n### Installation\n1. Select the Unreal Engine version required from the [Releases](https://github.com/mattdeform/unreal_pycharm_debug/releases) page (installation instructions included on release page).\n2. Enable the Plugin in the Unreal \"Plugin Settings\" menu, and restart the editor.\n    - \u003cimg src=\"docs/resources/images/enable_plugin.png\" alt=\"Unreal\" width=\"75%\"\u003e\n3. In the level editor you should have a new menu named \"PyCharm\".\n   - \u003cimg src=\"docs/resources/images/getting_started_0.png\" alt=\"Unreal\" width=\"75%\"\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n### Usage\n\n1. You can configure port number and debug egg file location (comes with PyCharm installation) by clicking on the PyCharm -\u003e Configure menu. \n    - \u003cimg src=\"docs/resources/images/getting_started_1.png\" alt=\"Unreal\" width=\"75%\"\u003e\n2. 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.\n    - \u003cimg src=\"docs/resources/images/getting_started_2.png\" alt=\"Unreal\" width=\"75%\"\u003e\n3. In PyCharm, create a new Python Debug Server named ___Unreal___, with the port number set in the previous step.\n    - \u003cimg src=\"docs/resources/images/getting_started_3.png\" alt=\"Unreal\" width=\"75%\"\u003e\n4. In PyCharm click the Unreal debug icon.\n    - \u003cimg src=\"docs/resources/images/getting_started_4.png\" alt=\"Unreal\" \u003e\n5. From the level editor click PyCharm -\u003e Connect. \u003ci\u003eThis will freeze your Unreal session until the next step (or timeout)\u003c/i\u003e \n    - \u003cimg src=\"docs/resources/images/getting_started_5.png\" alt=\"Unreal\" width=\"75%\"\u003e\n6. Switch back over to PyCharm and click \"Resume Program\" or press F9 \n    - \u003cimg src=\"docs/resources/images/getting_started_6.png\" alt=\"Unreal\" width=\"75%\"\u003e\n    \nPyCharm is now connected to Unreal, you can set break points in your code and interactively debug your Python tools, enjoy!\n\n\u003e 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.\n    \n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/mattdeform/unreal_pycharm_debug/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## Contributing\nIf 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\u0026template=feature-request---.md) or [report a bug](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug\u0026template=bug-report---.md) pages.\n\nDevelopment and contribution guidelines can be found on the [CONTRIBUTING.md](CONTRIBUTING.md) page\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nPlease reach out via the [request a feature](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=enhancement\u0026template=feature-request---.md) or [report a bug](https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug\u0026template=bug-report---.md) pages.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n* Project template by [TechArtOps](https://www.techartops.com).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n\u003c!-- Python --\u003e\n[python-shield]: https://img.shields.io/badge/python-3670A0?logo=python\u0026logoColor=ffdd54\n[python_2-shield]: https://img.shields.io/badge/Python-2.X-grey?logo=python\u0026logoColor=ffdd54\u0026labelColor=%233670A0\n[python_3-shield]: https://img.shields.io/badge/Python-3.X-grey?logo=python\u0026logoColor=ffdd54\u0026labelColor=%233670A0\n[python-url]: https://python.org/\n[pytest-shield]: https://img.shields.io/badge/tests-pytest-%230A9EDC\n[pytest-url]: https://docs.pytest.org/\n[unreal_5-shield]: https://img.shields.io/badge/Unreal%20Engine-5.x-grey?logo=unrealengine\u0026labelColor=%230E1128\n[unreal-url]: https://www.unrealengine.com/en-US\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewlee-dev%2Funreal_pycharm_debug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthewlee-dev%2Funreal_pycharm_debug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewlee-dev%2Funreal_pycharm_debug/lists"}