libretro / libretro/nxengine-libretro
nxengine/extract-auto/sprites_sif.h should become a plain text file.
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 86
- Forks
- 95
- Avg merge
- 4h 44m
- Merged PRs (30d)
- 1
Description
Currently, the binary data of sprites.sif resides in nxengine/extract-auto/sprites_sif.h which is not readable by human or sifedit.
https://github.com/andwn/cave-story-md/blob/master/res/resources.res looks like the plain text equivalent to sprites.sif
sifedit from the upstream nxengine project may stop working in the near future.
https://github.com/nxengine/sifedit is also fragile and is hated by nxengine-evo's maintainer.
Plain text configuration is the way forward.
sprites.sif should become a plain text file such as sprites.txt. Makefile can compile the plain text file into a C header during compile time.
nxengine/sprites.txt in retroarch systems folder may override the built-in sprites configuration.
sprites.txt should be well documented with comments so that anyone can edit it.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing nxengine/extract-auto/sprites_sif.h with the plain-text example at res/resources.res, then inspect the Makefile and nxengine/sprites.txt override location. Define the text format and document it with comments, while preserving compilation into the built-in sprite configuration and allowing the external override described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- build-system, game-dev
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100