libretro / libretro/docs

Document convention for optional OS suffixes in core filenames

Open
#1,176 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

While many Libretro cores use an OS suffix in their filenames (e.g., _android, _ios, _tvos), this suffix is not strictly required.

Background & Problem

Some cores do not contain these suffixes, which has occasionally caused user confusion, leading to redundant issue reports and pull requests submitted purely for consistency.

Cores without OS suffixes (Examples)

Note: All cores in the buildbot links not listed here include OS suffixes.


URL: https://buildbot.libretro.com/nightly/android/latest/arm64-v8a/

azahar_libretro.so.zip


URL: https://buildbot.libretro.com/nightly/apple/ios-arm64/latest/

anarch_libretro.dylib.zip
applewin_libretro.dylib.zip
ardens_libretro.dylib.zip
arduous_libretro.dylib.zip
azahar_libretro.dylib.zip
bbkemu_libretro.dylib.zip
clownmdemu_libretro.dylib.zip
dingooemu_libretro.dylib.zip
dirksimple_libretro.dylib.zip
dolphin_libretro.dylib.zip
doukutsu_rs_libretro.dylib.zip
easyrpg_libretro.dylib.zip
flycast_libretro.dylib.zip
gam4980_libretro.dylib.zip
holani_libretro.dylib.zip
irogb_libretro.dylib.zip
mcsoftserve_libretro.dylib.zip
melondsds_libretro.dylib.zip
mgba_libretro.dylib.zip
mojozork_libretro.dylib.zip
native32emu_libretro.dylib.zip
ppsspp_libretro.dylib.zip
romcleaner_libretro.dylib.zip
rustynes_libretro.dylib.zip
skyemu_libretro.dylib.zip
squirreljme_libretro.dylib.zip
thepowdertoy_libretro.dylib.zip
vircon32_libretro.dylib.zip
wasm4_libretro.dylib.zip
ymir_libretro.dylib.zip


URL: https://buildbot.libretro.com/nightly/apple/ios9/latest/

anarch_libretro.dylib.zip
ardens_libretro.dylib.zip
arduous_libretro.dylib.zip
clownmdemu_libretro.dylib.zip
easyrpg_libretro.dylib.zip
gam4980_libretro.dylib.zip
mcsoftserve_libretro.dylib.zip
mgba_libretro.dylib.zip
squirreljme_libretro.dylib.zip
wasm4_libretro.dylib.zip


URL: https://buildbot.libretro.com/nightly/apple/tvos-arm64/latest/

anarch_libretro.dylib.zip
applewin_libretro.dylib.zip
ardens_libretro.dylib.zip
arduous_libretro.dylib.zip
azahar_libretro.dylib.zip
bbkemu_libretro.dylib.zip
clownmdemu_libretro.dylib.zip
dingooemu_libretro.dylib.zip
dirksimple_libretro.dylib.zip
dolphin_libretro.dylib.zip
doukutsu_rs_libretro.dylib.zip
easyrpg_libretro.dylib.zip
flycast_libretro.dylib.zip
gam4980_libretro.dylib.zip
holani_libretro.dylib.zip
irogb_libretro.dylib.zip
mcsoftserve_libretro.dylib.zip
melondsds_libretro.dylib.zip
mgba_libretro.dylib.zip
mojozork_libretro.dylib.zip
native32emu_libretro.dylib.zip
ppsspp_libretro.dylib.zip
romcleaner_libretro.dylib.zip
rustynes_libretro.dylib.zip
skyemu_libretro.dylib.zip
squirreljme_libretro.dylib.zip
thepowdertoy_libretro.dylib.zip
vircon32_libretro.dylib.zip
wasm4_libretro.dylib.zip
ymir_libretro.dylib.zip

Related discussions/issues
Proposed Action

Update the official documentation regarding the mandatory _libretro filename convention to explicitly clarify that OS suffixes are popular and recommended for specific platform builds, but ultimately optional. (Note: The exact location of this document needs to be identified.) This update will help prevent future confusion, unnecessary bug reports, and pull requests attempting to 'fix' missing suffixes.

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 by locating the official documentation section covering the mandatory _libretro filename convention, then review the buildbot examples and related discussions linked in the issue. Update the documentation to state that OS suffixes are recommended for platform builds but optional, and confirm that the convention is unambiguous to users.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.