Skip to content

Installation

github-actions[bot] edited this page Oct 17, 2026 · 2 revisions

Installation

Cheevos is included in SpruceOS public and nightly releases. Open Apps → Cheevos to start it. You can also install or update it manually from the latest Cheevos release.

Requirements

  • SpruceOS 4.5.0+. Cheevos uses Spruce's own UI toolkit (PyUI) and Python, so it needs nothing else.
  • Any device supported by SpruceOS. Cheevos supports them all (see Themes and devices).
  • A RetroAchievements account, signed in on the device (in Spruce's RetroAchievements settings or in RetroArch), and its Web API key. See Setup.
  • Wi-Fi for the first sync. After that, Cheevos also works offline.

Manual install

  1. Download Cheevos-<version>.zip from the latest release on the repository's Releases page (not the "Source code" archives), or build it yourself with make package (see RELEASING.md in the repository).
  2. Unzip it on your computer, then copy the Cheevos folder into App on your SD card. You should end up with App/Cheevos/launch.sh.
  3. Put the SD card back, open Apps in Spruce's main menu and start Cheevos.

The first start asks for your Web API key (see Setup), then syncs your account. That spaces game downloads about 3 seconds apart: a few minutes for a big library. You can browse while it runs.

Update

Delete the old App/Cheevos folder, then copy in the new Cheevos folder as when installing. Your key, settings and synced data live in Saves/cheevos/, so they survive an update.

Remove

Delete App/Cheevos. To remove your key and settings too, delete Saves/cheevos.

Clone this wiki locally