MonoGame.Aseprite 1.1.0

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

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

MonoGame.Aseprite

MonoGame.Aseprite is an extension for MonoGame Framework to import the .json file produced by Aseprite using the content pipeline, with a collection of classes to support rending the animation.

alternate text is missing from this package README image

Getting Started

MonoGame.Aseprite is distributed via NuGet as a NuGet package. It can be installed inot your existing MonOGame project using NuGet Package Manger in Visual Studio. You can also use the following commands to install it.

Package Manager
PM> Install-Package MonoGame.Aseprite -Version 1.1.0

.Net CLI
> dotnet add package MonoGame.Aseprite --version 1.1.0

Once you've added the NuGet package, you'll also need to add a reference to MonoGame.Aseprite.ContentPipeline.dll in the Content Pipeline Tool. This file can be found in the "/packages/MonoGame.Aseprite.1.0.0/content" folder in the root directory of your project folder after installing the NuGet package.

For more information on doing this, check out this wiki page

Usage

The following is a brief explination of how to use this in your MonoGame project. For a more detailed explination, including images, please check the wiki

  • Export your spritesheet from Aseprite

    • Select Array for meta information not Hash
    • Frame Tags must be checked
    • Slices must be checked
    • Trim and Padding is currently not supported. These must be unchecked.
  • Add the exported spritesheet and associated .json file from Aseprite to your project using the MonoGame Pipeline Tool

    • The spritesheet can be imported normally using the Texture importer and processor
    • For the .json file, use the Aseprite Animation Importer and the Aseprite Animation Processor
  • Create a new AnimatedSprite object using the spritesheet and the animation definition.

    • The animation defintion is loaded in your game using the content manger. It loads the .json file you imported.
    //  Be sure to add the using statement at the top
    using MonoGame.Aseprite;
    
    ...
    
    //  Load the .json file
    AnimationDefinition animationDefinition = content.Load<AnimationDefinition>("animationDefinition");
    
    //  Load the sprite sheet
    Texture2D spritesheet = content.load<Texture2D>("spritesheet");
    
    //  Create the AnimatedSprite based on the animation definition and the sprite sheet
    AnimatedSprite animatedSprite = new AnimatedSprite(spriteSheet, animationDefinition);
    

What Next?

License

Copyright(c) 2018 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.5

    • 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.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.2 is deprecated because it has critical bugs.
6.0.1 119 4/2/2024 6.0.1 is deprecated because it has critical bugs.
6.0.0 140 3/26/2024 6.0.0 is deprecated because it has critical bugs.
5.1.3 178 3/13/2024
5.1.3-beta-3 193 1/16/2024 5.1.3-beta-3 is deprecated because it is no longer maintained.
5.1.3-beta-2 131 1/12/2024 5.1.3-beta-2 is deprecated because it is no longer maintained.
5.1.3-beta-1 117 1/12/2024 5.1.3-beta-1 is deprecated because it is no longer maintained.
5.1.2 621 12/2/2023 5.1.2 is deprecated because it is no longer maintained.
5.1.1 642 9/28/2023 5.1.1 is deprecated because it is no longer maintained.
5.1.0 550 8/22/2023 5.1.0 is deprecated because it is no longer maintained.
5.0.1 419 3/28/2023 5.0.1 is deprecated because it is no longer maintained.
5.0.0 355 3/7/2023 5.0.0 is deprecated because it is no longer maintained.
4.0.6 289 3/1/2023 4.0.6 is deprecated because it is no longer maintained.
4.0.5 260 2/27/2023 4.0.5 is deprecated because it is no longer maintained.
4.0.4 277 2/27/2023 4.0.4 is deprecated because it is no longer maintained.
4.0.3 281 2/26/2023 4.0.3 is deprecated because it is no longer maintained.
4.0.2 310 2/22/2023 4.0.2 is deprecated because it is no longer maintained.
4.0.0 280 2/21/2023 4.0.0 is deprecated because it is no longer maintained.
3.1.1 452 11/21/2022 3.1.1 is deprecated because it is no longer maintained.
3.1.0 509 8/29/2022 3.1.0 is deprecated because it is no longer maintained.
3.0.0-prerelease 201 4/21/2022 3.0.0-prerelease is deprecated because it is no longer maintained.
2.0.5 628 5/4/2022 2.0.5 is deprecated because it is no longer maintained.
2.0.4.1 886 1/25/2021 2.0.4.1 is deprecated because it is no longer maintained.
2.0.3.3 604 12/12/2020 2.0.3.3 is deprecated because it is no longer maintained.
2.0.2-beta 295 12/10/2020 2.0.2-beta is deprecated because it is no longer maintained.
2.0.1-beta 302 12/8/2020 2.0.1-beta is deprecated because it is no longer maintained.
1.2.2 560 10/1/2020 1.2.2 is deprecated because it is no longer maintained.
1.1.1 830 4/11/2019 1.1.1 is deprecated because it is no longer maintained.
1.1.0 631 4/10/2019 1.1.0 is deprecated because it is no longer maintained.
1.0.0 838 9/30/2018 1.0.0 is deprecated because it is no longer maintained.