Feature request: Highlighting UI elements

Open
  • Is something wrong?
#16 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
lua
Domain
frontend

Research direction

No files or tests are named. Start by reading the existing component modules and examples in prettyui to see how a UI element is identified and how overlays are drawn, then sketch a small public API for attaching a flashing rectangle to a named element. Done means the highlight can be demonstrated on one of the screenshots’ targets; treat sound, arrows and infoboxes as separate follow-ups unless the maintainer asks for them.

Written by the indexing model from the issue text.

Description

enhancement

As mentioned in the RuneScape Discord, it would be nice to have a way to highlight specific UI elements with a gold/flashing rectangle, in order to attract the user's attention. This feature is seen in the base game, during the guided/tutorial experience. See screenshots:

Image Image

Optionally, if possible, this type of highlight could be accompanied by an in-game sound effect, as well as arrows/infoboxes, mirroring the base game.

Dominant language
Lua
Stars
6
Forks
4
Avg merge
2d 7h
Merged PRs (30d)
18

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from PrettyRS/prettyui

All issues in PrettyRS/prettyui

Similar issues

More Lua issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.