MLEM/Docs/index.md

![The MLEM logo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Banner.png)

**MLEM Library for Extending MonoGame** is an addition to the game framework [MonoGame](https://www.monogame.net/) that provides extension methods, quality of life improvements and additional features like a ui system and easy input handling.

# What next?
- Get it on [NuGet](https://www.nuget.org/packages?q=mlem)
- Get prerelease builds on [BaGet](https://nuget.ellpeck.de)
- See the source code on [GitHub](https://github.com/Ellpeck/MLEM)
- See tutorials and API documentation on [the website](https://mlem.ellpeck.de/)
- Check out [the demos](https://github.com/Ellpeck/MLEM/tree/release/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/release/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/release/Demos.Android)
- See [the changelog](https://mlem.ellpeck.de/CHANGELOG.html) for information on updates

# Made with MLEM
- [A Breath of Spring Air](https://ellpeck.itch.io/a-breath-of-spring-air), a short platformer ([Source](https://git.ellpeck.de/Ellpeck/GreatSpringGameJam))
- [Don't Wake Up](https://ellpeck.itch.io/dont-wake-up), a short puzzle game ([Source](https://github.com/Ellpeck/DontLetGo))
- [Tiny Life](https://tinylifegame.com), an isometric life simulation game ([Modding API](https://github.com/Ellpeck/TinyLifeExampleMod))

If you created a game with the help of MLEM, you can get it added to this list by submitting it on the [issue tracker](https://github.com/Ellpeck/MLEM/issues). If its source is public, other people will be able to use your project as an example, too!

# Gallery
Here are some images that show a couple of MLEM's features.

The [MLEM.Ui](https://mlem.ellpeck.de/articles/ui) demo in action:

![A gif showing various user interface elements from the MLEM.Ui demo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Ui.gif)

MLEM's [text formatting system](https://mlem.ellpeck.de/articles/text_formatting), which is compatible with both MLEM.Ui and regular sprite batch rendering:

![An image showing text with various colors and other formatting](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Formatting.png)

# Friends of MLEM
There are several other NuGet packages and tools that work well in combination with MonoGame and MLEM. Here are some of them:
- [Contentless](https://github.com/Ellpeck/Contentless), a tool that removes the need to add assets to the MonoGame Content Pipeline manually
- [GameBundle](https://github.com/Ellpeck/GameBundle), a tool that packages MonoGame and other .NET Core applications into several distributable formats
- [MonoGame.Extended](https://github.com/craftworkgames/MonoGame.Extended), a package that also provides several additional features for MonoGame
- [Coroutine](https://github.com/Ellpeck/Coroutine), a package that implements Unity-style coroutines for any project
added package readmes 2021-09-24 04:47:39 +02:00			`![The MLEM logo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Banner.png)`
documentation website, I hope? 2020-05-21 01:08:36 +02:00
a small rebranding 2020-09-28 20:53:39 +02:00			`MLEM Library for Extending MonoGame is an addition to the game framework [MonoGame](https://www.monogame.net/) that provides extension methods, quality of life improvements and additional features like a ui system and easy input handling.`
documentation website, I hope? 2020-05-21 01:08:36 +02:00
some nice media improvements 2020-06-21 23:07:49 +02:00			`# What next?`
			`- Get it on [NuGet](https://www.nuget.org/packages?q=mlem)`
			`- Get prerelease builds on [BaGet](https://nuget.ellpeck.de)`
			`- See the source code on [GitHub](https://github.com/Ellpeck/MLEM)`
added package readmes 2021-09-24 04:47:39 +02:00			`- See tutorials and API documentation on [the website](https://mlem.ellpeck.de/)`
			`- Check out [the demos](https://github.com/Ellpeck/MLEM/tree/release/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/release/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/release/Demos.Android)`
			`- See [the changelog](https://mlem.ellpeck.de/CHANGELOG.html) for information on updates`
some nice media improvements 2020-06-21 23:07:49 +02:00
added a "Made with MLEM" section to the readme 2021-03-14 17:27:10 +01:00			`# Made with MLEM`
moved friends to README 2021-03-18 22:13:33 +01:00			`- [A Breath of Spring Air](https://ellpeck.itch.io/a-breath-of-spring-air), a short platformer ([Source](https://git.ellpeck.de/Ellpeck/GreatSpringGameJam))`
added a "Made with MLEM" section to the readme 2021-03-14 17:27:10 +01:00			`- [Don't Wake Up](https://ellpeck.itch.io/dont-wake-up), a short puzzle game ([Source](https://github.com/Ellpeck/DontLetGo))`
			`- [Tiny Life](https://tinylifegame.com), an isometric life simulation game ([Modding API](https://github.com/Ellpeck/TinyLifeExampleMod))`

			`If you created a game with the help of MLEM, you can get it added to this list by submitting it on the [issue tracker](https://github.com/Ellpeck/MLEM/issues). If its source is public, other people will be able to use your project as an example, too!`

some nice media improvements 2020-06-21 23:07:49 +02:00			`# Gallery`
			`Here are some images that show a couple of MLEM's features.`

added alt text and better gallery descriptions to README 2021-07-22 04:40:09 +02:00			`The [MLEM.Ui](https://mlem.ellpeck.de/articles/ui) demo in action:`
some nice media improvements 2020-06-21 23:07:49 +02:00
added package readmes 2021-09-24 04:47:39 +02:00			`![A gif showing various user interface elements from the MLEM.Ui demo](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Ui.gif)`
added alt text and better gallery descriptions to README 2021-07-22 04:40:09 +02:00
			`MLEM's [text formatting system](https://mlem.ellpeck.de/articles/text_formatting), which is compatible with both MLEM.Ui and regular sprite batch rendering:`

added package readmes 2021-09-24 04:47:39 +02:00			`![An image showing text with various colors and other formatting](https://raw.githubusercontent.com/Ellpeck/MLEM/release/Media/Formatting.png)`
moved friends to README 2021-03-18 22:13:33 +01:00
			`# Friends of MLEM`
			`There are several other NuGet packages and tools that work well in combination with MonoGame and MLEM. Here are some of them:`
			`- [Contentless](https://github.com/Ellpeck/Contentless), a tool that removes the need to add assets to the MonoGame Content Pipeline manually`
			`- [GameBundle](https://github.com/Ellpeck/GameBundle), a tool that packages MonoGame and other .NET Core applications into several distributable formats`
			`- [MonoGame.Extended](https://github.com/craftworkgames/MonoGame.Extended), a package that also provides several additional features for MonoGame`
			`- [Coroutine](https://github.com/Ellpeck/Coroutine), a package that implements Unity-style coroutines for any project`