libretro / libretro/docs

Switchres has sorely inadequate documentation

Open
#946 9 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

Description

Switchres doesn't work because I don't know how to make it work. All tutorials are outdated by years, and the documentation explains extraordinarily little about how to actually get it to function properly.

Expected behavior

I expect to be able to find a resource that can explain to me very clearly how to get switchres to work on any television CRTs or VGA monitors I have connected to my computer.

Actual behavior

I've spent an entire week trying to get it to work. On an RTX 3080, switchres does nothing. On a Radeon 5450 and CRTEmudriver, it causes Retroarch to crash.

Steps to reproduce the bug

Literally just go here and read it and come away still knowing nothing: https://docs.libretro.com/guides/crtswitchres/

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 linked docs.libretro.com/guides/crtswitchres/ guide and review the reported RTX 3080, Radeon 5450, CRTEmudriver, and RetroArch cases. Map which current CRT and VGA-monitor setups need coverage, then consider the work done when the guide clearly explains setup and expected behavior for the supported configurations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.