Skip to content
One framework for creating powerful cross-platform games.
C# HLSL Smalltalk XSLT NSIS Shell
Find file
Pull request Compare This branch is 71 commits behind mono:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
Build
Documentation
IDE/MonoDevelop
Installers
MonoGame.Framework.Content.Pipeline
MonoGame.Framework
NuGetPackages
ProjectTemplates
Test
ThirdParty
Tools
.editorconfig
.gitignore
.gitmodules
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
Protobuild.exe
README.md
REQUIREMENTS.md
default.build

README.md

MonoGame

One framework for creating powerful cross-platform games. The spiritual successor to XNA with 1000's of titles shipped across desktop, mobile, and console platforms. MonoGame is a fully managed .NET open source game framework without any black boxes. Create, develop and distribute your games your way.

Join the chat at https://gitter.im/mono/MonoGame

Build Status

Our build server builds, tests, and packages the latest MonoGame changes. The table below shows the current build status for the develop branch.

Name Status
Build Windows, Web, Android, and OUYA Build Status
Build Mac, iOS, and Linux Build Status
Generate Documentation Build Status
Windows Tests Build Status
Package NuGet Build Status
Package Mac and Linux Build Status
Package Windows Build Status

Supported Platforms

We support a growing list of platforms across the desktop, mobile, and console space. If there is a platform we don't support, please make a request or come help us add it.

  • Desktop PCs
    • Windows Store Apps (8, 8.1 and 10)
    • Windows (OpenGL & DirectX)
    • Linux (OpenGL)
    • Mac OS X (OpenGL)
  • Mobile Devices
    • Android (OpenGL)
    • iOS (OpenGL)
    • Windows Phone (8, 8.1 and 10)
  • Consoles (for registered developers)
    • PlayStation 4
    • PlayStation Vita
    • Xbox One (both UWP and XDK)
    • OUYA

Support and Contributions

If you think you have found a bug or have a feature request, use our issue 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 on our community forums. Please do not use the GitHub issue tracker for personal support requests.

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

Source Code

The full source code is available here from GitHub:

  • Clone the source: git clone https://github.com/mono/MonoGame.git
  • Setup the submodules: git submodule update --init
  • Run Protobuild.exe to generate project files and solutions.
    • If on Linux or Mac, run it with mono: mono Protobuild.exe
  • You can generate solutions for platforms that are not buildable from the current OS with:
    • Windows: .\Protobuild.exe --generate $PLATFORM
    • Linux or Mac: mono Protobuild.exe --generate $PLATFORM
  • Open the solution for your target platform to build the game framework.
  • Open the solution for your development platform for building the pipeline and content tools.

For the prerequisites for building from source please look at the Requirements file.

A high level breakdown of the components of the framework:

Helpful Links

License

The MonoGame project is under the Microsoft Public License except for a few portions of the code. See the LICENSE.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.

Something went wrong with that request. Please try again.