Setup

This page assumes you have an existing MonoGame project. This can be an empty project or an existing game.

Note that as of the time of this writing, only MonoGame Desktop GL projects are supported. If you are working on a different platform, please contact us on discord or file an issue on Github requesting the addition of your project.

Adding Gum Nuget Packages

1. Open your MonoGame project in your preferred IDE.

2. Add the Gum.MonoGame NuGet package

   

   Add Gum.MonoGame NuGet Package to your project

Initializing Gum

1. Open your Game class (usually Game1.cs)

2. Add the following code to your Initialize method: SystemManagers.Default = new SystemManagers(); SystemManagers.Default.Initialize(_graphics.GraphicsDevice, fullInstantiation: true);

3. Add the following to your Update method: SystemManagers.Default.Activity(gameTime.TotalGameTime.TotalSeconds);

4. Add the following to your Draw method after you clear the graphics device: SystemManagers.Default.Draw();

Testing Gum

To test that you have successfully added Gum to the project, add the following code to your Initialize method after SystemManagers.Default.Initialize:

var rectangle = new ColoredRectangleRuntime();
rectangle.Width = 100;
rectangle.Height = 100;
rectangle.Color = Color.White;
rectangle.AddToManagers(SystemManagers.Default, null);

If everything is initialized correctly, you should see a white rectangle at the top-left of the screen.

Downloading the Gum Tool

The Gum tool can be used to create Gum projects which can be loaded into your MonoGame project. To download and run the Gum tool, see the Introduction page.