This is the official documentation for RomM, the beautiful, powerful self-hosted ROM manager and player. Here you'll find everything you need to know about setting up, configuring, and using RomM.

Building the documentation

We use uv to build the documentation. To install it, run:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then install python and the required dependencies:

uv install python
uv sync --all-extras --dev

Finally run the following command to serve the documentation from a local server:

uv run mkdocs serve

Contributing

We welcome all types of contributions, from simple typo fixes to new content. If you'd like to contribute, please read our code of conduct.

Join us on Discord, where you can ask questions, submit ideas, get help, showcase your collection, and discuss RomM with other users.