Retrom 是面向个人和可信朋友的自托管多平台浏览器游戏库。集中整理游戏,直接在浏览器中游玩,随时从存档继续进度。
管理员维护共享游戏库,每个用户拥有独立的存档、收藏夹和最近游玩记录。
通过封面、游戏详情、平台分类、共享标签和搜索筛选找到想玩的游戏,在浏览器中启动。支持普通界面和手柄沉浸界面。
支持即时存档与游戏原生存档,提供截图预览、重命名、搜索筛选和恢复入口,方便找到想要继续的进度。
按平台、系列或主题建立收藏夹,在首页查看最近玩过和一直喜欢的游戏。
支持 NES、SNES、Mega Drive、GBA、Nintendo DS、街机,以及 RPG Maker、ONScripter、Siglus 等引擎游戏。平台与核心由配套的 retrom-runtime 提供,具体游戏格式、输入方式和存档类型随核心而异。
准备 Linux 服务器、Docker Engine 和 Compose,以及应用域名、游戏隔离泛域名和覆盖两者的 HTTPS 证书。发行镜像已包含应用及配套运行资源,游戏和 BIOS 由管理员自行准备。
- 从 Releases 选择发行版本。
- 按照 Docker 部署指南 获取该版本的 Compose 和 Nginx 配置,设置域名、HTTPS、持久数据目录并启动服务。
- 打开
https://你的域名/setup创建首个管理员。 - 在“游戏目录”创建目录,再从“游戏入库 → 来源扫描”导入游戏,审核并发布。
首次安装、版本兼容、备份和升级的具体步骤均见部署指南。
管理员通过服务器目录扫描导入 Pegasus / EmulationStation 来源,整理资料、试玩审核后发布,也可替换已入库游戏的文件、封面和视频。
| 管理能力 | 用途 |
|---|---|
| 目录与核心 | 配置平台目录、可用核心和默认核心 |
| 运行依赖 | 安装 BIOS,查看并补齐缺失依赖与街机父包 |
| 资料与标签 | 维护游戏详情、封面、视频和共享标签 |
| 账号管理 | 管理用户、邀请和密码重置 |
| 文档 | 内容 |
|---|---|
| Docker 部署指南 | 安装配置、启动检查、数据备份、升级与故障排查 |
| 文档索引 | 使用、管理和开发文档的完整入口 |
| 导入与审核 | 来源扫描、游戏审核和内容维护 |
| 运行与存档 | 游戏运行、存档保存与恢复 |
| 账号、配置与部署 | 账号管理、服务配置和反向代理 |
后端使用 Go,前端使用 Next.js / TypeScript。持久数据存放在 PostgreSQL 中,临时运行状态由 Redis 管理;游戏运行与核心适配由 retrom-runtime 提供。
联合开发使用 retrom-project 工作区中的命名 PFB。环境准备和日常开发流程见 PFB 开发说明,检查命令和测试要求见工程质量与测试。贡献代码前请阅读 AGENTS.md。
本项目不附带商业游戏或 BIOS。






