Skip to content

Commit 99e4dba

Browse files
committed
Update Rider IDE configuration docs
- Note that scons must be run once per target so each Solution Configuration has its `.generated.props` file. - More verbose Run Configuration values. - Drop the Windows-only caveat for natvis and the RIDER-123535 reference; natvis now works on macOS and Linux with Rider 2026.2+.
1 parent 28d14cb commit 99e4dba

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

  • engine_details/development/configuring_an_ide

engine_details/development/configuring_an_ide/rider.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ Provide scons with additional arguments to request a solution file generation:
3131
The ``vsproj`` parameter signals that you want Visual Studio solution generated.
3232
The ``dev_build`` parameter ensures the debug symbols are included, allowing to e.g. step through code using breakpoints.
3333

34+
.. note:: Each scons run only generates the ``.generated.props`` file for a single
35+
Solution Configuration, please run scons once per target you plan to use:
36+
37+
.. code-block:: shell
38+
39+
scons vsproj=yes dev_build=yes target=editor
40+
scons vsproj=yes dev_build=yes target=template_debug
41+
scons vsproj=yes dev_build=yes target=template_release
42+
3443
- Open the generated ``godot.sln`` in Rider.
3544

3645
.. note:: Ensure that the appropriate Solution configuration is selected on the
@@ -54,8 +63,8 @@ if you want to debug the editor, you need to configure the debugger first.
5463
- Ensure the following values for the C++ Project Run Configuration:
5564

5665
- Exe Path : ``$(LocalDebuggerCommand)``
57-
- Program Arguments: ``-e --path <path to the Godot project>``
58-
- Working Directory: ``$(LocalDebuggerWorkingDirectory)``
66+
- Program Arguments: ``--editor``
67+
- Working Directory: ``<path to the Godot project>``
5968
- Before Launch has a value of "Build Project"
6069

6170
This will tell the executable to debug the specified project without opening the Project Manager.
@@ -83,10 +92,9 @@ Alternatively you can use **Run > Attach to Process** to attach the debugger to
8392
Debug visualizers
8493
-----------------
8594
Debug visualizers customize how complex data structures are displayed during debugging.
86-
For Windows "natvis" (short for "Native Visualization") built-in with Godot are automatically used.
87-
For other operating systems, similar functionality can be setup manually.
95+
The "natvis" (short for "Native Visualization") files built-in with Godot are automatically used.
8896

89-
Please follow `RIDER-123535 <https://youtrack.jetbrains.com/issue/RIDER-123535/nix-Debug-Godot-Cpp-from-Rider-pretty-printers-usability>`_.
97+
.. note:: On MacOS and Linux, natvis support requires Rider 2026.2 or later.
9098

9199
Unit testing
92100
------------

0 commit comments

Comments
 (0)