libretro / libretro/docs

create Audio Skew documentation

Open
#324 1 comment 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

This might be added to an existing doc, or could be its own.

User docs:

  • Explain that audio skew is one of the the libretro technologies that allows emulator cores to recreate gameplay across very different hardware
  • Specifically audio skew....
  • Use Robocop as an example -- with audio recordings -- and explain the emulation quality compromises that come with and without the audio skew
  • RetroArch's design philosophy is to encourage smooth entry into the emulation and therefore RA uses a relatively high default audio skew threshold of 0.05, etc.

Developer docs:

  • Perhaps stub out an addition to the Dynamic Rate Control doc and expand the scope to also include audio skew?

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 existing Dynamic Rate Control documentation and review how the docs are organized for a possible user-facing addition. Use the requested Robocop audio recordings as the example, and cover audio skew, the 0.05 default threshold, and the quality trade-offs; done means both the user explanation and developer documentation stub are present.

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
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.