libretro / libretro/docs

Confusing/missing documentation on bsnes cores

Open
#958 3 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

For the longest time I've been pretty confused about the state of bsnes derived libretro cores available via RetroArch. But I think most of my confusion stems from the fact that the bsnes core (by which I mean bsnes-libretro), does not seem to have any documentation, and some of the cores seem to have their names changed now and this is not reflected in the docs.

The following bsnes/higan cores are listed in the documentation:

  • Beetle bsnes
  • bsnes Accurary
  • bsnes Balanced
  • bsnes Performance
  • bsnes C++98 (v085)
  • bsnes-mercury Accurary
  • bsnes-mercury Balanced
  • bsnes-mercury Performance
  • higan Accuracy

The following bsnes/higan cores are listed in the online updater when firing up vanilla RetroArch 1.19.1:

  • bsnes 2014 Accuracy
  • bsnes 2014 Balanced
  • bsnes 2014 Performance
  • bsnes
  • bsnes-hd-beta
  • bsnes-mercury Accurary
  • bsnes-mercury Balanced
  • bsnes-mercury Performance

Now I can only assume that "bsnes Accuracy" etc have been renamed to "bsnes 2014 Accuracy" etc? And that "higan Accuracy" and "Beetle bsnes" have been removed? And the the plain "bsnes" core is now the most up to date wit upstream? I'm also confused about the standalone "bsnes-hd-beta" core since I thought DerKoun's work was upstreamed into mainline bsnes?

Either way, this is very confusing, and I can honestly barely figure out which core is based on which version of the upstream bsnes, and which features each and every one of them supports. I personally care a lot about those details when picking a core, so it's a bit frustrating the way it's laid out right now.

I'm fairly sure I just want the plain "bsnes" core, but I actually didn't know it existed because I never saw it listed in the documentation.

I think this could use some cleaning up and/or clarification. Thank you!

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 comparing the bsnes/higan entries in the current documentation with the core names shown by RetroArch 1.19.1's online updater. Verify each core's upstream/version relationship and supported features; done means the documentation clearly lists current cores, explains renamed or removed entries, and identifies what each core supports.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.