|
13 | 13 | <!-- PROJECT LOGO --> |
14 | 14 | <br /> |
15 | 15 | <a href="https://github.com/mattdeform/unreal_pycharm_debug"> |
16 | | - <img src="docs/resources/images/project_logo.png" alt="Unreal" width="50%"> |
| 16 | + <img src="docs/resources/images/project_logo.png" alt="Unreal" width="30%"> |
17 | 17 | </a> |
18 | 18 |
|
19 | 19 | [![Python][python_3-shield]][python-url] |
|
23 | 23 | An Unreal Engine plugin for connecting to a PyCharm debugger. |
24 | 24 | <br /> |
25 | 25 | <p align="center"> |
26 | | - <a href="https://www.youtube.com/watch?v=wymW7qOSqiw">View Demo</a> |
| 26 | + <a href="https://youtu.be/xMF-_rmIiDE">View Demo</a> |
27 | 27 | · |
28 | 28 | <a href="https://github.com/mattdeform/unreal_pycharm_debug/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> |
29 | 29 | · |
|
83 | 83 | ### Installation |
84 | 84 | 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). |
85 | 85 | 2. Enable the Plugin in the Unreal "Plugin Settings" menu, and restart the editor. |
86 | | - <img src="docs/resources/images/enable_plugin.png" alt="Unreal" width="75%"> |
| 86 | + - <img src="docs/resources/images/enable_plugin.png" alt="Unreal" width="75%"> |
87 | 87 | 3. In the level editor you should have a new menu named "PyCharm". |
88 | | - <img src="docs/resources/images/getting_started_0.png" alt="Unreal" width="75%"> |
| 88 | + - <img src="docs/resources/images/getting_started_0.png" alt="Unreal" width="75%"> |
89 | 89 |
|
90 | 90 | <p align="right">(<a href="#readme-top">back to top</a>)</p> |
91 | 91 |
|
|
94 | 94 | ### Usage |
95 | 95 |
|
96 | 96 | 1. You can configure port number and debug egg file location (comes with PyCharm installation) by clicking on the PyCharm -> Configure menu. |
97 | | - 1. <img src="docs/resources/images/getting_started_1.png" alt="Unreal" width="75%"> |
| 97 | + - <img src="docs/resources/images/getting_started_1.png" alt="Unreal" width="75%"> |
98 | 98 | 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. |
99 | | - 1. <img src="docs/resources/images/getting_started_2.png" alt="Unreal" width="75%"> |
| 99 | + - <img src="docs/resources/images/getting_started_2.png" alt="Unreal" width="75%"> |
100 | 100 | 3. In PyCharm, create a new Python Debug Server named ___Unreal___, with the port number set in the previous step. |
101 | | - 1. <img src="docs/resources/images/getting_started_3.png" alt="Unreal" width="75%"> |
| 101 | + - <img src="docs/resources/images/getting_started_3.png" alt="Unreal" width="75%"> |
102 | 102 | 4. In PyCharm click the Unreal debug icon. |
103 | | - 1. <img src="docs/resources/images/getting_started_4.png" alt="Unreal" > |
| 103 | + - <img src="docs/resources/images/getting_started_4.png" alt="Unreal" > |
104 | 104 | 5. From the level editor click PyCharm -> Connect. <i>This will freeze your Unreal session until the next step (or timeout)</i> |
105 | | - 1. <img src="docs/resources/images/getting_started_5.png" alt="Unreal" width="75%"> |
| 105 | + - <img src="docs/resources/images/getting_started_5.png" alt="Unreal" width="75%"> |
106 | 106 | 6. Switch back over to PyCharm and click "Resume Program" or press F9 |
107 | | - 1. <img src="docs/resources/images/getting_started_6.png" alt="Unreal" width="75%"> |
| 107 | + - <img src="docs/resources/images/getting_started_6.png" alt="Unreal" width="75%"> |
108 | 108 |
|
109 | 109 | PyCharm is now connected to Unreal, you can set break points in your code and interactively debug your Python tools, enjoy! |
110 | 110 |
|
|
0 commit comments