MonoGame.Aseprite 6.0.0

.NET 6.0
Additional Details

Version 6.0.0 internally used AsepriteDotNet 1.7.0 for parsing. There is a critical bug in this version of AsepriteDotNet that affects how pixels outside the bounds of a frame are processed, which can leak them by accident into the flattened frame.  This is due to how Aseprite stores pixel data for a cel outside the bounds of a frame. If you select part of your image and move the pixels outside of the frame, the pixel data for the cel is still there even though its no longer visible or within the frame bounds. The method originally used to detect this was not sufficient enough, and has been adjusted to explicitly only process pixel data of a cel that is within the bounds of a frame, regardless of the cel size.

There is a newer version of this package available.
See the version list below for details. 
dotnet add package MonoGame.Aseprite --version 6.0.0
NuGet\Install-Package MonoGame.Aseprite -Version 6.0.0
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="6.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add MonoGame.Aseprite --version 6.0.0
#r "nuget: MonoGame.Aseprite, 6.0.0"
#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=6.0.0

// Install MonoGame.Aseprite as a Cake Tool
#tool nuget:?package=MonoGame.Aseprite&version=6.0.0

<h1 align="center"> <img src="https://raw.githubusercontent.com/AristurtleDev/monogame-aseprite/main/.images/banner.png" alt="MonoGame.Aseprite Logo"> <br/> A Cross Platform C# Library That Adds Support For Aseprite Files in MonoGame Projects.

build-and-test NuGet 6.0.0 License: MIT Twitter

</h1>

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

Features

  • MonoGame.Aseprite internally uses AsepriteDotNet to read and parse the aseprite files. This means you get all the features of AsepriteDotNet including
    • Supports Aseprite files using RGBA, Grayscale, and Indexed color modes.
    • Supports all Aseprite layer blend modes.
    • Supports Aseprite tilesets, tilemap layers, and tilemap cels.
  • Provides processors to convert the Aseprite data into common formats including:
    • Sprite
    • SpriteSheet
    • TextureAtlas
    • Tileset
    • Tilemap
    • AnimatedTilemap

Installation

Install via NuGet

dotnet add package MonoGame.Aseprite --version 6.0.0

Usage

Please refer to the Examples directory for samples of how to use this library. Each example is thoroughly commented with information to show you how to load the Aseprite file and use it within Monogame.

What Next?

Games Made With MonoGame.Aseprite

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

Game Developer Links
<h3 align="center">Superstar Strategy</h3> <img src="https://cdn.akamai.steamstatic.com/steam/apps/1756730/header.jpg?t=1696817764"> <ul><li>Steam: <a href="https://store.steampowered.com/app/1756730/Superstar_Strategy/">https://store.steampowered.com/app/1756730/Superstar_Strategy/</a></li><li>Twitter: <a href="https://x.com/TalberonGames">https://x.com/TalberonGames</a></li></ul>
<h3 align="center">Unnamed</h3> <img src="https://img.itch.zone/aW1nLzEzNjQ1MTM5LnBuZw==/original/yOAqCD.png"/> <ul><li>Itch.io: <a href="https://fypur.itch.io/unnamed">https://fypur.itch.io/unnamed</a></li><li>Youtube: <a href="https://youtube.com/c/fypur">https://youtube.com/c/fypur</a></li></ul>

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.

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.

alternate text is missing from this package README image

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.

License

MonoGame.Aseprite is licensed under the MIT License. Please refer to the LICENSE file for full license text.

Contributors

<a href="https://github.com/aristurtledev/monoame-aseprite/graphs/contributors"> <img src="https://contrib.rocks/image?repo=aristurtledev/monogame-aseprite" /> </a>

Made with contrib.rocks.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.3 124 4/2/2024
6.0.2 99 4/2/2024
6.0.1 96 4/2/2024
6.0.0 97 3/26/2024
5.1.3 132 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 420 12/2/2023
5.1.1 527 9/28/2023
5.1.0 498 8/22/2023
5.0.1 374 3/28/2023
5.0.0 328 3/7/2023
4.0.6 265 3/1/2023
4.0.5 233 2/27/2023
4.0.4 243 2/27/2023
4.0.3 258 2/26/2023
4.0.2 270 2/22/2023
4.0.0 255 2/21/2023
3.1.1 420 11/21/2022
3.1.0 478 8/29/2022
3.0.0-prerelease 183 4/21/2022
2.0.5 581 5/4/2022
2.0.4.1 827 1/25/2021
2.0.3.3 578 12/12/2020
2.0.2-beta 263 12/10/2020
2.0.1-beta 262 12/8/2020
1.2.2 516 10/1/2020
1.1.1 768 4/11/2019
1.1.0 592 4/10/2019
1.0.0 796 9/30/2018

Version 5.1.3
           - Added `MonoGame.Aseprite.Configuration`
           -   When set to `false` this will assume frame index gets from the `AsepriteFile` start at index 1 and not 0.
           - Removed `MonoGame.Aserpite.Configuration`
           - Moved `ZeroIndexedFrames` to be property of `AsepriteFile`
           - Added unit testing for `AsepriteFile.ZeroIndexedFrames` functionality
           - Added proper support for new tile rotation introduced in Aseprite 1.3
           - Read Old Palette Chunk for Indexed mode due to Aseprite 1.3.5 file spec change