Repository files navigation

MonoGame

One framework for creating powerful cross-platform games

Supported Platforms •Resources •Samples •Support and Contributions •Source Code •Helpful Links •License

MonoGame is a simple and powerful .NET framework for creating games for desktop PCs, video game consoles, and mobile devices using the C# programming language. It has been successfully used to create games such asStreets of Rage 4,Carrion,Celeste,Stardew Valley, andmany others.

It is an open-source re-implementation of the discontinuedMicrosoft's XNA Framework.

We support a growing list of platforms across the desktop, mobile, and console space. If there is a platform we do not support, pleasemake a request orcome help us add it.

• Desktop PCs
  • Windows 10 (22H2+) and up (OpenGL¹ & DirectX 10²)
  • Linux³ and up (OpenGL¹)
  • macOS 13 "Ventura" and up (OpenGL¹)
• Mobile/Tablet Devices
  • Android 6 (API 23) and up (OpenGL)
  • iOS/iPadOS 12.2 and up (OpenGL)
• Consoles (for registered developers)
  • PlayStation 4
  • PlayStation 5
  • Xbox (GDKX & XDK)
  • Nintendo Switch 1 & 2

• Getting started →
• "How To" Guides →
• Documentation Hub →
• API Reference →
• Community Tutorials →

Check out the awesomegame samples maintained by the MonoGame team:

Platformer 2D Sample	NeonShooter
Supported on all platforms	Supported on all platforms
ThePlatformer 2D sample is a basic 2D platformer pulled from the original XNA samples and upgraded for MonoGame.	Neon Shooter Is a graphically intensive twin-stick shooter with particle effects and save data from Michael Hoffman

Auto Pong Sample	Ship Game 3D
Supported on all platforms	GL / DX / iOS / Android
A shortsample project showing you how to make the classic game of pong, with generated soundfx, in 300 lines of code.	3D Ship Game (Descent clone) sample, pulled from the XNA archives and updated for MonoGame

If you think you have found a bug or have a feature request, use ourissue tracker. Before opening a new issue, please search to see if your problem has already been reported. Try to be as detailed as possible in your issue reports.

If you need help using MonoGame or have other questions we suggest you post onGitHub discussions page orDiscord server. Please do not use the issue tracker for personal support requests.

If you are interested in contributing fixes or features to MonoGame, please read ourcontributors guide first.

If you would like to help the project by supporting us financially, consider supporting us via a subscription for the price of a monthly coffee.

Money goes towards hosting, new hardware and if enough people subscribe a dedicated developer.

There are several options on ourDonation Page.

The full source code is available here from GitHub:

• Clone the source:git clone --recurse-submodules https://github.com/MonoGame/MonoGame.git (including resursive submodules).
• Set up the submodules:git submodule update --init
• Open the solution for your target platform to build the game framework.
• Open the Tools solution for your development platform to build the pipeline and content tools.

A high level breakdown of the components of the framework:

• The game framework is found inMonoGame.Framework.
• The content pipeline is located inMonoGame.Framework.Content.Pipeline.
• Project templates are inTemplates.
• SeeTests for the framework unit tests.
• SeeTools/Tests for the content pipeline and other tool tests.
• Themgcb is a command line tool for content processing.
• Themgfxc is a command line effect compiler tool.
• Themgcb-editor tool is a GUI frontend for content processing.
• (Preview) TheContent Builder Project is a new console app framework for content processing.

• The official website ismonogame.net.
• Ourissue tracker is on GitHub.
• You canjoin the Discord server and chat live with the core developers and other users.
• Theofficial documentation is on our website.
• Downloadrelease anddevelopment packages.
• Release and Preview releases are also available onNuGet.Org.
• Follow@MonoGameTeam on Twitter/X,BlueSky andMastodon.
• Get premium content onPatreon.

The MonoGame project is under theMicrosoft Public License except for a few portions of the code. See theLICENSE.txt file for more details. Third-party libraries used by MonoGame are under their own licenses. Please refer to those libraries for details on the license they use.