Skip to content
ɳSelf Docs

retro-gaming

Retro Gaming Plugin

Section titled “Retro Gaming Plugin”

ROM library management, emulator core integration, save state sync, controller configuration. Pro plugin.

Requires: Basic license tier or higher. nself license set nself_pro_...

Install

Section titled “Install”
Terminal window
nself license set nself_pro_xxxxx...
nself plugin install retro-gaming

What It Does

Section titled “What It Does”

The retro-gaming plugin manages your self-hosted ROM library and emulator cores. It handles save state synchronisation across sessions, persists per-user controller configurations, and tracks achievements enabled during play.

Configuration

Section titled “Configuration”
Env VarDefaultDescription
RETRO_GAMING_PORT3124Port the service listens on
RETRO_STORAGE_PATHnoneFilesystem path for ROM and save-state storage

Ports

Section titled “Ports”
PortPurpose
3124Retro gaming REST API

Database Tables

Section titled “Database Tables”

6 tables added to your Postgres database:

  • np_retro_gaming_roms
  • np_retro_gaming_cores
  • np_retro_gaming_saves
  • np_retro_gaming_configs
  • np_retro_gaming_sessions
  • np_retro_gaming_achievements

Nginx Routes

Section titled “Nginx Routes”
RouteTarget
/api/retro-gaming/localhost:3124