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
* Rework "Getting Started with Rider" guide
* Rider: Add mention of Discord channel and server
* Rider: Add more info about resharper build troubleshooting
@@ -3,23 +3,88 @@ title: Setting up your development environment for Rider
3
3
description: A step-by-step guide for setting up your development IDE for Rider
4
4
---
5
5
6
-
This is a guide on setting up your development environment for creating games with MonoGame using Rider by JetBrains. By following this guide, you will learn how to install the tools for developing C# applications and configure Rider with recommended extensions for C# development.
6
+
This is a guide on setting up your development environment for creating games with MonoGame using JetBrains Rider.
7
+
By following this guide, you will learn how to install and configure Rider with the recommended extension for MonoGame development.
7
8
8
-
By the end, you will be fully equipped to start creating games with MonoGame using Rider.
9
+
## Installing Rider
9
10
10
-
## Install Rider
11
+
> [!NOTE]
12
+
> Rider is [free for non-commercial use](https://www.jetbrains.com/non-commercial/), you do have to register and create an account, but otherwise all features will be unlocked.
13
+
>
14
+
15
+
### Toolbox App
16
+
17
+
The JetBrains Toolbox App is the recommended tool to install JetBrains products. It allows instant rollbacks,
18
+
having multiple Rider instances, auto-updating to the latest version, and unifies the setup experience across OSes.
19
+
20
+
[Install Rider using JetBrains Toolbox](https://www.jetbrains.com/help/rider/Installation_guide.html#toolbox)
It is recommended to use the [MonoGame plugin for JetBrains Rider](https://plugins.jetbrains.com/plugin/18415-monogame) when working under your project in Rider to unlock the most available IDE features. The plugin is free, [open-source](https://github.com/seclerp/rider-monogame), and distributed under the MIT license. However, this step is still optional.
34
+
35
+
To explore all available features of the MonoGame plugin for Rider, you can refer to the [rider-monogame/README.md](https://github.com/seclerp/rider-monogame?tab=readme-ov-file#monogame-plugin-for-jetbrains-rider).
36
+
37
+
### [With plugin](#tab/plugin)
38
+
39
+
#### Installing MonoGame plugin
40
+
41
+
1. Click on the "Plugins" menu item on the Welcome screen:
42
+
43
+
44
+
45
+
1. Under the "Marketplace" tab, search for the "MonoGame" in the search bar
46
+
1. Click on the "Install" button next to the MonoGame plugin:
60
+
61
+
1. Click "Install MonoGame Templates".
62
+
63
+
> [!WARNING]
64
+
> As of Rider 2025.3, due to a [known bug](https://youtrack.jetbrains.com/issue/RIDER-135465), the `MonoGame.Templates.CSharp` package that Rider installs globally will not be automatically visible to the `dotnet new` from the terminal. You need to install them manually too.
65
+
66
+
#### Creating a new MonoGame project
67
+
68
+
1. Click on the "New Solution" button
69
+
1. On the left sidebar of the New Project Wizard, select the MonoGame section
70
+
1. Fill the "Solution name" and "Solution directory"
71
+
1. Choose the project type:
72
+
73
+
74
+
75
+
1. Click "Create"
76
+
1. You can now press `F5` to compile and debug your game!
15
77
16
78
> [!NOTE]
17
-
> Rider is free for personal use, you do have to register and create an account, but otherwise all features will be unlocked.
18
-
>
79
+
> In case you want to use the different versions of the project templates, including preview packages, you can select another available package version under the "Available packages" field:
80
+
>
81
+
> 
82
+
83
+
### [Without plugin](#tab/no-plugin)
19
84
20
-
##Setting up Rider for development with MonoGame
85
+
#### Installing project templates
21
86
22
-
1. Open up terminal (or Powershell on Windows)
87
+
1. Open up your favorite terminal
23
88
1. Run the following command to install templates:
24
89
25
90
```sh
@@ -31,35 +96,58 @@ You can download and install Rider from: [https://www.jetbrains.com/rider/downlo
31
96
>
32
97
>* [How to install MonoGame Preview packages](../getting_to_know/howto/HowTo_Install_Preview_Release.md)
33
98
34
-
## Creating a new MonoGame project
99
+
#### Creating a new MonoGame project
35
100
36
-
To get you started with Rider, here are the steps for setting up a new Rider MonoGame project.
101
+
1. Click on the "New Solution" button
102
+
1. On the left sidebar of the New Project Wizard, find the MonoGame template under the "Custom Templates" section
103
+
1. Fill the "Solution name" and "Solution directory"
104
+
1. Choose the project type:
37
105
38
-
1. Open up Rider
39
-
2. Click on the "New Solution" button
106
+
40
107
41
-
108
+
1. Click "Create"
109
+
1. You can now press `F5` to compile and debug your game!
110
+
111
+
---
42
112
43
-
3. Select "MonoGame Cross-Platform Desktop Application" on the list on the left
A couple of advice to keep your development setup up to date:
46
116
47
-
4. Press "Create"
48
-
5. You can now press `F5` to compile and debug your game, happy coding :)
117
+
1. Always use the latest stable version of Rider.
118
+
Configure the update policy [for the Rider installed via installer](https://www.jetbrains.com/help/rider/Update.html#update-settings)
119
+
or [for the Rider installed via the Toolbox App](https://www.jetbrains.com/help/rider/Update.html#update-all-tools).
120
+
121
+
1. It is recommended to enable [the plugins auto-update feature](https://www.jetbrains.com/help/rider/Managing_Plugins.html#update-plugins-automatically).
122
+
123
+
This way both Rider and installed plugins will always be up to date with the newest fixes and features available.
124
+
125
+
### Troubleshooting
49
126
50
127
> [!NOTE]
51
-
> If you are experiencing issues with compiling effects under Linux for JetBrains Rider,
52
-
> you might need to add the `MGFXC_WINE_PATH` environment variable to `/etc/environment`for it to be picked up. See [5777151094034-Rider-cannot-see-all-Environmental-Variables](https://rider-support.jetbrains.com/hc/en-us/community/posts/5777151094034-Rider-cannot-see-all-Environmental-Variables) for details.
128
+
> In case you need any further assistance or problem troubleshooting, please drop a message into the
129
+
> [#help-rider](https://discord.com/channels/355231098122272778/1468243299855761543) channel on the
#### ContentBuilder doesn't detect changes in content files in subsequent runs
55
133
56
-
The MonoGame Content Editor (MGCB) it a tool delivered through NuGet foryour project using the tools configuration heldin your `dotnet-tools.json` file (located in the `.config` folder of your project).
134
+
ReSharper Solution Builder tries to proactively optimize MSBuild targets building, which means some targets that doesn't
135
+
support incremental compilation would essentially be ignored. About ReSharper build feature: https://www.jetbrains.com/help/rider/Build_Process.html
57
136
58
-
Once you have created your project you should run the following terminal/command-line command to ensure the tool (and the pipeline) is setup and readfor your project:
137
+
There is an option under **Settings** > **Build, Execution, Deployment** > **Toolset and Build** > **Build** section
138
+
called "Invoke BeforeBuild and AfterBuild targets for skipped projects" to force Rider to call targets that depend on
139
+
`BeforeBuild` and `AfterBuild`, which solves this problem:
59
140
60
-
```dotnetcli
61
-
dotnet tool restore
62
-
```
141
+
63
142
64
-
> [!NOTE]
65
-
> If you ever change the version of the tools or want to upgrade them by editing the `dotnet-tools.json` configuration, you MUST run this command again to update the tools.
143
+
Enable it and click "Save".
144
+
145
+
If even after that change a Content Builder project doesn't get executed, you can completely disable ReSharper build under the same section:
146
+
147
+
148
+
149
+
Don't forget to save changes.
150
+
151
+
#### Issues with compiling MGFX effects under Linux
152
+
153
+
You might need to add the `MGFXC_WINE_PATH` environment variable to `/etc/environment` for it to be picked up. See [5777151094034-Rider-cannot-see-all-Environmental-Variables](https://rider-support.jetbrains.com/hc/en-us/community/posts/5777151094034-Rider-cannot-see-all-Environmental-Variables) for details.
0 commit comments