Skip to content

REQUIREMENTS.md

Latest commit

 

History

History
54 lines (33 loc) · 3.42 KB

REQUIREMENTS.md

File metadata and controls

54 lines (33 loc) · 3.42 KB

MonoGame Development Requirements

Depending on the platform that you are targeting, MonoGame has different sets of requirements.

For desktop platforms

MonoGame requires a .NET 8 SDK installation. You can either install it independently, or by selecting the ".NET desketop development" workload when installing Visual Studio 2022 (version 17.8 and up required).

If you are targeting WindowsDX, you are also going to need the DirectX June 2010 runtime for audio and gamepads to work properly.

When it comes to IDE, Visual Studio 2022, Visual Studio Code, and Visual Studio 2022 for Mac are supported (alternatively, you can work directly from the CLI with your code editor of choice). JetBrains Rider should work but isn't officially supported.

Desktop development is possible from any operating system supporting the above mentioned software.

::: info UWP Deprecation The UWP platform is being deprecated as of the 3.8.2 release due to Microsoft reducing/removing support for this deployment mechanism. :::

For mobile platforms

MonoGame requires the dotnet workloads for iOS or Android depending on the target.

In Visual Studio 2022 you can install both by selecting the ".NET Multi-platform App UI Development" workload. For VSCode, Rider or CLI development, you will need to manually install the DotNet SDK and then install the iOS and/or Android workloads using dotnet workload install maui ios android (delete either iOS or ANdroid if you are not intending to use).

MAUI is required for either mobile platform as it includes debugging tools needed for mobile applications.

Visual Studio 2022, VSCode and Rider are supported in those contexts.

Mobile development is not possible from Linux.

For Modern platforms (Vulkan / DX12)

With the addition of the new development platforms, there are additional dependencies required to support these targets, namely:

  • The Vulkan SDK required for using Vulkan targets. (Make sure to run the setup script setup_env.sh on Mac/Linux)
  • The Java SDK, min version 17.
  • DirectX 12 (Windows Only) should be installed by default, you can check here.

Building from Source

If you are intending to build MonoGame from source, there are a few extra build dependencies required:

  • The Premake5 executable, downloaded and added to your machines "Path".

Important

Make sure to download the "Latest" Premake 5 (5.0.0-beta7 at time of writing) as earlier versions of Premake will not work.