Skip to content

Commit

Permalink
Fix links for NuGet readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AristurtleDev authored Jan 4, 2024
1 parent b2a27aa commit 9a8eac9
Showing 1 changed file with 40 additions and 21 deletions.
61 changes: 40 additions & 21 deletions .nuget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,45 +9,64 @@ A Cross Platform C# Library That Adds Support For Aseprite Files in MonoGame Pro

[MonoGame.Aseprite](https://monogameaseprite.net) is a free and open source library for the [MonoGame Framework](https://www.monogame.net) that assists in importing [Aseprite](https://www.aseprite.org) (.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](https://monogameaseprite.net), you can use the Aseprite file directly.

[MonoGame.Aseprite](https://monogameaseprite.net) 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**](https://monogameaseprite.net/docs/processors/processors-overview) have been designed to transform the file contents into a more meaningful state to use within MonoGame.
[MonoGame.Aseprite](https://monogameaseprite.net) 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**](https://monogameaseprite.net/guides/processors/processors-overview.html) have been designed to transform the file contents into a more meaningful state to use within MonoGame.

[MonoGame.Aseprite](https://monogameaseprite.net) 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](https://monogameaseprite.net) library.

## Getting Started
To get started using [MonoGame.Aseprite](https://monogameaseprite.net) start with the [Installation document](https://monogameaseprite.net/docs/getting-started/installation).

To get started using [MonoGame.Aseprite](https://monogameaseprite.net) start with the [Installation document](https://monogameaseprite.net/guides/getting-started/installation.html).

## Features
* Import your Aseprite file at runtime with and without the MGCB Editor (Content Pipeline Tool)
* Multiple built-in [processors](https://monogameaseprite.net/docs/processors/processors-overview) that can be used to transform the data from your Aseprite file into any of the following:
* [Sprite](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Sprites/Sprite/)
* [TextureAtlas](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Sprites/TextureAtlas/)
* [SpriteSheet](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Sprites/SpriteSheet/)
* [Tileset](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Tilemaps/Tileset/)
* [Tilemap](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Tilemaps/Tilemap/)
* [AnimatedTilemap](https://monogameaseprite.net/docs/api/MonoGame.Aseprite/Tilemaps/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.

- Import your Aseprite file at runtime with and without the MGCB Editor (Content Pipeline Tool)
- Multiple built-in [processors](https://monogameaseprite.net/guides/processors/processors-overview.html) that can be used to transform the data from your Aseprite file into any of the following:
- [Sprite](https://monogameaseprite.net/guides/processors/sprite-processor.html)
- [TextureAtlas](https://monogameaseprite.net/guides/processors/texture-atlas-processor.html)
- [SpriteSheet](https://monogameaseprite.net/guides/processors/sprite-sheet-processor.html)
- [Tileset](https://monogameaseprite.net/guides/processors/tileset-processor.html)
- [Tilemap](https://monogameaseprite.net/guides/processors/tilemap-processor.html)
- [AnimatedTilemap](https://monogameaseprite.net/guides/processors/animated-tilemap-processor.html).
- 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](https://monogameaseprite.net/).
- Join the [Discord](https://discord.gg/8jFvHhuMJU) to ask questions or keep up to date.
- Submit an [issue on GitHub](https://github.com/AristurtleDev/monogame-aseprite/issues).
- Follow me on [Mastodon](https://mastodon.gamedev.place/@aristurtle) or [Twitter](https://www.twitter.com/aristurtledev).
- Follow me on [Mastodon](https://mastodon.gamedev.place/@aristurtle) or [Twitter](https://www.twitter.com/aristurtledev).

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

## 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](./CONTRIBUTING.md)).
* [Submit an Issue](https://github.com/AristurtleDev/monogame-aseprite/issues) if you find a problem
* [Star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars) this project on Github.

If you would prefer to send me a tip/donation, you can do so at my [Ko-fi page](https://ko-fi.com/aristurtledev). This is always appreciated and all donations go towards funding projects of mine such as this one.
- Tell others about this project.
- Contribute to this project (Please ensure you read the [Contributing Guide](./CONTRIBUTING.md)).
- [Submit an Issue](https://github.com/AristurtleDev/monogame-aseprite/issues) if you find a problem
- [Star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars) this project on Github.

If you would prefer to send me a tip/donation, you can do so at my [Ko-fi page](https://ko-fi.com/aristurtledev). This is always appreciated and all donations go towards funding projects of mine such as this one.

[![](.github/images/kofi-bg-white.webp)](https://ko-fi.com/aristurtledev)

You can also support me through [GitHub Sponsors](https://github.com/sponsors/AristurtleDev). 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.

[![](.github/images/kofi-bg-white.webp#gh-dark-mode-only)](https://ko-fi.com/aristurtledev)

You can also support me through [GitHub Sponsors](https://github.com/sponsors/AristurtleDev). This and the Ko-Fi links can both be found in the sidebar to the right on this repository page.
* [fdrobidoux](https://github.com/fdrobidoux)
* [Anticdope](https://twitter.com/anticdope)

---

## License

Expand Down

0 comments on commit 9a8eac9

Please sign in to comment.