Improve main overlay UX and startup guidance

[saulob]

Summary

This PR improves the first-use experience and general usability of the main Sunrise overlay

It adds

• A close button to the main overlay
• A startup hint showing the configured overlay key
• A HUD option to enable or disable the startup hint
• README guidance explaining how to open and close the overlay

Why

The default overlay key is currently documented in the FAQ

This change brings that information closer to the places where a new user is most likely to need it

The README now provides the basic first-use instruction, while the in-game startup hint makes the configured key immediately discoverable without requiring the user to leave the game

The FAQ remains the detailed reference for changing the key and other configuration information

Main overlay close button

The main overlay now has an X button in the top-right corner

It uses the existing overlay visibility state and closes it directly through the visibility runtime, without simulating the configured keyboard shortcut

The configured keyboard shortcut continues to work normally

This also gives mouse users a visible and familiar way to close the menu

Startup hint

A small startup hint appears shortly after Sunrise initializes

Example

Press INSERT to open the Sunrise overlay

The key is not hardcoded

It uses the actual configured client.ui.toggle_key, so configurations such as F12, Home or the other supported keys are reflected automatically

Behavior

• Appears after approximately 2 seconds
• Uses a subtle fade-in and fade-out
• Remains visible for approximately 30 seconds
• Disappears immediately when the main overlay is opened
• Appears only once per game process
• Can be disabled from the HUD page through the new Startup Hint option
• Defaults to enabled for both new installations and existing HUD configurations that do not yet contain the setting

HUD positioning

The hint adapts to the currently visible top-left HUD content

If the Sunrise Card is enabled, the hint appears beside it

If the Sunrise Card is disabled, the hint appears beside the first visible HUD overlay instead

If no other HUD overlay is visible, the hint uses the normal top-left HUD position

This keeps the existing vertical HUD stack unchanged and avoids overlapping other HUD elements

README

A short Opening the overlay section was added to the README

It documents

• Insert as the default overlay key
• Opening and closing the overlay
• The settings.json location
• A link to the existing FAQ for additional information

The intention is to complement the existing FAQ with a quick first-use reference directly in the repository

Testing

Tested in-game with

• Closing the main overlay using the new X button
• Reopening and closing normally with the configured key
• Startup hint with the default Insert key
• Startup hint with F12 configured in settings.json
• Automatic dismissal when opening the overlay
• Automatic fade-out after the display period
• Sunrise Card enabled
• Sunrise Card disabled
• Other HUD overlays enabled with the Sunrise Card disabled
• Startup Hint HUD toggle

Screenshot

[stanuwu]

• don't use internal imgui api
• don't fake keypress
• don't hand-pick animation id

[saulob]

• don't use internal imgui api
• don't fake keypress
• don't hand-pick animation id

Thanks, addressed all three points

• Removed the internal ImGui API and replaced the close button with public ImGui APIs
• The close button now hides the overlay directly instead of going through the keyboard toggle path
• Removed the hand-picked animation ID and made the startup hint manage its fade locally

I also rebased the branch onto the current master and retested the close behavior