skel-mesh-parser 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- skel_mesh_parser-0.3.0/.github/workflows/ci.yml +38 -0
- skel_mesh_parser-0.3.0/.gitignore +8 -0
- skel_mesh_parser-0.3.0/LICENSE +202 -0
- skel_mesh_parser-0.3.0/PKG-INFO +99 -0
- skel_mesh_parser-0.3.0/README.md +89 -0
- skel_mesh_parser-0.3.0/THIRD_PARTY_NOTICES.md +31 -0
- skel_mesh_parser-0.3.0/pyproject.toml +31 -0
- skel_mesh_parser-0.3.0/skel_mesh_parser/__init__.py +39 -0
- skel_mesh_parser-0.3.0/skel_mesh_parser/binary_reader.py +152 -0
- skel_mesh_parser-0.3.0/skel_mesh_parser/detect_version.py +51 -0
- skel_mesh_parser-0.3.0/skel_mesh_parser/read_skeleton_38.py +245 -0
- skel_mesh_parser-0.3.0/skel_mesh_parser/read_skeleton_42.py +289 -0
- skel_mesh_parser-0.3.0/tests/__init__.py +0 -0
- skel_mesh_parser-0.3.0/tests/fixtures/synthetic-skeleton-38.skel +0 -0
- skel_mesh_parser-0.3.0/tests/fixtures/synthetic-skeleton-42.skel +0 -0
- skel_mesh_parser-0.3.0/tests/integration/__init__.py +0 -0
- skel_mesh_parser-0.3.0/tests/integration/test_goblins_38.py +67 -0
- skel_mesh_parser-0.3.0/tests/spine_fixture.py +115 -0
- skel_mesh_parser-0.3.0/tests/test_binary_reader.py +122 -0
- skel_mesh_parser-0.3.0/tests/test_detect_version.py +38 -0
- skel_mesh_parser-0.3.0/tests/test_init_parse_skeleton.py +26 -0
- skel_mesh_parser-0.3.0/tests/test_read_skeleton_38.py +32 -0
- skel_mesh_parser-0.3.0/tests/test_read_skeleton_42.py +25 -0
- skel_mesh_parser-0.3.0/tests/test_spine_fixture.py +90 -0
- skel_mesh_parser-0.3.0/uv.lock +79 -0
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
# Offline tests only: no Spine assets, no network.
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
matrix:
|
|
13
|
+
python: ["3.11", "3.12", "3.13"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- uses: actions/setup-python@v5
|
|
17
|
+
with:
|
|
18
|
+
python-version: ${{ matrix.python }}
|
|
19
|
+
- run: pip install pytest .
|
|
20
|
+
- run: python -m pytest
|
|
21
|
+
|
|
22
|
+
# Needs the official Spine example asset (downloaded on demand, SHA-256
|
|
23
|
+
# verified). Kept separate so an external outage cannot fail the offline job.
|
|
24
|
+
integration:
|
|
25
|
+
runs-on: ubuntu-latest
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@v4
|
|
28
|
+
- uses: actions/setup-python@v5
|
|
29
|
+
with:
|
|
30
|
+
python-version: "3.12"
|
|
31
|
+
- uses: actions/cache@v4
|
|
32
|
+
with:
|
|
33
|
+
path: .cache/spine
|
|
34
|
+
key: spine-goblins-pro-skel-7941a9cf
|
|
35
|
+
- run: pip install pytest .
|
|
36
|
+
- run: python -m pytest -m integration
|
|
37
|
+
env:
|
|
38
|
+
SPINE_FIXTURE_REQUIRED: "1"
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 com55
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: skel-mesh-parser
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Minimal dependency-free parser for the skin/attachment section of Spine skeleton binary files (.skel, 3.8.x and 4.2.x). Python port of the js branch's spine-skeleton-binary-js.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
License-File: THIRD_PARTY_NOTICES.md
|
|
8
|
+
Requires-Python: >=3.11
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
|
|
11
|
+
# skel-mesh-parser (Python)
|
|
12
|
+
|
|
13
|
+
Python port of this repo's `js` branch (`spine-skeleton-binary-js`): a
|
|
14
|
+
minimal, dependency-free parser for the skin/attachment section of Spine
|
|
15
|
+
skeleton binary files (`.skel`) that returns, per attachment, its raw type
|
|
16
|
+
and — for `Mesh`-type attachments — the `uvs`/`triangles` needed to build a
|
|
17
|
+
texture-space silhouette. It is **not** a Spine runtime: no rendering, no
|
|
18
|
+
animation, no timelines, IK, physics, or constraint solving. Supports Spine
|
|
19
|
+
versions **3.8.x and 4.2.x only** (anything else raises
|
|
20
|
+
`UnsupportedVersionError`).
|
|
21
|
+
|
|
22
|
+
**Status:** implemented — `parse_skeleton` is wired up for both 3.8.x and
|
|
23
|
+
4.2.x. It is a field-for-field port of the `js` branch's reader and has been
|
|
24
|
+
validated against the official Spine 3.8 `goblins-pro.skel` example (see
|
|
25
|
+
[Testing](#testing)).
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
```python
|
|
30
|
+
from skel_mesh_parser import parse_skeleton
|
|
31
|
+
|
|
32
|
+
data = open("some.skel", "rb").read()
|
|
33
|
+
result = parse_skeleton(data)
|
|
34
|
+
|
|
35
|
+
# result["version"]: {"major": int, "minor": int, "patch": int, "raw": str}
|
|
36
|
+
# result["attachments"]: dict[str, AttachmentInfo], keyed by the
|
|
37
|
+
# attachment's resolved path (the atlas region name it draws from)
|
|
38
|
+
|
|
39
|
+
info = result["attachments"]["some_region_name"]
|
|
40
|
+
# info["type"]: "Region" | "BoundingBox" | "Mesh" | "LinkedMesh" | "Path" | "Point" | "Clipping"
|
|
41
|
+
# info["uvs"] / info["triangles"] / info["hull_length"]: present ONLY when
|
|
42
|
+
# info["type"] == "Mesh" (hull_length is the js branch's `hullLength`: the
|
|
43
|
+
# number of outline vertices, i.e. the first hull_length UV pairs)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Scope, by design (same as the `js` branch):**
|
|
47
|
+
- Default skin only. Non-default skins are walked (to keep the byte stream
|
|
48
|
+
aligned) but not returned.
|
|
49
|
+
- `Mesh`-type attachments only carry `uvs`/`triangles`/`hull_length`.
|
|
50
|
+
- `LinkedMesh` is reported as its own distinct type, never confused with
|
|
51
|
+
`Mesh`.
|
|
52
|
+
- On an attachment-path collision within the same skin, the `Mesh` entry
|
|
53
|
+
always wins, deterministically, regardless of wire order.
|
|
54
|
+
|
|
55
|
+
## Versions and tags
|
|
56
|
+
|
|
57
|
+
The two branches are released independently, each with its own version
|
|
58
|
+
numbers and tag prefix:
|
|
59
|
+
|
|
60
|
+
- `py-vX.Y.Z` — this `python` branch (the version in `pyproject.toml`).
|
|
61
|
+
- `js-vX.Y.Z` — the `js` branch (`spine-skeleton-binary-js`).
|
|
62
|
+
|
|
63
|
+
Older unprefixed tags (`v1.0.0`, `v1.1.0`) belong to the `js` branch.
|
|
64
|
+
To depend on a fixed release, pin the tag rather than the branch, e.g.
|
|
65
|
+
`skel-mesh-parser @ git+https://github.com/com55/skel-mesh-parser.git@py-v0.3.0`.
|
|
66
|
+
|
|
67
|
+
## Testing
|
|
68
|
+
|
|
69
|
+
```sh
|
|
70
|
+
python -m pytest # all normal tests — offline, no Spine assets needed
|
|
71
|
+
python -m pytest -m integration # needs the official Spine 3.8 example asset (see below)
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
(or `uv run pytest` / `uv run pytest -m integration`)
|
|
75
|
+
|
|
76
|
+
- **Normal tests** use only hand-built binary fixtures created for this repo (`tests/fixtures/`). They never touch the network or any Spine asset.
|
|
77
|
+
- **Integration test** (`tests/integration/`) validates the 3.8 reader against the official Spine example `goblins-pro.skel`, using the same oracle values as the `js` branch. **This repository does not distribute that file** — see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). Instead, `tests/spine_fixture.py` resolves it as follows:
|
|
78
|
+
1. If `SPINE_GOBLINS_SKEL=/path/to/goblins-pro.skel` is set, that file is used (and never downloaded).
|
|
79
|
+
2. Otherwise `.cache/spine/goblins-pro.skel` (gitignored) is reused if present.
|
|
80
|
+
3. Otherwise it is downloaded once from Esoteric Software's official `EsotericSoftware/spine-runtimes` repository, at a **pinned commit** (not a moving branch), and cached.
|
|
81
|
+
- **Checksum verification.** Every source is verified against a pinned SHA-256 (`GOBLINS_SKEL_SHA256`). A mismatch fails the test run; a cached file with the wrong checksum is discarded and re-downloaded. Nothing is written to the cache unless it verified.
|
|
82
|
+
- **Fixture unavailable** (offline, HTTP error): the integration tests are skipped with a message explaining how to supply the file. Set `SPINE_FIXTURE_REQUIRED=1` (as CI does) to fail instead of skip.
|
|
83
|
+
|
|
84
|
+
## Provenance
|
|
85
|
+
|
|
86
|
+
This is a port of the `js` branch's implementation, which was written independently. The official Spine Runtime source was consulted only to verify binary-format behavior and field layout; its source code was not copied or translated into this project. The reference source (`spine-ts`) is licensed under the Spine Runtimes License, which is not a permissive license. This project is not a Spine runtime. See the `js` branch's README and source comments for the exact file/line/commit each field-layout fact was checked against. Pinned commits (branch HEAD at time of writing, 2026-08-28 — re-verify before relying on a moved branch ref):
|
|
87
|
+
- 4.2: `EsotericSoftware/spine-runtimes@b81e5a58ed38704aee4f866f0e0ac672623ce914`, `spine-ts/spine-core/src/SkeletonBinary.ts`
|
|
88
|
+
- 3.8: `EsotericSoftware/spine-runtimes@8b4844bd4b193ba9e54487ed397a777993cbad56`, `spine-ts/core/src/SkeletonBinary.ts`
|
|
89
|
+
|
|
90
|
+
## Disclaimer
|
|
91
|
+
|
|
92
|
+
This project is **not affiliated with, endorsed by, or associated with
|
|
93
|
+
Esoteric Software** or the Spine runtime in any way. "Spine" is a trademark
|
|
94
|
+
of Esoteric Software.
|
|
95
|
+
|
|
96
|
+
Licensed under the [Apache License 2.0](LICENSE). That license applies to this
|
|
97
|
+
project's source code only, not to third-party assets or trademarks — see
|
|
98
|
+
[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). Provided **as-is, without
|
|
99
|
+
warranty of any kind** — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# skel-mesh-parser (Python)
|
|
2
|
+
|
|
3
|
+
Python port of this repo's `js` branch (`spine-skeleton-binary-js`): a
|
|
4
|
+
minimal, dependency-free parser for the skin/attachment section of Spine
|
|
5
|
+
skeleton binary files (`.skel`) that returns, per attachment, its raw type
|
|
6
|
+
and — for `Mesh`-type attachments — the `uvs`/`triangles` needed to build a
|
|
7
|
+
texture-space silhouette. It is **not** a Spine runtime: no rendering, no
|
|
8
|
+
animation, no timelines, IK, physics, or constraint solving. Supports Spine
|
|
9
|
+
versions **3.8.x and 4.2.x only** (anything else raises
|
|
10
|
+
`UnsupportedVersionError`).
|
|
11
|
+
|
|
12
|
+
**Status:** implemented — `parse_skeleton` is wired up for both 3.8.x and
|
|
13
|
+
4.2.x. It is a field-for-field port of the `js` branch's reader and has been
|
|
14
|
+
validated against the official Spine 3.8 `goblins-pro.skel` example (see
|
|
15
|
+
[Testing](#testing)).
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
from skel_mesh_parser import parse_skeleton
|
|
21
|
+
|
|
22
|
+
data = open("some.skel", "rb").read()
|
|
23
|
+
result = parse_skeleton(data)
|
|
24
|
+
|
|
25
|
+
# result["version"]: {"major": int, "minor": int, "patch": int, "raw": str}
|
|
26
|
+
# result["attachments"]: dict[str, AttachmentInfo], keyed by the
|
|
27
|
+
# attachment's resolved path (the atlas region name it draws from)
|
|
28
|
+
|
|
29
|
+
info = result["attachments"]["some_region_name"]
|
|
30
|
+
# info["type"]: "Region" | "BoundingBox" | "Mesh" | "LinkedMesh" | "Path" | "Point" | "Clipping"
|
|
31
|
+
# info["uvs"] / info["triangles"] / info["hull_length"]: present ONLY when
|
|
32
|
+
# info["type"] == "Mesh" (hull_length is the js branch's `hullLength`: the
|
|
33
|
+
# number of outline vertices, i.e. the first hull_length UV pairs)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Scope, by design (same as the `js` branch):**
|
|
37
|
+
- Default skin only. Non-default skins are walked (to keep the byte stream
|
|
38
|
+
aligned) but not returned.
|
|
39
|
+
- `Mesh`-type attachments only carry `uvs`/`triangles`/`hull_length`.
|
|
40
|
+
- `LinkedMesh` is reported as its own distinct type, never confused with
|
|
41
|
+
`Mesh`.
|
|
42
|
+
- On an attachment-path collision within the same skin, the `Mesh` entry
|
|
43
|
+
always wins, deterministically, regardless of wire order.
|
|
44
|
+
|
|
45
|
+
## Versions and tags
|
|
46
|
+
|
|
47
|
+
The two branches are released independently, each with its own version
|
|
48
|
+
numbers and tag prefix:
|
|
49
|
+
|
|
50
|
+
- `py-vX.Y.Z` — this `python` branch (the version in `pyproject.toml`).
|
|
51
|
+
- `js-vX.Y.Z` — the `js` branch (`spine-skeleton-binary-js`).
|
|
52
|
+
|
|
53
|
+
Older unprefixed tags (`v1.0.0`, `v1.1.0`) belong to the `js` branch.
|
|
54
|
+
To depend on a fixed release, pin the tag rather than the branch, e.g.
|
|
55
|
+
`skel-mesh-parser @ git+https://github.com/com55/skel-mesh-parser.git@py-v0.3.0`.
|
|
56
|
+
|
|
57
|
+
## Testing
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
python -m pytest # all normal tests — offline, no Spine assets needed
|
|
61
|
+
python -m pytest -m integration # needs the official Spine 3.8 example asset (see below)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
(or `uv run pytest` / `uv run pytest -m integration`)
|
|
65
|
+
|
|
66
|
+
- **Normal tests** use only hand-built binary fixtures created for this repo (`tests/fixtures/`). They never touch the network or any Spine asset.
|
|
67
|
+
- **Integration test** (`tests/integration/`) validates the 3.8 reader against the official Spine example `goblins-pro.skel`, using the same oracle values as the `js` branch. **This repository does not distribute that file** — see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). Instead, `tests/spine_fixture.py` resolves it as follows:
|
|
68
|
+
1. If `SPINE_GOBLINS_SKEL=/path/to/goblins-pro.skel` is set, that file is used (and never downloaded).
|
|
69
|
+
2. Otherwise `.cache/spine/goblins-pro.skel` (gitignored) is reused if present.
|
|
70
|
+
3. Otherwise it is downloaded once from Esoteric Software's official `EsotericSoftware/spine-runtimes` repository, at a **pinned commit** (not a moving branch), and cached.
|
|
71
|
+
- **Checksum verification.** Every source is verified against a pinned SHA-256 (`GOBLINS_SKEL_SHA256`). A mismatch fails the test run; a cached file with the wrong checksum is discarded and re-downloaded. Nothing is written to the cache unless it verified.
|
|
72
|
+
- **Fixture unavailable** (offline, HTTP error): the integration tests are skipped with a message explaining how to supply the file. Set `SPINE_FIXTURE_REQUIRED=1` (as CI does) to fail instead of skip.
|
|
73
|
+
|
|
74
|
+
## Provenance
|
|
75
|
+
|
|
76
|
+
This is a port of the `js` branch's implementation, which was written independently. The official Spine Runtime source was consulted only to verify binary-format behavior and field layout; its source code was not copied or translated into this project. The reference source (`spine-ts`) is licensed under the Spine Runtimes License, which is not a permissive license. This project is not a Spine runtime. See the `js` branch's README and source comments for the exact file/line/commit each field-layout fact was checked against. Pinned commits (branch HEAD at time of writing, 2026-08-28 — re-verify before relying on a moved branch ref):
|
|
77
|
+
- 4.2: `EsotericSoftware/spine-runtimes@b81e5a58ed38704aee4f866f0e0ac672623ce914`, `spine-ts/spine-core/src/SkeletonBinary.ts`
|
|
78
|
+
- 3.8: `EsotericSoftware/spine-runtimes@8b4844bd4b193ba9e54487ed397a777993cbad56`, `spine-ts/core/src/SkeletonBinary.ts`
|
|
79
|
+
|
|
80
|
+
## Disclaimer
|
|
81
|
+
|
|
82
|
+
This project is **not affiliated with, endorsed by, or associated with
|
|
83
|
+
Esoteric Software** or the Spine runtime in any way. "Spine" is a trademark
|
|
84
|
+
of Esoteric Software.
|
|
85
|
+
|
|
86
|
+
Licensed under the [Apache License 2.0](LICENSE). That license applies to this
|
|
87
|
+
project's source code only, not to third-party assets or trademarks — see
|
|
88
|
+
[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). Provided **as-is, without
|
|
89
|
+
warranty of any kind** — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
This project's source code is licensed under the [Apache License 2.0](LICENSE).
|
|
4
|
+
That license applies **only to this project's own source code**. It does not
|
|
5
|
+
cover, and grants no rights in, any third-party asset or trademark.
|
|
6
|
+
|
|
7
|
+
## Esoteric Software / Spine
|
|
8
|
+
|
|
9
|
+
- **Trademarks.** "Spine" is a trademark of Esoteric Software. This project is
|
|
10
|
+
not affiliated with, endorsed by, or associated with Esoteric Software, and the
|
|
11
|
+
Apache-2.0 license does not grant any right to use that trademark.
|
|
12
|
+
- **Spine Runtimes source.** The official Spine Runtimes (`spine-runtimes`) are
|
|
13
|
+
licensed under the Spine Runtimes License, which is not a permissive license.
|
|
14
|
+
No code from them is included in this repository; they were consulted only to
|
|
15
|
+
verify binary-format behavior and field layout (see "Provenance" in the
|
|
16
|
+
README).
|
|
17
|
+
- **Official example assets.** The optional integration test uses the official
|
|
18
|
+
Spine 3.8 `goblins-pro.skel` example export. **This repository does not
|
|
19
|
+
contain or distribute that file.** It is fetched on demand from Esoteric
|
|
20
|
+
Software's official `EsotericSoftware/spine-runtimes` repository (pinned
|
|
21
|
+
commit, SHA-256 verified; see the README "Testing" section), or supplied by
|
|
22
|
+
you via `SPINE_GOBLINS_SKEL`. The file remains subject to its original Esoteric
|
|
23
|
+
Software terms, including the license file that accompanies the examples in
|
|
24
|
+
that repository. If you fetch or use it, you are responsible for complying with
|
|
25
|
+
those terms. The Apache-2.0 license of this project does not apply to it.
|
|
26
|
+
|
|
27
|
+
## Other
|
|
28
|
+
|
|
29
|
+
- The integration test's expected values were cross-checked against the
|
|
30
|
+
independent `spine_asset` Python package (MIT-licensed). It is not included in,
|
|
31
|
+
or required by, this repository.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "skel-mesh-parser"
|
|
7
|
+
version = "0.3.0"
|
|
8
|
+
description = "Minimal dependency-free parser for the skin/attachment section of Spine skeleton binary files (.skel, 3.8.x and 4.2.x). Python port of the js branch's spine-skeleton-binary-js."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "THIRD_PARTY_NOTICES.md"]
|
|
13
|
+
dependencies = []
|
|
14
|
+
|
|
15
|
+
[dependency-groups]
|
|
16
|
+
dev = [
|
|
17
|
+
"pytest>=8.0",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[tool.pytest.ini_options]
|
|
21
|
+
testpaths = ["tests"]
|
|
22
|
+
# Integration tests need the official Spine example asset (downloaded on
|
|
23
|
+
# demand, SHA-256 verified) and are excluded by default. Run them with:
|
|
24
|
+
# pytest -m integration
|
|
25
|
+
addopts = "-m 'not integration'"
|
|
26
|
+
markers = [
|
|
27
|
+
"integration: needs the official Spine example asset (downloaded on demand or via SPINE_GOBLINS_SKEL)",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
[tool.hatch.build.targets.wheel]
|
|
31
|
+
packages = ["skel_mesh_parser"]
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"""Public API for the .skel binary parser -- port of
|
|
2
|
+
www/js/vendor/spine-skeleton-binary/index.js's parseSkeleton. Lives directly
|
|
3
|
+
in this package's __init__.py (the spec's §1 tree names no separate file for
|
|
4
|
+
it) since it's this package's one entry point, mirroring index.js's own role
|
|
5
|
+
in the vendored JS package.
|
|
6
|
+
|
|
7
|
+
Real source's own comment on the re-read below: "Once the version is known,
|
|
8
|
+
the header shape is no longer ambiguous -- redo exactly the right skip (not
|
|
9
|
+
a 'replay' of a single assumed shape, per the bug this task found)." --
|
|
10
|
+
detect_version() consumes its OWN throwaway BinaryReader internally and
|
|
11
|
+
never advances the one this function passes to read_skeleton_38/42, so the
|
|
12
|
+
header must be walked again here, deliberately, once the version is known."""
|
|
13
|
+
from __future__ import annotations
|
|
14
|
+
|
|
15
|
+
from typing import Any
|
|
16
|
+
|
|
17
|
+
from skel_mesh_parser.binary_reader import BinaryReader
|
|
18
|
+
from skel_mesh_parser.detect_version import UnsupportedVersionError, detect_version
|
|
19
|
+
from skel_mesh_parser.read_skeleton_38 import read_skeleton_38
|
|
20
|
+
from skel_mesh_parser.read_skeleton_42 import read_skeleton_42
|
|
21
|
+
|
|
22
|
+
__version__ = "0.3.0"
|
|
23
|
+
__all__ = ["parse_skeleton", "UnsupportedVersionError"]
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def parse_skeleton(data: bytes) -> dict[str, Any]:
|
|
27
|
+
version = detect_version(data)
|
|
28
|
+
r = BinaryReader(data)
|
|
29
|
+
is_42 = version["major"] == 4 and version["minor"] == 2
|
|
30
|
+
if is_42:
|
|
31
|
+
r.read_int32()
|
|
32
|
+
r.read_int32()
|
|
33
|
+
else:
|
|
34
|
+
r.read_string()
|
|
35
|
+
r.read_string() # version string -- same position in both shapes
|
|
36
|
+
|
|
37
|
+
attachments = read_skeleton_42(r) if is_42 else read_skeleton_38(r)
|
|
38
|
+
|
|
39
|
+
return {"version": version, "attachments": attachments}
|