mirror of
https://github.com/AlexMacocian/MonoGame.Extended.git
synced 2026-07-21 01:39:32 +00:00
Lucas Girouard-Stranks
61 lines
3.6 KiB
Markdown
61 lines
3.6 KiB
Markdown
> :warning: **If you are interested in helping out with the future and direction of this project**: Please direct message @lithiumtoast on Discord.
|
|
|
|
|
|
|
|
# MonoGame.Extended
|
|
|
|
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.
|
|
|
|
[](https://github.com/craftworkgames/MonoGame.Extended/actions?query=workflow%3A%22Build%2C+Test%2C+Deploy%22) [](http://www.monogameextended.net/)
|
|
|
|
## Getting started
|
|
|
|
Code is distributed as NuGet packages in the form of libraries (`.dll` files). You can easily install the NuGet packages into your existing MonoGame project using the NuGet Package Manager UI in Visual Studio or by using the command line interface (CLI) in a terminal.
|
|
|
|
> :wrench: CLI
|
|
`dotnet add package MonoGame.Extended`
|
|
|
|
> :hammer: To use the content pipeline extensions, you will need to edit your `.mgcb` file to reference the `.dll`. To see an example of how to do this with NuGet see the samples at https://github.com/craftworkgames/MonoGame.Extended-samples. The important pieces are the `NuGet.config` file and the `.mgcb` file.
|
|
|
|
> :eyes: To access pre-releases including rolling builds of the repository after every commit or PR commit, you can see add the NuGet feed `https://www.myget.org/F/lithiumtoast/api/v3/index.json`. See https://github.com/craftworkgames/MonoGame.Extended-samples with the `NuGet.config` file for an example of how to setup the feed.
|
|
|
|
## Where to next?
|
|
|
|
- Check out [the samples](https://github.com/craftworkgames/MonoGame.Extended-samples)
|
|
- 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)
|
|
- Follow development [on Patreon](https://www.patreon.com/craftworkgames)
|
|
|
|
## News
|
|
|
|
We're in the process of developing MonoGame.Extended 4.0! Stay tuned.
|
|
|
|
## Patreon Supporters
|
|
|
|
Thanks to all those that support the project on Patreon! You're helping to keep the project alive.
|
|
[](https://www.patreon.com/craftworkgames)
|
|
|
|
## Special thanks
|
|
|
|
As a reward to some of my patrons I've linked thier websites here:
|
|
|
|
- [PRT Studios](http://prt-studios.com/)
|
|
- [optimuspi](http://www.optimuspi.com/)
|
|
|
|
If you're not on the list and you should be please let me know!
|
|
|
|
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](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!
|
|
|
|
## License
|
|
|
|
MonoGame.Extended is released under the [The MIT License (MIT)](https://github.com/craftworkgames/MonoGame.Extended/blob/master/LICENSE).
|