Skip to content

docs: document 64x64 and oversize frame dimensions - #454

Open
JackWenStack wants to merge 1 commit into
LiberatedPixelCup:masterfrom
JackWenStack:fix/issue-167-document-frame-sizes
Open

docs: document 64x64 and oversize frame dimensions#454
JackWenStack wants to merge 1 commit into
LiberatedPixelCup:masterfrom
JackWenStack:fix/issue-167-document-frame-sizes

Conversation

@JackWenStack

Copy link
Copy Markdown

Summary

Fixes #167 - Document frame sizes

Spec

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

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

Work Breakdown

TODO - Issue #167

  • Locate the existing animation/frame guidance in the README.
  • Add a short note clarifying when 64x64 applies and when oversize frame dimensions are needed.
  • Run minimal documentation validation.

Notes

None.

Validation

  • Reviewed the updated README text and verified the added note sits next to the animation frame guidance.

@netlify

netlify Bot commented Apr 27, 2026

Copy link
Copy Markdown

👷 Deploy request for liberatedpixelcup pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7ac41eb

@JackWenStack
JackWenStack marked this pull request as ready for review April 27, 2026 03:44

@Gaurav0 Gaurav0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  1. Please remove planning documents
  2. Document frame sizes for all oversize animations.

You can generally find this information in the code.

See the customAnimations array in custom-animations.ts

Comment thread .auto-pr/SPEC.md
## 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document frame sizes

3 participants