libretro / libretro/RetroArch

Need description/clarification for the 2 "UI Companion" settings.

Open
#11,134 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
14.1k
Forks
2.2k
Avg merge
7h 35m
Merged PRs (30d)
51

Description

Description

Hey! So with "Show Advanced Settings" ON, in the User Interface menu you get 2 UI Companion settings: "UI Companion" (OFF by default) and "Start UI Companion on Boot" (ON by default). But no matter if I toggle them it doesn't seem to change anything at all :x

I did some googling and from what I understand it's just another name for the Desktop Menu? But the Desktop Menu already has 2 similar options ("Desktop Menu" and "Open Desktop Menu on Startup") so that doesn't really make sense.

So, 2 questions:

  • Could it be a mistake? Like idk, the options were renamed at some point and they were left in by mistake?
  • If they're legit settings (I mean for devs or debugging purpose for example), could we get a small description, please? Or at least some clarification about what they do in the replies of this issue? :p
Expected behavior

Do something? Or if it's not something obvious for the user, having a description would be great.

Actual behavior

Doesn't seem to do anything, at least to regular user eyes.

Steps to reproduce the bug
  1. Go to Settings > User Interface and enable "Show Advanced Settings".
  2. Play with the "UI Companion" settings and restart RetroArch.
  3. ???
Bisect Results

Looks like these 2 settings started to appear here: 1fe213de8c13a1cdbe714684f71b15742686133c

Version/Commit
  • RetroArch: 1.8.9 / f35010e
Environment information
  • OS: Windows 10 and Linux Mint.

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 reviewing commit 1fe213de8c13a1cdbe714684f71b15742686133c and the Settings > User Interface entries for "UI Companion" and "Start UI Companion on Boot." Determine whether the settings are functional or duplicates of the Desktop Menu options; done means either removing mistaken options or documenting their behavior clearly for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.