Skip to content

Repository files navigation

Vimm's Cheevos

Latest release Downloads Stars Issues

A cross-browser extension that checks whether a game file hosted on Vimm's Lair is supported by RetroAchievements, matching files names using the No-Intro (cartridge-based systems) and Redump (disc-based systems) naming both sites share.

demo.mp4

Installation

Check out the Releases tab, download and extract the respective version for your browser.

For Chromium-based browsers

  1. Navigate to chrome://extensions
  2. Enable Developer mode in the top-right
  3. Click Load unpacked
  4. Select the extracted folder

For Firefox and their forks

  1. Navigate to about:debugging#/runtime/this-firefox
  2. Click Load Temporary Add-on...
  3. Select the manifest.json file inside the extracted folder

RetroAchievements Web API key

This extension expects you have signed up for a RetroAchievements account as you'll need to provide your username and personal Web API key. This is because RA's API is designed around per-user keys and there's rate limiting in place. Read more about RA's API access.

Your key is safely stored. Your key is never sent anywhere except to RetroAchievements.

Usage

  1. After installing via the steps above, open Vimm's Lair.
  2. A new button is injected to the sidebar and clicking it opens a settings dialog for the extension.
  3. Follow the instructions on screen - provide your RA username and personal Web API key.
    As you type, the extension saves automatically.
  4. Close the dialog and refresh.
  5. Opening a game page should now show whether that specific variant is supported by RA.
image image image image

Contributing

Issues and pull requests are welcome. If you run into a game that reports incorrectly or a system that isn't working as expected, please open an issue with the game page URL and platform.

Disclaimer

This project is not affiliated with Vimm's Lair or RetroAchievements. It simply cross-references publicly available data.

License

MIT

About

A cross-browser extension for checking if a Vimm's Lair game file is supported by RetroAchievements, using No-Intro and Redump naming.

Topics

Resources

Stars

15 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages