rider-monogame
rider-monogame copied to clipboard
MonoGame plugin for JetBrains Rider
MonoGame plugin for JetBrains Rider

This plugin improves MonoGame usage experience inside JetBrains Rider.
MGCB file editing
Autocomplete and syntax highlighting
All supported MGCB options properly highlighted and could be autocompleted
Build entries previewer
See all your assets in a realtime tree view according to their declarations
Table view for a build entry properties
Review build entry properties and processor parameters in a table representation
Open in external MGCB editor action
Jump to external MGCB editor GUI in one clickOther
Additional file templates
Easily create MonoGame related assets using file templates under Add menu
How to install
Using marketplace:
For EAP users: you should add
https://plugins.jetbrains.com/plugins/eap/list
to your plugin repositories list before installing
- Go to
Settings
/Plugins
/Marketplace
- Search for "MonoGame"
- Click
Install
, thenSave
- After saving restart Rider
Using .zip
file
- Go to Releases
- Download the latest release of plugin for your edition of JetBrains Rider (Stable or EAP)
- Proceed to
Settings
/Plugins
/⚙
/Install plugin from disk
- Click
Save
- After saving restart Rider
How to use
Just open .mgcb file for editing. Previewer will be on the right side of the editor.
Additional file templates are located under Add section of a folder or project context menu.
Requirements
-
JetBrains Rider 2022.3+
-
Project with MonoGame installed (3.8+ is recommended)
Note: Projects with older versions of MonoGame might work, but with issues
Development
Note: You should have JDK 11 and .NET SDK 5.0+ installed and configured.
Preparing
./gradlew rdgen
- generates RD protocol data for plugin internal communication
Building plugin parts
-
for stable version of Rider:
./gradlew buildPlugin
-
for EAP version of Rider:
./gradlew buildPlugin -PRiderSdkVersion=2022.3.0-eap01 -PProductVersion=2022.3-EAP1-SNAPSHOT
It will build both frontend and backend parts.
Running
Next command will start instance of JetBrains Rider with plugin attached to it:
./gradlew runIde
Contributing
Contributions are welcome! 🎉
It's better to create an issue with description of your bug/feature before creating pull requests.
About branching
This project uses customized git strategy.
Each release/*
branch plays main development branch role for specific release.
For example, release/222
means that branch is related to 222.*
release cycle for 2022.2
Rider version.
See also
- Marketplace page
- Changelog