---

CheevoWidgets creates live RetroAchievements Web Widgets for OBS, iiSU, and other apps that can display a web page. This repository is the place for issues, widget ideas, and documentation.

The currently available version is an early preview. It lets you create a fixed RA Profile widget using your RetroAchievements username and Web API key.

Preview status

The preview currently includes:

• RA Profile widget
• Live data from the RetroAchievements API
• A self-contained Web Widget URL
• Support for OBS Browser Sources and iiSU Web Widgets (and everything that supports Web Widgets)

Templates, colors, additional styles, saved widgets, and live editing are planned for the full release.

How do I use the Web Widget?

1. Open the CheevoWidgets Builder.
2. Enter your RetroAchievements username and Web API key.
3. Copy the generated Web Widget URL.
4. Add the URL to an app that supports web content.

OBS

Add a Browser source to your OBS scene and paste the copied Web Widget URL into its URL field.

iiSU

Add a Web Widget to your iiSU layout and paste the copied Web Widget URL into the widget's URL field.

Widgets

The following widgets are available or planned:

• RA Profile -> available in the preview
• Leaderboard -> planned
• Want to play -> planned
• Unlock graph -> planned

Have an idea for another widget? Open an issue :)

The URL

Everything the preview widget needs is stored in the URL fragment. The part after the #. There is no account, login, or saved widget record in the preview.

The URL fragment is not included in requests to the CheevoWidgets server. The widget reads it inside the browser or WebView and calls the RetroAchievements API directly. Your Web API key is therefore not sent to or stored by CheevoWidgets.

Warning

The generated URL contains your RetroAchievements Web API key. Treat it like a password: do not share it or post it publicly. Only paste it into trusted applications such as your OBS Browser Source or iiSU Web Widget.

Live editing

Live editing is not available in the preview. If you change your username or API key, generate and paste a new URL.

The full release is planned to support saved widgets with an ID, allowing changes from the builder to appear in the Web Widget without copying the URL again.

What does the preview store?

The preview does not save your RetroAchievements username, Web API key, or widget configuration in a widget database. The generated URL remains the source of the widget configuration.

Anonymous counters may record that a URL was copied or that a widget was active. These counters do not contain your username, API key, or widget configuration.