MonoGame.Aseprite 3.0.0-prerelease

PLEASE READ

This version of MonoGame.Aseprite is a prerelease version. This version (v3.0.0.0-prerelease-1) resolves an issue when importing an Aseprite file made with Aseprite version 1.3 which is currently in beta.

This is not backwards compatible with Aseprite 1.2 files. If you are still using Aseprite version 1.2, please install the MonoGame Aseprite version 2.0.4.1 NuGet package instead.

MonoGame.Aseprite

MonoGame.Aseprite is an extension for the MonoGame Framework that allows you to import Aseprite .ase/.aseprite files into your game project using the MGCB Editor (also known as the Content Pipeline Tool).

No need to export a sprite sheet from Aseprite and have to deal with a PNG image file and a JSON file. With MonoGame.Aseprite the import process takes the single Aseprite file and generates a AsepriteDocument object, containing a Texture2D generated sprite sheet and all the data you need to animate those sweet pixels in game.

MonoGame.Aseprite also provides an out-of-the-box AnimatedSprite class that can be used with the imported AsepriteDocument to get you started quickly if you prefer this as well.

Getting Started

MonoGame.Aseprite is distributed via NuGet as a NuGet package. It can be installed into your existing MonoGame game project using NuGet Package Manger in Visual Studio.

For MonoGame 3.7.1 (.NET Framework >= 4.5) users, please refer to the installation documentation at https://aristurtle.net/monogame-aseprite/getting-started/monogame37installation

For MonoGame 3.8 (.NET Core) users, please refer to the installation documentation at https://aristurtle.net/monogame-aseprite/getting-started/monogame38installation

Example Usage

The following is a quick example of using MonoGame.Aseprite in your game.

Add Using Statements

using MonoGame.Aseprite.Documents;
using MonoGame.Aseprite.Graphics;

Load the Content

//  Load the AsepriteDocument
AsepriteDocument aseDoc = Content.Load<AsepriteDocument>("myAseFile");

//  Create a new AnimatedSprite from the document
AnimatedSprite sprite = new AnimatedSprite(aseDoc);

Update the AnimatedSprite Instance

sprite.Update(gameTime);

Drawing the AnimatedSprite

sprite.Render(spriteBatch);

What Next?

• Read the documentation at https://aristurtle.net/monogame-aseprite.
• Join the Discord at https://discord.gg/8jFvHhuMJU to ask questions or keep up to date.
• Submit an issue on GitHub at https://github.com/manbeardgames/monogame-aseprite/issues.
• Follow me on Twitter @manbeardgames https://www.twitter.com/aristurtledev.

GitHub Sponsers Support

Hi, my name is Christopher Whitley. I am an indie game developer and game development tool developer. I create tools primary for the MonoGame framework. All of the tools I develop are released as free and open-sourced software (FOSS), just like this Monogame.Aseprite library.

If you'd like to buy me a cup of coffee or just sponsor me and my projects in general, you can do so on GitHub Sponsors at https://github.com/sponsors/manbeardgames

License

Copyright(c) 2022 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.