Skip to content

Commit

Permalink
Added OpenUPM install description and increased version to 1.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
martinhodler committed Jan 19, 2021
1 parent 3c55963 commit dce15fd
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Expand Up @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.4] - 2021-01-19
### Added
- Dependency for the Unity 2D Sprite in package.json
- Support for OpenUPM

## [1.0.3] - 2020-12-28
### Added
- Support for different import implementations
Expand Down
32 changes: 29 additions & 3 deletions README.md
@@ -1,6 +1,9 @@
# Aseprite-Importer for Unity
![AsepriteImporter Thumbnail](GitHub/AsepriteImporterUnity.png)


[![openupm](https://img.shields.io/npm/v/io.tinu.asepriteimporter?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/io.tinu.asepriteimporter/)

This package helps you importing [.ase files](https://github.com/aseprite/aseprite/blob/master/docs/ase-file-specs.md) from [aseprite](https://www.aseprite.org/). The reader is fully written in C# which reads the compressed binary file and creates spritesheets, sprites and animations out of it.

## Features
Expand All @@ -11,20 +14,43 @@ This package helps you importing [.ase files](https://github.com/aseprite/asepri
* Creates an animation controller
* New tilemap name rule support (row-col)

![Demo GIF of AsepriteImporter](GitHub/aseprite-importer-demo.gif)

![image](https://user-images.githubusercontent.com/22926212/100529665-2cb66480-322d-11eb-82fa-5729572a75d9.png)
![image](https://user-images.githubusercontent.com/22926212/100529680-57a0b880-322d-11eb-8e8a-e0b48ff0495b.png)
![image](https://user-images.githubusercontent.com/22926212/100529693-7e5eef00-322d-11eb-8d46-5c7e03e958ce.png)


## Install
### OpenUPM
#### Unity Package
OpenUPM lets you install packages more easily by providing a downloadable unity package which will setup the package automatically.
You can find the download on the following link:

[![openupm](https://img.shields.io/npm/v/io.tinu.asepriteimporter?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/io.tinu.asepriteimporter/) https://openupm.com/packages/io.tinu.asepriteimporter/


#### CLI
##### Prerequisites
- [Node.js 12](https://nodejs.org/en/)
- [openupm-cli](https://github.com/openupm/openupm-cli#openupm-cli).

See: https://openupm.com/docs/getting-started.html#installing-openupm-cli

##### OpenUPM CLI Install

```sh
# Go to your Unity project directory
cd YOUR_UNITY_PROJECT_DIR

# Install package: io.tinu.asepriteimporter
openupm add io.tinu.asepriteimporter
```
### Unity
* In Unity open the Package Manager (`Window > Package Manager`).
* In the Package Manager click on the Plus-Icon in the top-left and select `Add package from git URL...`
* Enter the URL of this Repository (`https://github.com/martinhodler/unity-aseprite-importer.git`) and press <kbd>Enter</kbd>

![Demo GIF of AsepriteImporter](GitHub/aseprite-importer-demo.gif)


## License

See LICENSE file.
Expand Down
4 changes: 2 additions & 2 deletions package.json
@@ -1,11 +1,11 @@
{
"name": "io.tinu.asepriteimporter",
"displayName": "Aseprite Importer",
"version": "1.0.3",
"version": "1.0.4",
"unity": "2019.2",
"unityRelease": "0a19",
"description": "An aseprite-file importer for unity written in C#, built upon the experimental AssetImporter API.",
"keywords": [ "Experimental", "Importer", "AssetImporter", "Aseprite", "Textures", "Sprites" ],
"keywords": [ "Asset", "Importer", "AssetImporter", "Aseprite", "Textures", "Sprites" ],
"category": "Importers",
"dependencies": {
"com.unity.2d.sprite": "1.0.0"
Expand Down

0 comments on commit dce15fd

Please sign in to comment.