Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Multi Platforms Games Download Center . This repository is not affiliated with Batocera, Retrobat or Pixel Nostalgia RGS

Notifications You must be signed in to change notification settings

RetroGameSets/RGSX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽฎ Retro Game Sets Xtra (RGSX)

Discord Support โ€ข Installation โ€ข French Documentation โ€ข Troubleshoot / Common Errors โ€ข

A free, user-friendly ROM downloader for Batocera, Knulli, and RetroBat with multi-source support.

platform menu controls help

web interface api menu


๐Ÿš€ Installation

Quick Install (Batocera / Knulli)

SSH or Terminal access required:

curl -L bit.ly/rgsx-install | sh

After installation:

  1. Update game lists: Menu > Game Settings > Update game list
  2. Find RGSX under PORTS or Homebrew and ports

Manual Install (All Systems)

  1. Download: RGSX_full_latest.zip
  2. Extract:
    • Batocera/Knulli: Extract ports folder to /roms/
    • RetroBat: Extract both ports and windows folders to /roms/
  3. Refresh: Menu > Game Settings > Update game list

Manual Update (if automatic update failed)

Download latest release : RGSX_update_latest.zip

Installed paths:

  • /roms/ports/RGSX (all systems)
  • /roms/windows/RGSX (RetroBat only)

๐ŸŽฎ Usage

First Launch

  • Auto-downloads system images and game lists
  • Auto-configures controls if your controller is recognized
  • Controls broken? Delete /saves/ports/rgsx/controls.json and restart

Keyboard Mode: When no controller is detected, controls display as [Key] instead of icons.

Pause Menu Structure

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

โœจ Features

  • ๐ŸŽฏ 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

๐Ÿ”‘ API Keys Setup

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.

Downloading Games

  1. Browse platforms โ†’ Select game
  2. Direct Download: Press Confirm
  3. Queue Download: Press X (West button)
  4. Track progress in History menu or via popup notifications

Custom Game Sources

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.


๐ŸŒ Web Interface (Batocera/Knulli Only)

RGSX includes a web interface that launched automatically when using RGSX for remote browsing and downloading games from any device on your network.

Accessing the Web Interface

  1. Find your Batocera IP address:

    • Check Batocera menu: Network Settings
    • Or from terminal: ip addr show
  2. Open in browser: http://[BATOCERA_IP]:5000 or http://BATOCERA:5000

    • Example: http://192.168.1.100:5000
  3. Available from any device: Phone, tablet, PC on the same network

Web Interface Features

  • ๐Ÿ“ฑ 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

Enable/Disable Web Service at Boot, without the need to launch RGSX

From RGSX Menu

  1. Open Pause Menu (Start/ALTGr)
  2. Navigate to Settings > Web Service
  3. Toggle Enable at Boot
  4. Restart your device

Port Configuration: The web service runs on port 5000 by default. Ensure this port is not blocked by firewall rules.


๐Ÿ“ File Structure

/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

๐Ÿ› ๏ธ Troubleshooting

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.


๐Ÿค Contributing

  • 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

๐Ÿ“ License

Free and open-source software. Use, modify, and distribute freely.

Thanks to all contributors, and followers of this app

If you want to support my project you can buy me a beer : https://bit.ly/donate-to-rgsx Stargazers over time

Developed with โค๏ธ for the retro gaming community.

About

Multi Platforms Games Download Center . This repository is not affiliated with Batocera, Retrobat or Pixel Nostalgia RGS

Resources

Stars

Watchers

Forks

Packages

No packages published