Skip to content

Commit c4cc7be

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 c4cc7be

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
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: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,35 @@ 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.
18+
Please ensure to follow :ref:`instructions<doc_compiling_index>` and install all the required dependencies before you continue to the next steps.
2219

2320
.. tip:: If you already use Visual Studio as your main IDE, you can use the same solution file in Rider.
2421
Rider and Visual Studio use the same solution format, so you can switch between the two IDEs without rebuilding the solution file.
2522
Debug configurations need to be changed when going from one IDE to another.
2623

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.
24+
Rider requires a solution file to work on a C++ project. While Godot does not come with a solution file, it can be generated using SCons.
2925

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.
26+
- Execute the following command in the Godot root folder to generate the solution.
3227

3328
::
3429

35-
scons platform=windows vsproj=yes dev_build=yes
30+
scons vsproj=yes dev_build=yes
31+
32+
33+
For an alternative build tooling it might look like this:
34+
35+
::
36+
37+
scons use_mingw=yes use_llvm=yes vsproj=yes dev_build=yes
38+
3639

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

4043
- 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
4144
or by using the **Open** option inside of Rider.
4245

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

4848
Compiling and debugging the project
4949
-----------------------------------
@@ -86,4 +86,14 @@ Alternatively you can use **Run > Attach to Process** to attach the debugger to
8686
.. figure:: img/rider_attach_to_process_dialog.webp
8787
:align: center
8888

89+
Improve debugging outside Windows
90+
---------------------------------
91+
Pretty printers in LLDB are used to format complex data structures into a human-readable form during debugging.
92+
Please follow `RIDER-123535 <https://youtrack.jetbrains.com/issue/RIDER-123535/nix-Debug-Godot-Cpp-from-Rider-pretty-printers-usability>`_.
93+
94+
Unit testing
95+
------------
96+
Utilize the :ref:`doctest<doc_unit_testing>` support.
97+
Please follow `RIDER-122019 <https://youtrack.jetbrains.com/issue/RIDER-122019/Godot-doctest-Unit-Tests-Stuck-in-pending>`_.
98+
8999
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)