Discord Support โข Installation โข French Documentation โข Troubleshoot / Common Errors โข
A free, user-friendly ROM downloader for Batocera, Knulli, and RetroBat with multi-source support.
SSH or Terminal access required:
curl -L bit.ly/rgsx-install | shAfter installation:
- Update game lists:
Menu > Game Settings > Update game list - Find RGSX under PORTS or Homebrew and ports
- Download: RGSX_full_latest.zip
- Extract:
- Batocera/Knulli: Extract
portsfolder to/roms/ - RetroBat: Extract both
portsandwindowsfolders to/roms/
- Batocera/Knulli: Extract
- Refresh:
Menu > Game Settings > Update game list
Download latest release : RGSX_update_latest.zip
Installed paths:
/roms/ports/RGSX(all systems)/roms/windows/RGSX(RetroBat only)
- Auto-downloads system images and game lists
- Auto-configures controls if your controller is recognized
- Controls broken? Delete
/saves/ports/rgsx/controls.jsonand restart
Keyboard Mode: When no controller is detected, controls display as [Key] instead of icons.
Controls
- View Controls Help
- Remap Controls
Display
- Layout (3ร3, 3ร4, 4ร3, 4ร4)
- Font Size (general UI)
- Footer Font Size (controls/version text)
- Font Family (pixel fonts)
- Hide Unknown Extension Warning
Games
- Download History
- Source Mode (RGSX / Custom)
- Update Game Cache
- Show Unsupported Platforms
- Hide Premium Systems
- Filter Platforms
Settings
- Background Music Toggle
- Symlink Options (Batocera)
- Web Service (Batocera)
- API Keys Management
- Language Selection
- ๐ฏ Smart System Detection โ Auto-discovers supported systems from
es_systems.cfg - ๐ฆ Intelligent Archive Handling โ Auto-extracts archives when systems don't support ZIP files
- ๐ Premium Unlocking โ 1Fichier API + AllDebrid/Real-Debrid fallback for unlimited downloads
- ๐จ Fully Customizable โ Layout (3ร3 to 4ร4), fonts, font sizes (UI + footer), languages (EN/FR/DE/ES/IT/PT)
- ๐ฎ Controller-First Design โ Auto-mapping for popular controllers + custom remapping support
- ๐ Advanced Filtering โ Search by name, hide/show unsupported systems, filter platforms
- ๐ Download Management โ Queue system, history tracking, progress notifications
- ๐ Custom Sources โ Use your own game repository URLs
- โฟ Accessibility โ Separate font scaling for UI and footer, keyboard-only mode support
For unlimited 1Fichier downloads, add your API key(s) to
/saves/ports/rgsx/:
1FichierAPI.txtโ 1Fichier API key (recommended)AllDebridAPI.txtโ AllDebrid fallback (optional)RealDebridAPI.txtโ Real-Debrid fallback (optional)Each file must contain ONLY the key, no extra text.
- Browse platforms โ Select game
- Direct Download: Press
Confirm - Queue Download: Press
X(West button) - Track progress in History menu or via popup notifications
Switch to custom sources via Pause Menu > Games > Source Mode.
Configure in /saves/ports/rgsx/rgsx_settings.json:
{
"sources": {
"mode": "custom",
"custom_url": "https://example.com/my-sources.zip"
}
}Note: If custom mode activated but Invalid/empty URL = using /saves/ports/rgsx/games.zip . You need to update games cache on RGSX menu after fixing URL.
RGSX includes a web interface that launched automatically when using RGSX for remote browsing and downloading games from any device on your network.
-
Find your Batocera IP address:
- Check Batocera menu:
Network Settings - Or from terminal:
ip addr show
- Check Batocera menu:
-
Open in browser:
http://[BATOCERA_IP]:5000orhttp://BATOCERA:5000- Example:
http://192.168.1.100:5000
- Example:
-
Available from any device: Phone, tablet, PC on the same network
- ๐ฑ Mobile-Friendly โ Responsive design works on all screen sizes
- ๐ Browse All Systems โ View all platforms and games
- โฌ๏ธ Remote Downloads โ Queue downloads directly to your Batocera
- ๐ Real-Time Status โ See active downloads and history
- ๐ฎ Same Game Lists โ Uses identical sources as the main app
From RGSX Menu
- Open Pause Menu (Start/ALTGr)
- Navigate to Settings > Web Service
- Toggle Enable at Boot
- Restart your device
Port Configuration: The web service runs on port 5000 by default. Ensure this port is not blocked by firewall rules.
/roms/ports/RGSX/
โโโ __main__.py # Entry point
โโโ controls.py # Input handling
โโโ display.py # Rendering engine
โโโ network.py # Download manager
โโโ rgsx_settings.py # Settings manager
โโโ assets/controls/ # Controller profiles
โโโ languages/ # Translations (EN/FR/DE/ES/IT/PT)
โโโ logs/RGSX.log # Runtime logs
/roms/windows/RGSX/
โโโ RGSX Retrobat.bat # RetroBat launcher
/saves/ports/rgsx/
โโโ rgsx_settings.json # User preferences
โโโ controls.json # Control mapping
โโโ history.json # Download history
โโโ rom_extensions.json # Supported extensions cache
โโโ systems_list.json # Detected systems
โโโ games/ # Game databases (per platform)
โโโ images/ # Platform images
โโโ 1FichierAPI.txt # 1Fichier API key
โโโ AllDebridAPI.txt # AllDebrid API key
โโโ RealDebridAPI.txt # Real-Debrid API key
| Issue | Solution |
|---|---|
| Controls not working | Delete /saves/ports/rgsx/controls.json + restart app, you can try delete /roms/ports/RGSX/assets/controls/xx.json too |
| No games ? | Pause Menu > Games > Update Game Cache |
| Missing systems on the list? | RGSX read es_systems.cfg to show only supported systems, if you want all systems : Pause Menu > Games > Show unsupported systems |
| App crashes | Check /roms/ports/RGSX/logs/RGSX.log |
| Layout change not applied | Restart RGSX after changing layout |
| Downloading BIOS file is ok but you can't download any games? | Activate custom DNS on Pause Menu> Settings and reboot , server can be blocked by your ISP. check any threat/website protection on your router too, especially on ASUS one |
Need help? Share logs from /roms/ports/RGSX/logs/ on Discord.
- Bug Reports: Open GitHub issue with logs or post on Discord
- Feature Requests: Discuss on Discord first, then open issue
- Code Contributions:
git checkout -b feature/your-feature # Test on Batocera/RetroBat # Submit Pull Request
Free and open-source software. Use, modify, and distribute freely.
If you want to support my project you can buy me a beer : https://bit.ly/donate-to-rgsx
Developed with โค๏ธ for the retro gaming community.