amacocian/MonoGame.Extended
1
0
Fork 0
mirror of https://github.com/AlexMacocian/MonoGame.Extended.git synced 2026-07-15 15:09:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Lucas Girouard-Stranks
2020-06-28 16:27:43 -04:00
parent f921a8194a
commit 1e74aaa53b
1 changed files with 12 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -32
View File
@@ -1,20 +1,18 @@
![MonoGame.Extended Logo](https://raw.githubusercontent.com/craftworkgames/MonoGame.Extended/master/Logos/logo-banner-800.png)
![MonoGame.Extended Logo](Logos/logo-banner-800.png)
# MonoGame.Extended
MonoGame.Extended is an extension to the [MonoGame](http://www.monogame.net/) 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.
MonoGame.Extended is a set of utilities (in the form of libraries/tools) to [MonoGame](http://www.monogame.net/) that makes it easier to make games. Choose what you want, the rest stays out of your way. It makes MonoGame more awesome.
It makes MonoGame more awesome.
[![Build Status](https://dev.azure.com/dylanwilson/MonoGame.Extended/_apis/build/status/craftworkgames.MonoGame.Extended?branchName=develop)](https://dev.azure.com/dylanwilson/MonoGame.Extended/_build/latest?definitionId=1&branchName=develop) [![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://docs.monogameextended.net/)
![Build, Test, Deploy](https://github.com/craftworkgames/MonoGame.Extended/workflows/Build,%20Test,%20Deploy/badge.svg) [![Docs](https://img.shields.io/badge/Docs-latest-brightgreen.svg?style=flat)](http://www.monogameextended.net/)
## 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.
The libraries and tools are distributed as NuGet packages. The libraries can be installed into your existing MonoGame project with ease using a NuGet UI or CLI.
For example:
CLI:
Install-Package MonoGame.Extended
dotnet add package MonoGame.Extended
Once you've installed one or more of the main packages you might also want to install the Content Pipeline extensions.
@@ -25,8 +23,8 @@ Alternately, if you want to try the latest and greatest you might want to [build
## Where to next?
- Check out [the demos](https://github.com/craftworkgames/MonoGame.Extended/tree/develop/Source/Demos)
- Join our live [Discord chat](https://discord.gg/xPUEkj9)
- Read the [Documentation](http://docs.monogameextended.net/)
- Join our live [Discord](https://discord.gg/xPUEkj9)
- Read the [Documentation](http://www.monogameextended.net/docs)
- Submit an [issue on GitHub](https://github.com/craftworkgames/MonoGame.Extended/issues)
- Ask a question on [gamedev stack overflow](http://gamedev.stackexchange.com/questions/tagged/monogame-extended)
- Post on our [MonoGame community forum](http://community.monogame.net/category/extended)
@@ -34,21 +32,11 @@ Alternately, if you want to try the latest and greatest you might want to [build
## 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](https://www.nuget.org/packages?q=monogame.extended)
- 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](https://gitversion.readthedocs.io/en/latest/git-branching-strategies/gitflow/)
- We're now using [cake builds](https://cakebuild.net/) so that you can build everything (including the NuGet packages) locally
- We're migrating everything to [.NET Standard!](https://www.patreon.com/posts/one-library-to-18916187)
We're in the process of developing MonoGame.Extended 3.8! Stay tuned.
## 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.
Thanks to all those that support the project on Patreon! You're helping to keep the project alive.
[![image](https://cloud.githubusercontent.com/assets/3201643/17462536/f5608898-5cf3-11e6-8e81-47d6594a8d9c.png)](https://www.patreon.com/craftworkgames)
## Special thanks
@@ -60,22 +48,14 @@ 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
Also thanks to:
- Matthew-Davey for letting us use the [Mercury Particle Engine](https://github.com/Matthew-Davey/mercury-particle-engine).
- John McDonald for [2D XNA Primitives](https://bitbucket.org/C3/2d-xna-primitives/wiki/Home)
- [LibGDX](https://libgdx.badlogicgames.com) for a whole lot of inspiration.
- @prime31 for [Nez](https://github.com/prime31/Nez), which ideas and code bounce back and forth.
- [@prime31](https://github.com/prime31) for [`Nez`](https://github.com/prime31/Nez). Both `MonoGame.Extended` and `Nez` are in communication with each other to share ideas.
- All of our contributors!
## 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](<https://msdn.microsoft.com/en-us/library/ms229002(v=vs.110).aspx>).
## License
MonoGame.Extended is released under the [The MIT License (MIT)](https://github.com/craftworkgames/MonoGame.Extended/blob/master/LICENSE).