romm

(★ 12,181)

A beautiful, powerful, self-hosted rom manager and player.

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- - setup-code-signing.sh
- settings.json
- dev.env
- devcontainer.json
- - bug_report.md
  - config.yml
  - custom.md
  - feature_request.md
  - ui-ux.md
- - aikido-badge.svg
  - discord-badge.svg
  - greptile-badge.svg
  - hackernews-badge.svg
  - isotipo.png
  - isotipo.svg
  - logotipo.png
  - logotipo.svg
  - opencollective-badge.svg
  - romm-winter.png
  - selfhst-badge.svg
  - social_preview.png
  - social_preview.svg
  - trendshift-badge.svg
- - seed_e2e_library.py
  - seed_e2e_users.py
- - build.yml
  - copilot-setup-steps.yml
  - e2e.yml
  - frontend-v1-frozen.yml
  - frontend.yml
  - i18n.yml
  - migrations.yml
  - pytest.yml
  - test-build.yml
  - trunk-check.yml
  - typecheck.yml
  - update-hltb-api-url.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- - .bandit
  - .hadolint.yaml
  - .isort.cfg
  - .markdownlint.yaml
  - .prettierrc.yaml
  - .shellcheckrc
  - .yamllint.yaml
  - mypy.ini
  - ruff.toml
  - svgo.config.js
- - action.yaml
- .gitignore
- trunk.yaml
- settings.json
- tasks.json
- - __init__.py
- - env.py
  - script.py.mako
- - __init__.py
  - config_manager.py
- - __init__.py
  - auth.py
  - database.py
- - __init__.py
  - activity.py
  - auth.py
  - client_tokens.py
  - collections.py
  - configs.py
  - device.py
  - device_auth.py
  - export.py
  - feeds.py
  - firmware.py
  - heartbeat.py
  - logs.py
  - music.py
  - music_playlists.py
  - netplay.py
  - permissions.py
  - platform.py
  - play_sessions.py
  - saves.py
  - screenshots.py
  - search.py
  - states.py
  - stats.py
  - streaming.py
  - sync.py
  - tasks.py
  - user.py
- - __init__.py
  - auth_exceptions.py
  - config_exceptions.py
  - endpoint_exceptions.py
  - fs_exceptions.py
  - socket_exceptions.py
  - task_exceptions.py
- - __init__.py
  - activity_handler.py
  - netplay_handler.py
  - play_session_handler.py
  - redis_handler.py
  - rom_conversion.py
  - rq_worker.py
  - scan_handler.py
  - socket_handler.py
- - __init__.py
  - formatter.py
  - log_stream_handler.py
  - logger.py
- - __init__.py
  - assets.py
  - base.py
  - client_token.py
  - collection.py
  - device.py
  - device_save_sync.py
  - firmware.py
  - music.py
  - permission.py
  - platform.py
  - play_session.py
  - rom.py
  - sync_session.py
  - user.py
- - setup.sql
- - __init__.py
  - sync_push_pull_task.py
  - tasks.py
- - __init__.py
  - _zipfile_shim.py
  - conftest.py
  - test_nginx_cache_headers.py
  - test_startup.py
  - test_sync_watcher.py
  - test_utils_auth.py
- - generate_supported_platforms.py
  - generate_test_data.py
  - xml_diagnostics.py
- - __init__.py
  - archives.py
  - audio_tags.py
  - auth.py
  - background_tasks.py
  - cache.py
  - client_tokens.py
  - context.py
  - database.py
  - datetime.py
  - device_auth.py
  - emoji.py
  - filesystem.py
  - gamelist_exporter.py
  - hashing.py
  - json_module.py
  - m3u.py
  - media_types.py
  - nginx.py
  - pegasus_exporter.py
  - platforms.py
  - psp_hasher.py
  - rate_limiter.py
  - router.py
  - rvz_hasher.py
  - screenshots.py
  - ssrf.py
  - update_hltb_api_url.py
  - uploads.py
  - urls.py
  - validation.py
  - zip_cache.py
- .coveragerc
- __version__.py
- alembic.ini
- conftest.py
- docker-compose.test.yml
- main.py
- pytest.ini
- startup.py
- sync_watcher.py
- watcher.py
- - logging.conf
- - docker-entrypoint.sh
  - init
- - default.conf
- build_local_image.sh
- Dockerfile
- Dockerfile.dockerignore
- BACKEND_ARCHITECTURE.md
- FRONTEND_ARCHITECTURE.md
- config.batocera-retrobat.yml
- config.es-de.example.yml
- config.example.yml
- docker-compose.example.yml
- - main.ts
  - preview.ts
- - auth_background.svg
  - auth_background_static.png
  - auth_background_static.svg
  - isotipo.png
  - isotipo.svg
  - logotipo.png
  - logotipo.svg
- - auth.setup.ts
  - game-media-files.spec.ts
  - login.spec.ts
  - profile-role.spec.ts
  - README.md
  - rom-actions.spec.ts
- - android-chrome-192x192.png
  - android-chrome-512x512.png
  - apple-touch-icon.png
  - favicon-16x16.png
  - favicon-32x32.png
  - favicon.ico
  - favicon.svg
  - site.webmanifest
- - build-tokens.ts
- - main.ts
  - RomM.vue
- .browserslistrc
- .npmrc
- .nvmrc
- eslint.config.js
- index.html
- jsconfig.json
- package-lock.json
- package.json
- playwright.config.ts
.dockerignore
.gitattributes
.gitignore
.python-version
AGENTS.md
CLAUDE.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DEVELOPER_SETUP.md
docker-compose.yml
Dockerfile
entrypoint.sh
env.template
LICENSE
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/rommapp/romm

Downloads the entire project code from GitHub to your computer.

cd romm

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f backend/docker-compose.test.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd backend/utils/rom_patcher

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

romm

File Explorer

# Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

romm

File Explorer

# Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

Download README