Skip to content

Commit 464e320

Browse files
Update JetBrains Rider documentation (#10025)
Revised JetBrains Rider setup steps and clarified debug configurations. Replaced outdated .webp images with new .png files for newer and clearer screenshots. Add a note clarifying that this documentation is intended for contributing to the game engine, not for using JetBrains Rider as a C# or GDScript editor. Include reference to the C# guide for configuring an external editor. Fixed duplicate link based on the Sphinx format. This should fix the warning/error on the page. --------- Co-authored-by: Max Hilbrunner <[email protected]>
1 parent 018f241 commit 464e320

File tree

6 files changed

+34
-14
lines changed

6 files changed

+34
-14
lines changed
129 KB
Loading
136 KB
Loading
36.2 KB
Loading
170 KB
Loading
16.2 KB
Loading

contributing/development/configuring_an_ide/rider.rst

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
.. _doc_configuring_an_ide_rider:
22

3-
Rider
4-
=====
3+
JetBrains Rider
4+
===============
55

6-
`Rider <https://www.jetbrains.com/rider/>`_ is a commercial
6+
`JetBrains Rider <https://www.jetbrains.com/rider/>`_ is a commercial
77
`JetBrains <https://www.jetbrains.com/>`_ IDE for C# and C++ that uses the same solution system as Visual Studio.
88

9+
.. note::
10+
11+
This documentation is for contributions to the game engine, and not using
12+
JetBrains Rider as a C# or GDScript editor. To code C# or GDScript in an external editor, see
13+
:ref:`the C# guide to configure an external editor <doc_c_sharp_setup_external_editor>`.
14+
915
Importing the project
1016
---------------------
1117

18+
You will need to install `Python <https://www.python.org/>`_ in your development environment
19+
along with `MinGW <https://www.mingw-w64.org/downloads/>`_. You will also need the Visual Studio C++ Build Tools, which
20+
you can install using the Visual Studio Installer. Ensure all dependencies are installed
21+
before you continue to the next steps.
22+
1223
.. tip:: If you already use Visual Studio as your main IDE, you can use the same solution file in Rider.
1324
Rider and Visual Studio use the same solution format, so you can switch between the two IDEs without rebuilding the solution file.
1425
Debug configurations need to be changed when going from one IDE to another.
1526

16-
Rider requires a solution file to work on a project. While Godot does not come
17-
with the solution file, it can be generated using SCons.
27+
Rider requires a solution file to work on a C++ project. While Godot does not come
28+
with a solution file, it can be generated using SCons.
1829

1930
- Navigate to the Godot root folder and open a Command Prompt or PowerShell window.
2031
- Copy, paste and run the next command to generate the solution.
@@ -29,9 +40,10 @@ The ``dev_build`` parameter makes sure the debug symbols are included, allowing
2940
- If you have Rider setup as your main IDE for .sln, you can now open the project by double-clicking on the ``godot.sln`` in the project root
3041
or by using the **Open** option inside of Rider.
3142

32-
.. note:: Rider could fail to build the first time you open the project.
33-
If that is the case, you can close Rider and open the solution in Visual Studio, build it, close Visual Studio,
34-
and open the solution in Rider again. You are now able to build the project from Rider.
43+
.. note:: Rider could fail to build the solution.
44+
If that is the case, try running `git clean -xdf` to remove all traces of the previous build artifacts
45+
and regenerate the build files using the `scons` command again. Restarting the terminal and your
46+
development environment may help.
3547

3648
Compiling and debugging the project
3749
-----------------------------------
@@ -47,23 +59,31 @@ if you want to debug the editor, you need to configure the debugger first.
4759
.. figure:: img/rider_configurations.webp
4860
:align: center
4961

50-
- Delete what is under **Program arguments** and paste the following line:
51-
52-
::
62+
- Ensure the following values for the C++ Project Run Configuration:
5363

54-
-e --path <path to the Godot project>
64+
- Exe Path : ``$(LocalDebuggerCommand)``
65+
- Program Arguments: ``-e --path <path to the Godot project>``
66+
- Working Directory: ``$(LocalDebuggerWorkingDirectory)``
67+
- Before Launch has a value of "Build Project"
5568

5669
This will tell the executable to debug the specified project without using the project manager.
5770
Use the root path to the project folder, not ``project.godot`` file path.
5871

5972
.. figure:: img/rider_configurations_changed.webp
6073
:align: center
6174

62-
- Finally click on apply and ok to save the changes.
75+
- Finally click on "Apply" and "OK" to save the changes.
6376

64-
- You can now launch the debugger by pressing the **Debug** icon at the top of the screen and it will open the project to debug.
77+
- When you press the **Debug** icon at the top of the screen, JetBrains Rider will launch the Godot editor with the debugger attached.
6578

6679
Alternatively you can use **Run > Attach to Process** to attach the debugger to a running Godot instance.
6780

6881
.. figure:: img/rider_attach_to_process.webp
6982
:align: center
83+
84+
- You can find the Godot instance by searching for ``godot.editor`` and then clicking ``Attach with LLDB``
85+
86+
.. figure:: img/rider_attach_to_process_dialog.webp
87+
:align: center
88+
89+
Please consult the `JetBrains Rider documentation <https://www.jetbrains.com/rider/documentation/>`_ for any specific information about the JetBrains IDE.

0 commit comments

Comments
 (0)