Files
MonoGame.Extended/README.md
T
2020-04-05 19:32:10 +10:00

5.2 KiB

MonoGame.Extended Logo

MonoGame.Extended

I am currently looking for a new owner of the MonoGame.Extended project. If you're interested in taking full ownership and complete creative control over this repository, related websites and the Patreon page please contact me.

I worked on MonoGame.Extended for nearly 5 years and unfortunately my heart is no longer in it. I've given this decision a lot of thought and I strongly believe handing the project over to someone who will give it the love it deserves will be best for everyone.

A lot of things have changed in my life over the last half a decade. My family, day job and interests are no longer aligned with this project. I will continue to accept pull requests and do my best to find the right fit for the future of MonoGame.Extended.

MonoGame.Extended is an extension to the MonoGame framework that makes it easier to make games. It's a collection of packages designed to let you choose what you want without getting in your way.

It makes MonoGame more awesome.

Build Status Docs

Getting started

The libraries are distributed as NuGet packages and can be installed into your existing MonoGame project using your favorite NuGet Package Manager in Visual Studio, Xamarin Studio, or MonoDevelop.

For example:

Install-Package MonoGame.Extended

Once you've installed one or more of the main packages you might also want to install the Content Pipeline extensions.

To do this you'll need to manually reference the MonoGame.Extended.Content.Pipeline.dll in the MonoGame Content Pipeline Tool because it doesn't support NuGet directly.

Alternately, if you want to try the latest and greatest you might want to build from source.

Where to next?

News

We're in the process of developing MonoGame.Extended 3.6!

There may be some confusion, pain and disruption for a while. Here's what you need to know:

  • Everything that used to be in the develop branch is now in master
  • NuGet packages built from master have been published to nuget.org as version 1.1
  • There's lots of breaking changes happening to create a cleaner more useful API
  • From now on we're going to (attempt) to use Git Flow
  • We're now using cake builds so that you can build everything (including the NuGet packages) locally
  • We're migrating everything to .NET Standard!

Patreon Supporters

Thanks to all those that support the project on Patreon! You're helping to keep the build server up and running allowing me to devote more of my time to the project.

image

Special thanks

As a reward to some of my patrons I've linked thier websites here:

If you're not on the list and you should be please let me know!

Also thanks to

Design goals

  • The primary goal is to make it easier to make games.
  • Choose the features you like and the rest stays out of your way.
  • A clean and consistent API familiar to MonoGame developers.
  • It's not a game engine, but extends the framework.
  • Follow C# coding guidelines.

License

MonoGame.Extended is released under the The MIT License (MIT).