MonoGame.Aseprite 5.1.3-beta-3

A Cross Platform C# Library That Adds Support For Aseprite Files in MonoGame Projects.

MonoGame.Aseprite is a free and open source library for the MonoGame Framework that assists in importing Aseprite (.ase | .aseprite) files into your game project. No need to export a spritesheet from Aseprite and have to deal with a PNG + JSON file. With MonoGame.Aseprite, you can use the Aseprite file directly.

MonoGame.Aseprite supports importing the file both with and without the MGCB Editor (also known as the Content Pipeline Tool). Along with importing the file contents, several processors have been designed to transform the file contents into a more meaningful state to use within MonoGame.

MonoGame.Aseprite also supports outputting the processed file content to disk in a binary format and reader classes to read the processed information back in. This adds support for pre-processing content using any build or content workflow the end user has as long as it can use the MonoGame.Aseprite library.

Getting Started

To get started using MonoGame.Aseprite start with the Installation document.

Features

• Import your Aseprite file at runtime with and without the MGCB Editor (Content Pipeline Tool)
• Multiple built-in processors that can be used to transform the data from your Aseprite file into any of the following:
  • Sprite
  • TextureAtlas
  • SpriteSheet
  • Tileset
  • Tilemap
  • AnimatedTilemap.
• All blend modes in Aseprite supported 1:1.
• Runtime writers and readers that can be used in custom content processing workflows to preprocess content outside of the game.

What Next?

• Read the documentation.
• Join the Discord to ask questions or keep up to date.
• Submit an issue on GitHub.
• Follow me on Mastodon or Twitter.

Games Made With MonoGame.Aseprite

The following are games that have been made using MonoGame.Aseprite as part of the content workflow in MonoGame

Support

If you would like to support this project in any way, there are quite a few ways to do this no matter who you are.

• Tell others about this project.
• Contribute to this project (Please ensure you read the Contributing Guide).
• Submit an Issue if you find a problem
• Star this project on Github.

If you would prefer to send me a tip/donation, you can do so at my Ko-fi page. This is always appreciated and all donations go towards funding projects of mine such as this one.

You can also support me through GitHub Sponsors. This and the Ko-Fi links can both be found in the sidebar to the right on this repository page.

The following is a list of amazing people that have donated to sponsor this project. If you have donated but weren't added to the list, please get in contact with me.

• fdrobidoux
• Anticdope

License

Copyright(c) 2018-2023 Chris Whitley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.