MonoGame.Aseprite 3.0.0-prerelease

This is a prerelease version of MonoGame.Aseprite.
There is a newer version of this package available.
See the version list below for details.

Requires NuGet 3.3.0 or higher.

dotnet add package MonoGame.Aseprite --version 3.0.0-prerelease
NuGet\Install-Package MonoGame.Aseprite -Version 3.0.0-prerelease
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MonoGame.Aseprite" Version="3.0.0-prerelease" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MonoGame.Aseprite --version 3.0.0-prerelease
#r "nuget: MonoGame.Aseprite, 3.0.0-prerelease"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MonoGame.Aseprite as a Cake Addin
#addin nuget:?package=MonoGame.Aseprite&version=3.0.0-prerelease&prerelease

// Install MonoGame.Aseprite as a Cake Tool
#tool nuget:?package=MonoGame.Aseprite&version=3.0.0-prerelease&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?

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MonoGame.Aseprite:

Package Downloads
MonoGame.Reload

Hot-reloading for MonoGame

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.0.0 45 3/26/2024
5.1.3 126 3/13/2024
5.1.3-beta-3 134 1/16/2024
5.1.3-beta-2 81 1/12/2024
5.1.3-beta-1 69 1/12/2024
5.1.2 383 12/2/2023
5.1.1 508 9/28/2023
5.1.0 493 8/22/2023
5.0.1 371 3/28/2023
5.0.0 322 3/7/2023
4.0.6 258 3/1/2023
4.0.5 227 2/27/2023
4.0.4 237 2/27/2023
4.0.3 252 2/26/2023
4.0.2 264 2/22/2023
4.0.0 251 2/21/2023
3.1.1 414 11/21/2022
3.1.0 476 8/29/2022
3.0.0-prerelease 183 4/21/2022
2.0.5 579 5/4/2022
2.0.4.1 825 1/25/2021
2.0.3.3 576 12/12/2020
2.0.2-beta 263 12/10/2020
2.0.1-beta 262 12/8/2020
1.2.2 514 10/1/2020
1.1.1 763 4/11/2019
1.1.0 590 4/10/2019
1.0.0 794 9/30/2018

Support for importing Aseprite v1.3 files.  Only resolves issue for importing files, does not add support for new Aseprite features like Tilemaps as they are still in beta.