Getting Started

Getting Started

Prerequisites

• A running RomM instance (https://github.com/rommapp/romm)
• RomM version 4.x or later recommended
• Your RomM server URL (e.g. http://100.119.139.93:8285 or https://romm.yourdomain.com)
• Your RomM username and password OR an API key from RomM Settings → Client API Tokens

Download and Install

• Download the latest release from GitHub Releases
• Windows: run the installer or extract the .zip
• macOS: extract the .dmg or .tar.xz, move Freegosy.app to Applications
• macOS note: if blocked by Gatekeeper, right-click → Open

First Launch

1. Open Freegosy
2. Go to Settings → RomM Connection
3. Enter your server URL, username, and password (or paste API key)
4. Tap Connect — your library will load automatically
5. Platforms with zero games are filtered out automatically

API Key Authentication (Recommended)

1. Go to RomM web UI → Settings → Client API Tokens
2. Generate a new token
3. Paste it into Freegosy Settings → API Key field
4. API key auth is more stable than username/password for long sessions