MagicBeanDev/Longshot
MagicBeanDev/Longshot
Watch
75
96
Fork
You've already forked Longshot
 100
Code Issues 232 Pull requests 252 Projects Releases 9 Packages Wiki Activity Actions 771

feat(builder): the game's own name and icon for its exe and window, from the .nup #857

Merged
HumanBean merged 1 commit from HumanBean/Longshot:feat/game-title-icon into main 2026-11-15 17:59:42 +00:00
Conversation 0 Commits 1 Files changed 8 +306 -22
HumanBean commented 2026-11-15 17:54:59 +00:00
Owner

Type: feat · Risk: low · Tested on: not run yet · Needs: Windows (any GPU), Linux (any GPU), built from a .nup

Why

A game the builder makes is called "Longshot" and has no icon: the window's title says Longshot, and on Windows the exe shows in Task Manager, the taskbar and its Properties as a nameless longshot.exe with the default icon. On Linux the window got the desktop's generic icon, since the game looked for its icon in the wrong folder. It should look like the game it is: its own icon, and the name "The Legend of Zelda: Ocarina of Time (Longshot)". See #228.

What changed

The builder reads the game's name and icon from the .nup it builds from, keeps them in the game folder so an update keeps them, and makes them into the Windows exe's icon and the name Windows shows for it, and into the window's title and (on Linux) its icon. The exe's file name stays longshot.exe / longshot: the launcher, the folder's launcher (builder/setup/setup.c) and the driver profiles find the game by it, and Windows refuses the colon in a file name.

  • builder: nx2/game_title.py (new) reads the title's metadata in the .nup (the record at +0x20 of its title entry: kind/size records, 3 the icon JPEG, 5 the name). The .nup's name is fit for a file name, so its colon is gone ("The Legend of Zelda Ocarina of Time"); NAMES gives the name as the game writes it, by title id. It keeps longshot_title.txt (the window title, with " (Longshot)") and .longshot_icon.jpg in the game folder.
  • builder: make_game.py game_name() runs after the game is read (a .nup build reads it, an update uses what the folder kept, a build from an unpacked dump has neither and stays "Longshot"). On Windows it writes work/longshot_game.res; on Linux the folder's longshot.png is the game's icon instead of Longshot's logo. Nothing in it stops a build.
  • builder: make_icon.py is split into functions the builder reuses, and can add a VERSIONINFO (version_entry: FileDescription and ProductName). Its CLI makes the same files as before.
  • builder: build.py exe_resources() links longshot_game.res, else a developer's longshot.res, never both (both are icon 1).
  • host: hos_game_title() in host/hos_paths.h reads the first line of longshot_title.txt in the game folder. host/display.c sets it as the window's title (Unicode, through DefWindowProcW); host/posix/display_sdl.c creates the window with it (HOS_WINDOW_TITLE still wins).
  • host: the Linux window icon is now looked for in the game folder (hos_game_path_a), not beside the exe. In a packaged builder's folder the game is bin/longshot, so it looked in bin/ and never found longshot.png.
  • tests: tests/display_startup_failure_test.cpp stubs hos_game_title, which the startup loop it cuts out now calls.

Measurements

Nothing to measure: no frame-time or memory change. What needs checking is the name and icon (below).

Flags and settings

None.

Testing

Tested: the .nup layout was read by hand from an Ocarina of Time 1.1.1 .nup on Linux: records 1 (NPDM, 1828 bytes), 3 (JPEG, 38073 bytes), 4 ("1.1.1"), 5 ("The Legend of Zelda Ocarina of Time"), 8 ("ZeldaOOT"); title id 0400486024dec000. No build was run, and tests/run_all.py was not run on this PC.

Not tested: a build and a start of the game on either OS; the game-free checks.

Must be tested:

  • Any PC: python -I -B tests/run_all.py passes, expecting nothing new to fail (by hand, or the Forgejo checks).
  • Windows, any GPU: build from a .nup with the builder and start the game, expecting the window titled "The Legend of Zelda: Ocarina of Time (Longshot)" with the game's icon, and bin\longshot.exe shown under that name and icon in Task Manager and the taskbar (Test Farm: @Beanstalk windows, build from the .nup and check the window title and the exe's icon and name in Task Manager).
  • Linux, any GPU: build from a .nup with the AppImage and start the game from the folder's longshot, expecting the same window title and the game's icon on X11 (Test Farm: @Beanstalk linux, same check).
  • Either OS: an update build (no .nup) of a folder built by this PR keeps the name and icon.

Risks

What could break: a .nup whose metadata isn't laid out as above gives no name or icon, and the game stays "Longshot" as before. A JPEG Pillow can't read gives no icon. The host's headers changed (hos_paths.h), so the next build compiles the host code again.

Turning it off: revert the commit. Deleting longshot_title.txt from a game folder puts the title back to "Longshot".

Compatibility: saves, the options file, the caches and the vk ABI don't change. The game folder gets longshot_title.txt and .longshot_icon.jpg. A folder built before this PR keeps "Longshot" until it is built from its .nup again (an update alone has nothing to read the name from).

Issues

See #228 (the generic Wayland icon on the game)

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named). Not run on this PC.
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
  • A check under tests/ that reads changed source updated in this PR, not weakened.
  • Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths. Not built yet; the title is read with _wfopen on a UTF-16 path on Windows.

🤖 Generated with Claude Code

**Type:** feat · **Risk:** low · **Tested on:** not run yet · **Needs:** Windows (any GPU), Linux (any GPU), built from a .nup ## Why A game the builder makes is called "Longshot" and has no icon: the window's title says Longshot, and on Windows the exe shows in Task Manager, the taskbar and its Properties as a nameless longshot.exe with the default icon. On Linux the window got the desktop's generic icon, since the game looked for its icon in the wrong folder. It should look like the game it is: its own icon, and the name "The Legend of Zelda: Ocarina of Time (Longshot)". See #228. ## What changed The builder reads the game's name and icon from the .nup it builds from, keeps them in the game folder so an update keeps them, and makes them into the Windows exe's icon and the name Windows shows for it, and into the window's title and (on Linux) its icon. The exe's file name stays `longshot.exe` / `longshot`: the launcher, the folder's launcher (`builder/setup/setup.c`) and the driver profiles find the game by it, and Windows refuses the colon in a file name. - builder: `nx2/game_title.py` (new) reads the title's metadata in the .nup (the record at +0x20 of its title entry: kind/size records, 3 the icon JPEG, 5 the name). The .nup's name is fit for a file name, so its colon is gone ("The Legend of Zelda Ocarina of Time"); `NAMES` gives the name as the game writes it, by title id. It keeps `longshot_title.txt` (the window title, with " (Longshot)") and `.longshot_icon.jpg` in the game folder. - builder: `make_game.py` `game_name()` runs after the game is read (a .nup build reads it, an update uses what the folder kept, a build from an unpacked dump has neither and stays "Longshot"). On Windows it writes `work/longshot_game.res`; on Linux the folder's `longshot.png` is the game's icon instead of Longshot's logo. Nothing in it stops a build. - builder: `make_icon.py` is split into functions the builder reuses, and can add a VERSIONINFO (`version_entry`: FileDescription and ProductName). Its CLI makes the same files as before. - builder: `build.py` `exe_resources()` links `longshot_game.res`, else a developer's `longshot.res`, never both (both are icon 1). - host: `hos_game_title()` in `host/hos_paths.h` reads the first line of `longshot_title.txt` in the game folder. `host/display.c` sets it as the window's title (Unicode, through DefWindowProcW); `host/posix/display_sdl.c` creates the window with it (`HOS_WINDOW_TITLE` still wins). - host: the Linux window icon is now looked for in the game folder (`hos_game_path_a`), not beside the exe. In a packaged builder's folder the game is `bin/longshot`, so it looked in `bin/` and never found `longshot.png`. - tests: `tests/display_startup_failure_test.cpp` stubs `hos_game_title`, which the startup loop it cuts out now calls. ## Measurements Nothing to measure: no frame-time or memory change. What needs checking is the name and icon (below). ### Flags and settings None. ## Testing **Tested:** the .nup layout was read by hand from an Ocarina of Time 1.1.1 .nup on Linux: records 1 (NPDM, 1828 bytes), 3 (JPEG, 38073 bytes), 4 ("1.1.1"), 5 ("The Legend of Zelda Ocarina of Time"), 8 ("ZeldaOOT"); title id 0400486024dec000. No build was run, and `tests/run_all.py` was not run on this PC. **Not tested:** a build and a start of the game on either OS; the game-free checks. **Must be tested:** - Any PC: `python -I -B tests/run_all.py` passes, expecting nothing new to fail (by hand, or the Forgejo checks). - Windows, any GPU: build from a .nup with the builder and start the game, expecting the window titled "The Legend of Zelda: Ocarina of Time (Longshot)" with the game's icon, and `bin\longshot.exe` shown under that name and icon in Task Manager and the taskbar (Test Farm: `@Beanstalk windows`, build from the .nup and check the window title and the exe's icon and name in Task Manager). - Linux, any GPU: build from a .nup with the AppImage and start the game from the folder's `longshot`, expecting the same window title and the game's icon on X11 (Test Farm: `@Beanstalk linux`, same check). - Either OS: an update build (no .nup) of a folder built by this PR keeps the name and icon. ## Risks **What could break:** a .nup whose metadata isn't laid out as above gives no name or icon, and the game stays "Longshot" as before. A JPEG Pillow can't read gives no icon. The host's headers changed (`hos_paths.h`), so the next build compiles the host code again. **Turning it off:** revert the commit. Deleting `longshot_title.txt` from a game folder puts the title back to "Longshot". **Compatibility:** saves, the options file, the caches and the vk ABI don't change. The game folder gets `longshot_title.txt` and `.longshot_icon.jpg`. A folder built before this PR keeps "Longshot" until it is built from its .nup again (an update alone has nothing to read the name from). ## Issues See #228 (the generic Wayland icon on the game) ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). Not run on this PC. - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] A check under `tests/` that reads changed source updated in this PR, not weakened. - [ ] Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths. Not built yet; the title is read with `_wfopen` on a UTF-16 path on Windows. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
feat(builder): the game's own name and icon for its exe and window, from the .nup
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
Details
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
Details
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Details
Website / Website on Cloudflare (pull_request_target) Has been skipped
Details
CI / Conventional Commit title (pull_request) Successful in 6s
Details
CI / Workflow lint (actionlint) (pull_request) Successful in 9s
Details
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 8s
Details
PR description / Description follows the template (pull_request_target) Failing after 5s
Details
4b75251c7c 
The window was "Longshot" with no icon, and so was the Windows exe in Task
Manager and the taskbar. The builder now reads the title's name and icon from
the .nup's metadata, keeps them in the game folder (longshot_title.txt,
.longshot_icon.jpg) so updates keep them, links the icon and a version resource
naming "The Legend of Zelda: Ocarina of Time (Longshot)" into the Windows exe,
and writes the icon as the Linux window's longshot.png. The game reads its
window title from the folder. The Linux window icon is now looked for in the
game folder, not bin/, where the packaged builder's layout never had it.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
HumanBean changed title from WIP: feat(builder): the game's own name and icon for its exe and window, from the .nup to feat(builder): the game's own name and icon for its exe and window, from the .nup 2026-11-15 17:58:59 +00:00
HumanBean deleted branch feat/game-title-icon 2026-11-15 17:59:46 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
area/accessibility
Barriers for people with disabilities

  
area/audio
Sound and music

  
area/input
Controllers, keyboard, mouse

  
area/install
Installing, updating, building from your game

  
area/menu
In-game menu and settings

  
area/renderer
Vulkan renderer, shaders, effects

  
area/saves
Save files

  
area/tooling
Developer tools: scripts, CI, build and release tooling

  
area/upscaling
DLSS, FSR, frame generation

  
beanstalk: approved @ 1697603
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 2c5a62e
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 4fd82b7
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 64d6d09
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 6f91fae
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 70a78f9
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 8015c9a
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 8d361dc
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ 9d8356e
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ abf2227
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ d82f202
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ e5f1e40
Set by Beanstalk for show; the farm's database is what counts

  
beanstalk: approved @ ee8ab5f
Set by Beanstalk for show; the farm's database is what counts

  
ci: approved
A maintainer approved CircleCI for this fork PR (sticky; removed after 14 quiet days)

  
good first issue
A good start for a new contributor

  
gpu/amd
AMD GPUs

  
gpu/igpu
Integrated GPUs

  
gpu/intel
Intel GPUs

  
gpu/nvidia
NVIDIA GPUs

  
help wanted
Extra hands or knowledge wanted

  
kind
bug
 Something doesn't work as it should

  
kind
chore
 Build, CI, dependencies, tidying

  
kind
docs
 Documentation

  
kind
feature
 A new feature or an improvement

  
kind
performance
 Frame rate, frame time, loading, memory

  
kind
question
 A question rather than a change

  
needs measurements
Waiting for before/after measurements

  
platform/linux
Affects Linux (a change for every system carries both Windows and Linux)

  
platform/macos
macOS (Apple silicon or Intel Macs)

  
platform/steam-deck
Steam Deck

  
platform/windows
Affects Windows (a change for every system carries both Windows and Linux)

  
preview
Maintainers: deploy a preview of this PR's website (read its changes first). Removed after the run.

  
priority
critical
 Crashes, data loss, or blocks most players

  
priority
high
 Important: next in line

  
priority
low
 Nice to have

  
regression
Worked in an earlier build, broken in a newer one: highest priority, above other bugs

  
status
blocked
 Waits on something else first

  
status
confirmed
 Reproduced or agreed on

  
status
duplicate
 Already reported or proposed

  
status
invalid
 Not a problem in this project

  
status
needs-info
 Waiting for more information from the reporter

  
status
wontfix
 Will not be worked on

  
testing wanted
Wanted: a test on other hardware (posts a test request in #test-requests)

  
ci: approved
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved @ 1697603
beanstalk: approved @ 2c5a62e
beanstalk: approved @ 4fd82b7
beanstalk: approved @ 64d6d09
beanstalk: approved @ 6f91fae
beanstalk: approved @ 70a78f9
beanstalk: approved @ 8015c9a
beanstalk: approved @ 8d361dc
beanstalk: approved @ 9d8356e
beanstalk: approved @ abf2227
beanstalk: approved @ d82f202
beanstalk: approved @ e5f1e40
beanstalk: approved @ ee8ab5f
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
testing wanted
ci: approved
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!857
No description provided.