You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing/development/configuring_an_ide/rider.rst
+26-17Lines changed: 26 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,35 +15,25 @@ JetBrains Rider
15
15
Importing the project
16
16
---------------------
17
17
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
-
23
18
.. tip:: If you already use Visual Studio as your main IDE, you can use the same solution file in Rider.
24
19
Rider and Visual Studio use the same solution format, so you can switch between the two IDEs without rebuilding the solution file.
25
20
Debug configurations need to be changed when going from one IDE to another.
26
21
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:
29
23
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 to target a specific platform.
32
26
33
-
::
27
+
Provide scons with additional arguments to request a solution file generation:
34
28
35
-
scons platform=windows vsproj=yes dev_build=yes
29
+
- Add `vsproj=yes dev_build=yes` to the scons command
36
30
37
31
The ``vsproj`` parameter signals that you want Visual Studio solution generated.
38
32
The ``dev_build`` parameter makes sure the debug symbols are included, allowing to e.g. step through code using breakpoints.
39
33
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.
42
35
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.
47
37
48
38
Compiling and debugging the project
49
39
-----------------------------------
@@ -86,4 +76,23 @@ Alternatively you can use **Run > Attach to Process** to attach the debugger to
Please refer to `the profiling instructions <https://github.com/JetBrains/godot-support/wiki/Profiling-Godot-engine-(native-code)-with-dotTrace-or-JetBrains-Rider>`_.
97
+
89
98
Please consult the `JetBrains Rider documentation <https://www.jetbrains.com/rider/documentation/>`_ for any specific information about the JetBrains IDE.
0 commit comments