Skip to content

Commit a812bb6

Browse files
committed
feat: initial release — Spine Animation AI skill for Claude
0 parents  commit a812bb6

25 files changed

Lines changed: 7412 additions & 0 deletions

.github/workflows/pages.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy Demo to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'demo/**'
8+
- 'examples/**'
9+
- 'README.md'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: false
20+
21+
jobs:
22+
deploy:
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v4
33+
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: '.'
38+
39+
- name: Deploy to GitHub Pages
40+
id: deployment
41+
uses: actions/deploy-pages@v4

CONTRIBUTING.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Contributing to Spine Animation AI
2+
3+
Thank you for your interest in contributing! This project is community-driven and welcomes all skill levels.
4+
5+
## Ways to Contribute
6+
7+
### 🐛 Bug Reports
8+
Found a script that crashes or produces bad output? Open an issue with:
9+
- The command you ran
10+
- Your Python version (`python3 --version`)
11+
- The error message or bad output
12+
- A minimal example (attach files if possible)
13+
14+
### ✨ New Features
15+
Before opening a large PR, open an issue first to discuss. Some ideas we'd love to see:
16+
17+
- **New animation presets** — dance, swim, fly, cast-spell, crouch, death
18+
- **Non-humanoid rigs** — animals, creatures, vehicles, abstract shapes
19+
- **Better occlusion detection** — for heavily layered / occluded parts
20+
- **Asset pipeline integrations** — Blender exporter, Aseprite → atlas, LibreSprite
21+
- **Runtime examples** — Unity C#, Godot GDScript, Phaser 3, PixiJS
22+
- **Improved SKILL.md** — better Claude prompting patterns, edge cases
23+
24+
### 📖 Documentation
25+
Documentation PRs are always welcome — fix typos, clarify instructions, add examples.
26+
27+
---
28+
29+
## Getting Started
30+
31+
```bash
32+
git clone https://github.com/your-username/spine-animation-ai
33+
cd spine-animation-ai
34+
35+
# Install Python dependencies
36+
pip install opencv-python Pillow numpy
37+
38+
# Run the example
39+
python3 scripts/position_parts.py --help
40+
```
41+
42+
---
43+
44+
## Code Style
45+
46+
- **Python**: PEP 8. Max line length 100. Type hints for new functions.
47+
- **Docstrings**: Use Google-style docstrings for public functions.
48+
- **Scripts**: Each script should be self-contained with a `--help` that explains all flags.
49+
- **Commit messages**: Conventional Commits preferred (`feat:`, `fix:`, `docs:`, `refactor:`)
50+
51+
---
52+
53+
## Testing New Scripts
54+
55+
Before submitting, test your script against the included sombrero example:
56+
57+
```bash
58+
python3 scripts/your_new_script.py \
59+
--input examples/sombrero/sombrero.json \
60+
--output /tmp/test_output/
61+
```
62+
63+
Include a note in your PR about what you tested.
64+
65+
---
66+
67+
## Pull Request Checklist
68+
69+
- [ ] Script runs without errors on the sombrero example
70+
- [ ] `--help` flag works and explains all options
71+
- [ ] README updated if adding a new script or major feature
72+
- [ ] SKILL.md updated if Claude's behavior should change
73+
- [ ] No large binary files added (use Git LFS for PNGs > 1MB)
74+
75+
---
76+
77+
## Project Philosophy
78+
79+
This skill should feel like a knowledgeable co-pilot, not a magic black box.
80+
The output should be **inspectable** (JSON you can read), **adjustable** (easy to tweak),
81+
and **portable** (works with any Spine runtime, not just our preview).
82+
83+
When in doubt: prefer clarity over cleverness, and correctness over speed.
84+
85+
---
86+
87+
Questions? Open an issue or start a discussion. We're friendly here. 🙂

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Spine Animation AI Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)