## 1. Project Overview & Quickstart (rommapp/LICENSE) # LICENSE Open-source repository rommapp/LICENSE ### Repository Details - **Repository:** [rommapp/LICENSE](https://github.com/rommapp/LICENSE) - **Primary Language:** Code *Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.* ## 2. Official Technical Reference & Guides (rommapp/docs) ## File: README.md # Overview This is the [official documentation](https://docs.romm.app) repository of [RomM](https://romm.app/), the beautiful, powerful self-hosted ROM manager and player. # Contributing To contribute to RomM's documentation, please check [Contribution Guide](CONTRIBUTING.md). # Community Join us on Discord, where you can ask questions, submit ideas, get help, showcase your collection, and discuss RomM with other users. [![discord-invite]][discord-invite-url] [license-badge-img]: https://img.shields.io/github/license/rommapp/docs?style=for-the-badge&color=a32d2a [license-badge]: LICENSE [discord-badge-img]: https://img.shields.io/badge/discord-7289da?style=for-the-badge [discord-badge]: https://discord.gg/P5HtHnhUDH [discord-invite]: https://invidget.switchblade.xyz/P5HtHnhUDH [discord-invite-url]: https://discord.gg/P5HtHnhUDH --- ## File: docs/index.md --- title: Introduction hide: - toc --- /// caption Welcome to the **RomM Project**, the premier self-hosted, open source ROM manager. /// [Website](https://romm.app) · [Demo](https://demo.romm.app) · [Discord](https://discord.gg/romm) RomM (ROM Manager) lets you scan, enrich, organise, and play your game collection from a clean web UI, with metadata from IGDB, ScreenScraper, MobyGames, RetroAchievements, Hasheous, LaunchBox, and more. In-browser play via EmulatorJS and Ruffle, companion apps for Android, handhelds, and desktop, and a first-class multi-user experience with OIDC SSO. ## Where do you want to go? - :material-rocket-launch-outline: **I'm new, get me running** *** 15 minute Docker Compose walkthrough to a working instance. [Quick Start →](getting-started/quick-start.md) - :material-cog-outline: **I'm running RomM for my family/friends** *** Users, roles, OIDC, scheduled tasks, backups, reverse-proxy recipes. [Administration →](administration/index.md) - :material-controller-classic-outline: **I just want to play** *** Library, collections, saves & states, ROM Patcher, Netplay. [Using RomM →](using/index.md) - :material-api: **I'm building on top of RomM** *** API reference, WebSockets, device sync protocol, client tokens. [Developers →](developers/index.md) ## Philosophy RomM is built for its users, not for shareholders: self-hosted, open-source, no tracking, no upsells. The core app is licensed under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/), and other projects in the umbrella use permissive licenses ([GPLv3](https://choosealicense.com/licenses/gpl-3.0/) for software, [CC0](https://choosealicense.com/licenses/cc0-1.0/) for documentation). **RomM is and will always be free and open-source software.** ## Community Join us on Discord to ask questions, share your setup, request features, or help other users. Code, issues, and releases live on [GitHub](https://github.com/rommapp/romm).