Skip to content
Open
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
10 changes: 10 additions & 0 deletions .auto-pr/SPEC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Spec - Issue #167

## Problem

The project documentation does not explicitly tell users that the classic LPC frame size is 64x64 while some weapon and oversize animations require larger frame dimensions.

## Acceptance Criteria

- [x] The README explicitly states that classic LPC frames are 64x64.
- [x] The README clarifies that weapon and oversize animations can exceed 64x64 and should be cut/exported with matching larger frame dimensions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like Gaurav said, the planning documents should be removed. These very clearly are in an .auto-pr directory:

[‎.auto-pr/SPEC.md‎](https://github.com/LiberatedPixelCup/Universal-LPC-Spritesheet-Character-Generator/pull/454/changes#diff-f5528671d7ba894b18ee1cea277d7bd910a11db14a9cd0116ee514de9b44de7e)

Just add .auto-pr to .gitignore and that will solve the problem.

5 changes: 5 additions & 0 deletions .auto-pr/TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# TODO - Issue #167

- [x] Locate the existing animation/frame guidance in the README.
- [x] Add a short note clarifying when 64x64 applies and when oversize frame dimensions are needed.
- [x] Run minimal documentation validation.
1 change: 1 addition & 0 deletions .auto-pr/VALIDATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [x] Reviewed the updated README text and verified the added note sits next to the animation frame guidance.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ You can look at [the Animation Guide in Eliza's repository](https://github.com/E

Also, each animation has a frame cycle documented which you can see next to the animation preview.

The classic LPC frame size is `64x64`, but some weapon and oversize animations extend beyond that box. If you export or cut frames for those animations, choose the matching oversize frame dimensions instead of assuming every frame is `64x64`.

### Run This Project Locally for Development

The UI is built with [Vite](https://vitejs.dev/). Use a dev server rather than opening `index.html` as a `file://` URL, since ES modules and asset paths expect HTTP and modern browsers restrict file URLs.
Expand Down
Loading