Skip to content

Commit 02f897b

Browse files
committed
Reflect the changes to Rider setup after the fix of the project generation logic to support any OS without MSVC toolchain
1 parent 0b174c6 commit 02f897b

File tree

2 files changed

+28
-17
lines changed

2 files changed

+28
-17
lines changed

contributing/development/compiling/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:allow_comments: False
22

3+
.. _doc_compiling_index:
4+
35
Building from source
46
====================
57

contributing/development/configuring_an_ide/rider.rst

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,25 @@ JetBrains Rider
1515
Importing the project
1616
---------------------
1717

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-
2318
.. tip:: If you already use Visual Studio as your main IDE, you can use the same solution file in Rider.
2419
Rider and Visual Studio use the same solution format, so you can switch between the two IDEs without rebuilding the solution file.
2520
Debug configurations need to be changed when going from one IDE to another.
2621

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.
22+
If you are starting from the scratch, please follow :ref:`instructions<doc_compiling_index>`, specifically:
2923

30-
- Navigate to the Godot root folder and open a Command Prompt or PowerShell window.
31-
- Copy, paste and run the next command to generate the solution.
24+
- Install all the dependencies.
25+
- Figure out the scons command for compiling targeting a specific platform.
3226

33-
::
27+
Provide scons with additional arguments to request a solution file generation:
3428

35-
scons platform=windows vsproj=yes dev_build=yes
29+
- Add `vsproj=yes dev_build=yes` to the scons command
3630

3731
The ``vsproj`` parameter signals that you want Visual Studio solution generated.
3832
The ``dev_build`` parameter makes sure the debug symbols are included, allowing to e.g. step through code using breakpoints.
3933

40-
- 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
41-
or by using the **Open** option inside of Rider.
34+
- Open the generated ``godot.sln`` in Rider.
4235

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.
36+
.. note:: Ensure that the appropriate Solution configuration is selected on the Rider toolbar. It affects resolve of the SDKs, code analysis, build, run, etc.
4737

4838
Compiling and debugging the project
4939
-----------------------------------
@@ -86,4 +76,23 @@ Alternatively you can use **Run > Attach to Process** to attach the debugger to
8676
.. figure:: img/rider_attach_to_process_dialog.webp
8777
:align: center
8878

79+
|
80+
81+
Debug visualizers
82+
-----------------
83+
Debug visualizers define how complex data structures are displayed in the debugger.
84+
For Windows "natvis" (short for "Native Visualization") built-in with Godot are automatically used.
85+
For other operating systems a similar functionality can be enabled separately.
86+
87+
Please follow `RIDER-123535 <https://youtrack.jetbrains.com/issue/RIDER-123535/nix-Debug-Godot-Cpp-from-Rider-pretty-printers-usability>`_.
88+
89+
Unit testing
90+
------------
91+
Utilize Rider :ref:`doctest<doc_unit_testing>` support.
92+
Please follow `RIDER-122019 <https://youtrack.jetbrains.com/issue/RIDER-122019/Godot-doctest-Unit-Tests-Stuck-in-pending>`_.
93+
94+
Profiling
95+
---------
96+
Please refer to `the profiling instructions <https://github.com/JetBrains/godot-support/wiki/Profiling-Godot-engine-(native-code)-with-dotTrace-or-JetBrains-Rider>`_.
97+
8998
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)