Skip to content

Commit fafac67

Browse files
miritimiriti
committed
2.1.0 - full support for the way palettes are stored in Aseprite 1.3.5
1 parent e0daa19 commit fafac67

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+361
-140
lines changed

‎README.md

+22-23
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# ASE
44

5-
.ase/.aseprite file format reader/writer written in Haxe with no external dependencies.
5+
A `.ase/.aseprite` file format reader/writer written in Haxe with no external dependencies.
66

7-
Implemented following the official [Aseprite File Format (.ase/.aseprite) Specifications](https://github.com/aseprite/aseprite/blob/master/docs/ase-file-specs.md)
7+
Implemented following the official [Aseprite File Format (.ase/.aseprite) Specifications](https://github.com/aseprite/aseprite/blob/master/docs/ase-file-specs.md).
88

9-
Note that this library only provides reading and writing of the Aseprite file format. If you need rendering you will have to implement it yourself or use one of the existing rendering libraries:
9+
Note that this library only provides reading and writing of the Aseprite file format. If you need rendering, you will have to implement it yourself or use one of the existing rendering libraries:
1010

1111
- [OpenFL Aseprite](https://github.com/miriti/openfl-aseprite)
1212
- [heaps-aseprite](https://github.com/AustinEast/heaps-aseprite) by [Austin East](https://github.com/AustinEast)
@@ -20,13 +20,13 @@ Note that this library only provides reading and writing of the Aseprite file fo
2020

2121
### Installation
2222

23-
```
23+
```shell
2424
haxelib install ase
2525
```
2626

2727
### Usage
2828

29-
#### Parsing files
29+
#### Parsing Files
3030

3131
```haxe
3232
import sys.io.File;
@@ -47,16 +47,13 @@ var spriteColorDepth:ColorDepth = ase.colorDepth;
4747
Palette:
4848

4949
```haxe
50-
for(index in ase.palette.firstIndex...ase.palette.lastIndex+1) {
51-
var entry:PaletteEntry = ase.palette.getEntry(index);
52-
53-
var r:Int = entry.r;
54-
var g:Int = entry.g;
55-
var b:Int = entry.b;
56-
var a:Int = entry.a;
50+
for(index => entry in ase.palette.entries) {
51+
trace('Red: ${entry.red}, Green: ${entry.green}, Blue: ${entry.blue}, Alpha: ${entry.alpha}');
5752
58-
var rgbaColor = ase.palette.getRGBA(index);
59-
var argbColor = ase.palette.getARGB(index);
53+
// Alternatively, get the 32-bit integer RGBA or ARGB value
54+
var rgbaColor:Int = ase.palette.getRGBA(index);
55+
var argbColor:Int = ase.palette.getARGB(index);
56+
trace('RGBA: ${StringTools.hex(rgbaColor, 8)}, ARGB: ${StringTools.hex(argbColor, 8)}');
6057
}
6158
```
6259

@@ -66,7 +63,7 @@ Layers:
6663
for(layer in ase.layers) {
6764
var layerName:String = layer.name;
6865
var layerEditable:Bool = layer.editable;
69-
var layerVisible = layer.visible;
66+
var layerVisible:Bool = layer.visible;
7067
}
7168
```
7269

@@ -88,10 +85,9 @@ var celHeight:Int = frame.cel(layerIndex).height;
8885
var celPixelData:Bytes = frame.cel(layerIndex).pixelData;
8986
```
9087

91-
#### Create files
88+
#### Creating Files
9289

9390
```haxe
94-
9591
var spriteWidth:Int = 320;
9692
var spriteHeight:Int = 320;
9793
var colorDepth:ColorDepth = INDEXED;
@@ -105,16 +101,15 @@ var initialPalette:Array<Int> = [
105101
];
106102
107103
var ase = Ase.create(spriteWidth, spriteHeight, colorDepth);
108-
109104
```
110105

111-
Newly created file always comes with one blank frame. To add some content add at least one layer first:
106+
A newly created file always comes with one blank frame. To add some content, add at least one layer first:
112107

113108
```haxe
114109
ase.addLayer('Background');
115110
```
116111

117-
Now to add some pixels to the sprite create a Cel on the first frame and the newly created layer:
112+
Now, to add some pixels to the sprite, create a Cel on the first frame and the newly created layer:
118113

119114
```haxe
120115
var layerIndex:Int = 0;
@@ -139,16 +134,20 @@ cel.fillIndex(0); // Fill the cel with color #0 from the palette
139134
cel.fillColor(0xff00ff00); // Fill the cel with ARGB color (for 32bpp mode)
140135
cel.setPixel(20, 20, 0xff0033aa); // Set ARGB color at x and y
141136
cel.setPixel(20, 20, 4); // Set color index at x and y
142-
cel.setPixelData(bytes, 300, 300); // Set bytes of the pixel data (the size must me equal to width x height x bpp)
137+
cel.setPixelData(bytes, 300, 300); // Set bytes of the pixel data (the size must be equal to width x height x bpp)
143138
```
144139

145-
At any time you can get the file representation as bytes and, for example, store them to a file:
140+
At any time, you can get the file representation as bytes and, for example, store them to a file:
146141

147142
```haxe
148143
var bytes = ase.getBytes();
149144
File.saveBytes('my_aseprite_file.aseprite', bytes);
150145
```
151146

147+
## Contributors
148+
149+
See [https://github.com/miriti/ase/graphs/contributors](https://github.com/miriti/ase/graphs/contributors).
150+
152151
## License
153152

154-
This project is licensed under the MIT License - see the LICENSE.md file for details
153+
This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details.

‎documentation/404.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["all"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
1+
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["all"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2024 &nbsp;</p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>

0 commit comments

Comments
 (0)