syntaxdz/monogame

One framework for creating powerful cross-platform games.

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.

• Build Status
• Supported Platforms
• Support and Contributions
• Source Code
• Helpful Links
• License

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, and Android
Build Mac, iOS, and Linux
Generate Documentation
Windows Tests
Package NuGet
Package Mac and Linux
Package Windows

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 10 Store Apps (UWP)
  • Windows Win32 (OpenGL & DirectX)
  • Linux (OpenGL)
  • Mac OS X (OpenGL)
• Mobile/Tablet Devices
  • Android (OpenGL)
  • iPhone/iPad (OpenGL)
  • Windows Phone 10 (UWP)
• Consoles (for registered developers)
  • PlayStation 4
  • PlayStation Vita
  • Xbox One (both UWP and XDK)
  • Nintendo Switch
• Other
  • tvOS (OpenGL)

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/MonoGame/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:

• The game framework is found in MonoGame.Framework.
• The content pipeline is located in MonoGame.Framework.Content.Pipeline.
• The MonoDevelop addin is in IDE/MonoDevelop.
• The Visual Studio templates are in ProjectTemplates.
• NuGet packages are located in NuGetPackages.
• See Test for the pipeline and framework unit tests.
• Tools/MGCB is the command line tool for content processing.
• Tools/2MGFX is the command line effect compiler tool.
• The Tools/Pipeline tool is a GUI frontend for content processing.

Helpful Links

• The official website is monogame.net.
• Our issue tracker is on GitHub.
• Use our community forums for support questions.
• You can chat live with the core developers and other users.
• The official documentation is on our website.
• Download release and development installers and packages.
• Follow @MonoGameTeam on Twitter.

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.