beyond-all-reason/Beyond-All-Reason

New ingame Setting Button that opens uikeys.txt

Open

#3369 opened on Jul 11, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Lua (3,922 stars) (592 forks)batch import
EnhancementGood First IssueUI

Description

Description

Currently, it's hard to figure out how to change your hotkeys, and it's a hassle to dig into obscure folders every time, especially for new players.

Why?

A lot of people struggle with figuring out how to change hotkeys. This is the least we could do to help them.

What area of the game does this feature request pertain?

Settings, Controls or Hotkeys

Other (optional)

No response

Contributor guide

Tech stack
None
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Lua scriptingknowledge of the game's UI framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Look into the game's settings UI code, likely in Lua scripts under the 'settings' or 'gui' directory. Identify the existing settings button(s) and replicate the pattern to add a new button that triggers opening the uikeys.txt file. Consider using platform specific file open commands (e.g., `os.execute('start uikeys.txt')` on Windows). Check if the file path is stored somewhere or needs to be constructed. The implementer should comment on the issue before starting to clarify the expected location of the button and any design constraints.