Theme docs are missing 27 images, have wrong names, and give no drawn sizes
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- lua
- Domain
- documentation
Research direction
Start with docs/themes.md and compare its asset list and descriptions against the loading and drawing code in client/src/mods/Theme.lua and the referenced rendering paths in ClientStack.lua, Character.lua, and GraphicsUtil. Update the missing names, incorrect descriptions, and drawn-size guidance from the issue’s findings. Done when the documentation matches the code for all listed assets and gives theme authors usable size guidance.
Written by the indexing model from the issue text.
Description
docs/themes.md calls itself an exhaustive list of theme assets, but it covers 52 of the 79 images Theme.lua loads (counting a per-player pair or a numbered series such as level1…level11 as one image), gives a drawn size for none of them, and has a few names and descriptions that don't match the code. Checked against beta at 74629707.
Not documented
These are loaded by client/src/mods/Theme.lua but never mentioned in docs/themes.md:
- Puzzle and match icons:
bug(L344),edit,partial - Input icons, all 17:
input/controller,input/keyboard,input/touch,input/mouse, the 10input/controller_*variants (generic,playstation1-5,xbox360,xboxone,xboxseries,switch_pro),input/controller_add,input/errorandinput/device_number_N(L384-L409) - Lobby icons:
checkbox_checked,checkbox_unchecked,fight,stopwatch,endless(L453-L457) separator(L493), used by the puzzle hierarchy displaymultibar_frame(L543): loaded intoIMG_multibar_frame, but nothing reads that field and the default theme doesn't ship the file. It should probably be removed rather than documented.
Wrong names
- The character select overlay is documented as
load, but the game loadsloading(L433). A theme following the doc gets the default image. - The actions per minute icon is documented as
APM, but the game loadsapm(L551), and the default theme itself ships[email protected]. On a case-sensitive filesystem the default theme's APM icon doesn't load at all: running beta from a case-sensitive APFS volume,themes[config.theme].images.IMG_apmis nil whileIMG_gpmloads; the same check on the default case-insensitive volume loads both. Linux filesystems are case-sensitive, so Linux players most likely don't see the icon (not tested on Linux itself).
Wrong or stale descriptions
- Countdown says
1,2and3"will get displayed just as is, no scaling". They are drawn throughdrawGfxScaledinClientStack:drawCountdown(ClientStack.lua#L370), at 3x their point size, the same asready. Measured in game: the defaultready@2x(71x15 points) is drawn 213x45 and the numbers 45x45. - Fallback PopFX says a theme should provide
burstandfadefor characters that lack them. Missingburstandfadefall back to the default character (defaulted_imagesinCharacter.lua); the theme's files are never loaded. - Default image says
transparentis shown when any mod image fails to load. The fallback inGraphicsUtil.privateLoadImageWithExtensionAndScaleloadsthemes/Panel Attack/transparent.png, a theme folder the game no longer ships (the default isPanel Attack Modern); in game that path doesn't exist, so a file that fails to decode loads as nil instead.
Drawn sizes
No image says how big it is drawn, so theme authors can't tell what resolution to ship. The drawn size on the 1280x720 canvas is fixed for many of them, for example:
| Image | Drawn at |
|---|---|
frame/frameNP |
312x612 |
frame/wallNP |
width 288 |
cursor1, cursor2 |
120x72 |
| chain and combo cards | 48x48 |
pN_select_screen_cursorN |
height 100 |
random_character |
84x84 |
random_stage |
80x45 |
level/levelN, level/levelNunfocus |
20x20 in the 1P mode menus, 16x16 in the puzzle menu |
bug |
60x60 |
swap, apm, GPM, CursorCount |
24x24 |
input/* |
longest side 64 in the input device slots |
flags/*, lobby icons, hint, complete, partial |
fit in 16x16 |
edit |
fit in 40x40 |
ready, loading, super on character select |
fit in the 84x84 tile |
1, 2, 3, ready in the countdown |
3x their point size |
The others (labels, number atlases, multibar parts) are drawn at their own size times a *_Scale from config.json, which could be stated per image.
- Dominant language
- Lua
- Stars
- 30
- Forks
- 20
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 17
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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.
More from panel-attack/panel-game
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
panel-attack/panel-game#822 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
panel-attack/panel-game#779 ·
Maintainers usually reply within 1 day
-
bug Client-side priority: 0 - high
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
panel-attack/panel-game#776 ·
Maintainers usually reply within 1 day
-
enhancement priority: 1 - middle
Difficulty 4/5 3-5 days Newbie friendliness 48/100
panel-attack/panel-game#821 ·
Maintainers usually reply within 1 day
-
Animation scenes draw every part separately, costing hundreds of draw calls a framePossibly taken @JamesVanBoxtel claimed this 4 days ago. OpenClient-side enhancement graphics
panel-attack/panel-game#814 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in panel-attack/panel-game
Similar issues
-
slice weekend
Difficulty 2/5 1-3 hours Newbie friendliness 71/100
Life-Framework/Life-Framework#3212 ·
Maintainers usually reply within 1 day
-
bug discord guide:01b-riverglades locale:enUS triage v4.1.1
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
petertriho/nvim-scrollbar#127 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100