libretro / libretro/docs

PrBoom music path incorrect for TVos deployment (Apple RetroArch)

Open Beginner friendly
#1,163 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TeX
Stars
346
Forks
860
Avg merge
5d 16h
Merged PRs (30d)
7

Description

Describe the bug
In the Loading Doom section of the docs (https://docs.libretro.com/library/prboom/#loading-doom), the folder structure for adding music is incorrect for the PrBoom core distributed with RetroArch on TVos. Correctly named mp3 files will not be recognized when colocated with DOOM1/2 wads.

Expected behavior/changes
The documents reflect that for TVos (at least), music files must be placed in the same SYSTEM (bios)/prboom directory that additional WADs, DEHs, and the prboom.wad file are located in.

Additional context
I also don't believe it's noted anywhere in the docs that the prboom.wad and additional loaded WADs/DEHs have to go the prboom folder under SYSTEM is documented anywhere. It would also be helpful if it was clearly disambiguated that DOOM1/2 wads can be zipped, but what I'm calling additional wads/DEHs (i.e. D1SPFX20.WAD, pk_doom_sfx_20120224.wad, D1DEHFIX.DEH) cannot be zipped and must be in the prboom subdir located within system (bios), not roms.

Contributor guide

Open the contributing guide

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 the Loading Doom section at https://docs.libretro.com/library/prboom/#loading-doom and locate its source in the documentation repository. Update the tvOS folder guidance for music, prboom.wad, additional WADs, and DEHs, including the distinction between zip-compatible Doom WADs and files that must remain unzipped; verify the rendered page reflects these details.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.