MonoGame.Aseprite 5.0.0

This package has been deprecated as it is legacy and is no longer maintained.

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

dotnet add package MonoGame.Aseprite --version 5.0.0

NuGet\Install-Package MonoGame.Aseprite -Version 5.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="5.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add MonoGame.Aseprite --version 5.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: MonoGame.Aseprite, 5.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=5.0.0

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

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.

License

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	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 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

NuGet packages (1)

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

Package	Downloads
MonoGame.Reload Hot-reloading for MonoGame	2.5K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
6.1.0	232	9/27/2024
6.0.7	287	8/19/2024
6.0.6	200	7/16/2024
6.0.5	234	5/31/2024
6.0.4	128	5/2/2024
6.0.3	179	4/2/2024
6.0.2	165	4/2/2024
6.0.1	119	4/2/2024
6.0.0	140	3/26/2024
5.1.3	178	3/13/2024
5.1.3-beta-3	193	1/16/2024
5.1.3-beta-2	131	1/12/2024
5.1.3-beta-1	117	1/12/2024
5.1.2	621	12/2/2023
5.1.1	642	9/28/2023
5.1.0	550	8/22/2023
5.0.1	419	3/28/2023
5.0.0	355	3/7/2023
4.0.6	289	3/1/2023
4.0.5	260	2/27/2023
4.0.4	277	2/27/2023
4.0.3	281	2/26/2023
4.0.2	310	2/22/2023
4.0.0	280	2/21/2023
3.1.1	452	11/21/2022
3.1.0	509	8/29/2022
3.0.0-prerelease	201	4/21/2022
2.0.5	628	5/4/2022
2.0.4.1	886	1/25/2021
2.0.3.3	604	12/12/2020
2.0.2-beta	295	12/10/2020
2.0.1-beta	302	12/8/2020
1.2.2	560	10/1/2020
1.1.1	830	4/11/2019
1.1.0	631	4/10/2019
1.0.0	838	9/30/2018

Version 5.0.0
           The following changes were implemented:
               - Resolved issue where reversing an `AnimatedSprite` would cause an exception.
               - Added `AsepriteFileReader.Read(Stream)` method to support reading Aseprite file with `TitleContainer` stream (Closes #49)
               - Added new processors for the mgcb-editor when pre-processing content using the mgcb-editor. These include:
                   - Sprite Processor
                   - SpriteSheet Processor
                   - TextureAtlas Processor
                   - Tileset Processor
                   - Tilemap Processor
                   - AnimatedTileMap Processor
               - Support for Aseprite 1.3-rc1
                   - Support for User Data for Tiles added
                       - Tile User Data can only be set in Aseprite through the LUA Scripting API at this time.
                   - Support for new tag "Repeat" field added.
                   - Support for new `PingPongReverse` loop direction added.
                   - `Animatedsprite` instances are no longer coupled to the `AnimationTag` used to create them. The `AnimationTag` now is only used to create the `AnimatedSprite` and after creation, properties such as `AnimatedSprite.IsReversed` affect only that instance.
                   - `AnimatedSprite.Speed` property added to control rate of animation speed
                   - `AnimatedSprite.Play()` added.
                       - `AnimatedSprite` will need to be explicitly told to play using the `AnimatedSprite.Play` method.
                       - Parameter for method provided to override the loop count