Skip to main content

clairlune_sprites/
aseprite.rs

1//! The subset of Aseprite's `json-array` export format that we read. Unknown
2//! fields are ignored, since Aseprite adds metadata between versions.
3
4use serde::Deserialize;
5
6#[derive(Deserialize, Clone, Debug)]
7pub struct Export {
8    pub frames: Vec<FrameEntry>,
9    pub meta: Meta,
10}
11
12#[derive(Deserialize, Clone, Debug)]
13pub struct FrameEntry {
14    #[serde(default)]
15    pub filename: String,
16    pub frame: Rect,
17    /// Frame duration in milliseconds.
18    pub duration: u32,
19    #[serde(default)]
20    pub rotated: bool,
21}
22
23#[derive(Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
24pub struct Rect {
25    pub x: u32,
26    pub y: u32,
27    pub w: u32,
28    pub h: u32,
29}
30
31#[derive(Deserialize, Clone, Debug)]
32pub struct Meta {
33    #[serde(default)]
34    pub image: String,
35    #[serde(rename = "frameTags", default)]
36    pub frame_tags: Vec<Tag>,
37    #[serde(default)]
38    pub slices: Vec<Slice>,
39    /// Written by `scripts/export_sprites.py`.
40    #[serde(default)]
41    pub source_sha256: Option<String>,
42}
43
44#[derive(Deserialize, Clone, Debug)]
45pub struct Tag {
46    pub name: String,
47    pub from: usize,
48    pub to: usize,
49    #[serde(default = "forward")]
50    pub direction: String,
51}
52
53fn forward() -> String {
54    "forward".to_string()
55}
56
57#[derive(Deserialize, Clone, Debug)]
58pub struct Slice {
59    pub name: String,
60    pub keys: Vec<SliceKey>,
61}
62
63/// A slice key applies from its frame until the next key.
64#[derive(Deserialize, Clone, Debug)]
65pub struct SliceKey {
66    pub frame: usize,
67    pub bounds: Rect,
68}