SFTtech / SFTtech/openage

SLD File Documentation 100%?

Open
#1,772 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: assets lang: python question
Dominant language
Python
Stars
14.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

I was looking through the openage SLD documentation here

https://github.com/SFTtech/openage/blob/master/doc/media/sld-files.md

and the SLD Extractor which seems to follow it here:

https://sld.aoe2.se/

I think the implementation with duplicated blocks from the previous frame is slightly incorrect, and this could mean the documentation might be slightly wrong? Although I can't work out exactly how.

On some of the sprites (ones with portions which are static for several frames) the algorithm also incorrectly copies blocks elsewhere - see the war wagon death animation:

Image

It seems a lot of the blocks from the collapsed wagon are correctly copied from the previous frame (because they're not moving) but then also blocks by the horse's head are also being incorrectly copied.

If any of the openage community could help me in understanding why this could be the case, i'd be able to update the SLD Extraction JS code and fix it so it's perfect. I'm sure there is a rule that might not be documented or something...

Many thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with doc/media/sld-files.md and compare its duplicated-block description with the SLD Extractor at https://sld.aoe2.se/. Reproduce the war wagon death animation case shown in the issue, determine the rule governing copied blocks, and document the rule or identify the required SLD Extraction JS correction.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.