Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug report
description: Something in SpriteMotion crashes, errors or behaves differently than documented.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for reporting. Please do not attach UO client files, extracted sprites, renders of original game art
or commercial asset-pack content. Screenshots of SpriteMotion's own UI and output are fine.
Security problems go through private vulnerability reporting instead (see SECURITY.md).
- type: dropdown
id: tool
attributes:
label: Tool
options:
- Content Studio
- Fit Lab
- Blender build pipeline
- Client staging tools
- Outfit lab
- Sprite Pose Editor
- Other / not sure
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened
description: What you did, what you expected, and what happened instead.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. Run launchers\editor\fit-lab.bat cc0-starter
2. ...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Error output or logs
description: Paste console output. Replace personal folder names with placeholders.
render: text
- type: input
id: commit
attributes:
label: Commit or branch
placeholder: main @ abc1234
- type: input
id: environment
attributes:
label: Environment
description: OS, Python version, Blender version, browser.
placeholder: Windows 11, Python 3.12, Blender 4.2, Chrome
- type: checkboxes
id: content
attributes:
label: Content rules
options:
- label: I did not attach original client art, client files or commercial asset-pack content.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Questions and ideas (Discussions)
url: https://github.com/DatMoshu/SpriteMotion/discussions
about: Ask setup questions, share results and discuss ideas before opening an issue.
- name: Wiki
url: https://github.com/DatMoshu/SpriteMotion/wiki
about: Setup walkthroughs and guides.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest a new tool capability, workflow or documentation improvement.
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
For open-ended ideas or questions, the Discussions board may be a better first stop.
Check [ROADMAP.md](https://github.com/DatMoshu/SpriteMotion/blob/main/ROADMAP.md) to see whether it is already planned.
- type: textarea
id: problem
attributes:
label: Problem
description: What are you trying to do, and what gets in the way today?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: How should it work? Mention the tool (Content Studio, Fit Lab, build pipeline, ...) it affects.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
- type: dropdown
id: help
attributes:
label: Can you help build it?
options:
- "Yes, I can open a pull request"
- "I can test or review"
- "No"
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/parity_gap.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Parity gap
description: A rendered item does not match how original UO equipment looks or moves in a specific pose.
labels: [parity]
body:
- type: markdown
attributes:
value: |
Parity gaps drive the [roadmap](https://github.com/DatMoshu/SpriteMotion/blob/main/ROADMAP.md).
**Do not attach original client art** (extracted frames, sprite sheets, screenshots of the original game's
artwork) or commercial asset-pack content. Attach SpriteMotion output only and describe the original in words.
- type: input
id: action
attributes:
label: Action id
description: UO people animation action, 0-34.
placeholder: "9"
validations:
required: true
- type: dropdown
id: direction
attributes:
label: Direction
description: Stored directions are 0-4; 5-7 are mirrored views.
options:
- "0"
- "1"
- "2"
- "3"
- "4"
- "5 (mirrored)"
- "6 (mirrored)"
- "7 (mirrored)"
- "All / several"
validations:
required: true
- type: input
id: slot
attributes:
label: Slot
description: Equipment slot or UO layer.
placeholder: chest / helm / cloak / weapon ...
validations:
required: true
- type: input
id: item
attributes:
label: Item
description: Item id or name (CC0 starter item, your own model, or a generic description of a private pack item).
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected
description: How original equipment looks or behaves in this pose, in words.
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual
description: What SpriteMotion produced (lab preview or Blender render, which build/job).
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: Screenshot
description: Drop a screenshot of SpriteMotion output here. Never original client art.
- type: checkboxes
id: content
attributes:
label: Content rules
options:
- label: My attachments show only SpriteMotion output, not original client art or commercial pack content.
required: true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ __pycache__/
/tests/output/
/tools/blender-runtime/
launchers/_shared/config.local.sh

# Browser automation scratch
/.playwright-mcp/
135 changes: 135 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement privately, either
by opening a private report through the repository's
[Security tab](https://github.com/DatMoshu/SpriteMotion/security/advisories/new)
(GitHub private advisory, visible only to maintainers) or by contacting the
maintainer [@DatMoshu](https://github.com/DatMoshu) on GitHub.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# SpriteMotion

[![CI](https://github.com/DatMoshu/SpriteMotion/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DatMoshu/SpriteMotion/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

<!-- hero-gif -->

**Create, fit and render equipment for Ultima Online's classic 2D characters.**

SpriteMotion is a local content-authoring toolkit. Bring a 3D item, artwork or a
Expand Down Expand Up @@ -117,11 +122,23 @@ To explore the original reconstruction workflow without game assets, use the
[reconstruction workflow](docs/reconstruction-workflow.md) and
[annotation format](docs/annotation-format.md) remain documented separately.

## Help wanted: toward UO parity

The tools work; proving that every item looks right in every animation, facing and client is the open part.
[ROADMAP.md](ROADMAP.md) lists the render acceptance gates, what is already done and where help is wanted:
acceptance matrices across all 35 actions, rig targets for twist bones and cloth chains, complete-outfit reviews
and in-game client tests. Setup walkthroughs live in the [wiki](https://github.com/DatMoshu/SpriteMotion/wiki);
questions go to [Discussions](https://github.com/DatMoshu/SpriteMotion/discussions). Report a pose that does not
match original equipment with the **Parity gap** issue template, and read [CONTRIBUTING.md](CONTRIBUTING.md)
before opening a pull request.

## Contributing

Use a branch or fork and submit a pull request. Protected `main` requires the
`guard` and `build` checks and maintainer code-owner approval; administrators
retain a bypass. See [CONTRIBUTING.md](CONTRIBUTING.md) for review and content rules.
retain a bypass. See [CONTRIBUTING.md](CONTRIBUTING.md) for review and content rules,
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community standards and [SECURITY.md](SECURITY.md) for
reporting vulnerabilities.

```powershell
python -m pytest -q
Expand Down
Loading
Loading