Skip to content

Installation & Setup

You are installing the current alpha build: v1.0.0-alpha1.

Prerequisites

These setup steps are for the Android app.

Before using RAOfflineProxy on Android, enter your RetroAchievements account details in RetroArch. RAOfflineProxy first uses RetroArch's saved cheevos_token when present. If no token is available, it uses cheevos_username and cheevos_password once to retrieve and cache a token.

In RetroArch:

  1. Open Settings → Achievements
  2. Enter your RetroAchievements Username and Password (or API Token)
  3. Save the settings

Step 1: Install RAOfflineProxy

Install the APK on your Android device. You can download the latest alpha prerelease from GitHub Releases or build from source.

Step 2: Start the Proxy

Start the proxy while you are online. RAOfflineProxy will import your saved RetroAchievements login automatically. On some devices, you may also need to grant folder access.

  1. Make sure you are online
  2. Start the proxy

Shutdown caveat

On some devices, swiping the app away or crashing while the proxy is active does not reliably revert retroarch.cfg immediately. Stop sync before killing the app. If that happens, reopen RAOfflineProxy once so it can clean up retroarch.cfg.

Step 3: Cache Your Games

Once the proxy has been started and your credentials have been imported, you can cache games for offline use.

  1. Navigate to Cached Games in the drawer
  2. Choose one of:
    • Scan ROM folder: picks a folder and scans all ROMs in it
    • Add ROM: picks individual ROM file(s)

The app will identify each ROM, look it up on RetroAchievements, and save all the achievement data for that game.

Manual caching is capped at 50 games to limit bulk server requests to RetroAchievements. The Cached Games screen shows the current total as X/50 cached while the proxy is running.

Automatic caching when launching games

Caching also happens automatically when you open a game in RetroArch while the proxy is running and you are online - the proxy saves the game data in the background. Manual scanning is only needed if you want to pre-cache games before going offline without launching them first.

See Caching Games for full details.

Step 4: Play Offline

  1. Start the proxy service (press Start proxy in the action bar, or enable auto-start)
  2. Launch RetroArch and load a cached game
  3. Earn achievements - they will queue locally when offline
  4. When you reconnect, the proxy automatically sends queued awards to RA

Test with the SNES Burn-in Test Cartridge

The SNES Burn-in Test Cartridge Test Kit is the perfect game to verify everything works. The "I Can Move!" achievement is very easy to earn, and you can reset it on the achievement details page to test again. Great for confirming that offline queuing and syncing work correctly.

Quick-start Summary

1. Install APK
2. Enter RA credentials in RetroArch
3. Open RAOfflineProxy → Start proxy while online
4. Cache your games from **Cached Games** or just start them while online to cache them automatically
5. Play!