run formttater and ignore bad formats

This commit is contained in:
Georges-Antoine Assi
2025-07-17 09:42:11 -04:00
parent e853a4ed1b
commit ca2dc78e13
27 changed files with 67 additions and 11 deletions
+1 -1
View File
@@ -61,7 +61,7 @@ We use [mike](https://github.com/jimporter/mike) to build and deploy documentati
uv run mike deploy --push --update-aliases <version> [alias]
```
This will update the `gh-pages` branch and automatically deploys the version with the fix/update to https://docs.romm.app
This will update the `gh-pages` branch and automatically deploys the version with the fix/update to <https://docs.romm.app>.
## Pull Request Guidelines
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
<div align="center">
<img src=".github/resources/isotipo.png" height="180px" width="auto" alt="RomM docs logo">
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
RomM provides support for various forms of authentication, granting flexibility in securing access to its features.
### Setup
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
Below is a breakdown of each section of the `config.yml` file and its purpose:
### `exclude`
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
This is a complete list of available environment variables; required variables are marked with a `✓`.
<!-- prettier-ignore -->
@@ -89,5 +91,5 @@ This is a complete list of available environment variables; required variables a
## Development
| DEV_MODE | Enable development mode (debugging, hot-reloading) | | `false` |
| DEV_HOST | Host for development server | | `| DEV_PORT | Port for development server | |`5000` |
| DEV_SQL_ECHO | Enable SQL query logging in development mode | |`false` |
| DEV_HOST | Host for development server | | | `DEV_PORT` | Port for development server | |`5000` |
| DEV_SQL_ECHO | Enable SQL query logging in development mode | |`false` |
+1
View File
@@ -1,5 +1,6 @@
<!-- trunk-ignore-all(prettier) -->
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
RomM requires one of these folder structures for proper operation. It will first attempt to detect **Structure A (recommended)**, and if not found, will fall back to **Structure B**. This auto-detection ensures flexibility while encouraging organization best practices.
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD001) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
RomM supports multiple metadata providers to enrich your game library with titles, descriptions, cover art, and achievements. You don't need all providers, so this guide covers [popular combos](#popular-combos) and [setup instructions](#setup-instructions).
## Popular combos
+2 -2
View File
@@ -1,4 +1,6 @@
<!-- trunk-ignore-all(prettier) -->
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
This quick start guide will help you get a RomM instance up and running. It is split into 3 parts:
@@ -22,7 +24,6 @@ This guide will assume that you already have the following done, if not - stop h
Now that we have everything gathered, we can begin getting your instance set up!
<!-- trunk-ignore-begin(markdownlint/MD040) -->
1. Download a copy of the latest <a href="https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml" target="_blank" rel="noopener noreferrer">docker-compose.example.yml</a> file from GitHub
3. Edit the file and modify the following values to configure the database
- `MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_)
@@ -84,7 +85,6 @@ Now that we have everything gathered, we can begin getting your instance set up!
2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page
3. Go through the setup wizard, setting your admin username and password
4. Log in with the credentials you set in the last step
<!-- trunk-ignore-end(markdownlint/MD040) -->
## Configure
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
Here are some basic configurations for popular reverse proxies. Some installations may require modifications to configuration options not listed below.
## Caddy
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
<div align="center">
<img src="../../resources/romm/integrations/playnite.svg" height="200px" width="200px" alt="romm[playnite] isotipo">
</div>
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
<div align="center">
<img src="../../resources/romm/integrations/tinfoil.svg" height="200px" width="200px" alt="romm[tinfoil] isotipo">
</div>
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
<div align="center">
<img src="../../resources/romm/integrations/muos.svg" height="200px" width="200px" alt="romm[muos] isotipo">
</div>
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## Scheduled tasks
Scheduled tasks can be enabled and configured with the following environment variables:
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
Version 3.0 of RomM introduces a number of breaking changes aimed at improving performance and usability, which will require some users to make specific changes before upgrading to ensure compatibility and to take full advantage of the new features.
All of the following changes are reflected in the [example docker-compose.yml file](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml), which has been simplified greatly. **Please read this entire file carefully, as failing to do so may cause RomM to become inaccessible or unresponsive.**
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
Weve put together some guidelines for those anyone who wants to use our name and logo. In this context, "RomM", "The RomM Project", "the project", "we", "us", and "our" refer to the RomM project.
## The Logo
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
### When will the next version of RomM be available?
When it's ready.
+2 -4
View File
@@ -57,10 +57,8 @@ On the General tab, click the New button under Applications.
- `Grant Types`: Authorization Code
- `Response Types`: Code
- `Authentication Method`: Basic
- `Redirect URIs`:
https://romm.domain.com/api/oauth/openid
- `Post Logout URIs`:
https://romm.domain.com/
- `Redirect URIs`: `https://romm.domain.com/api/oauth/openid`
- `Post Logout URIs`: `https://romm.domain.com/`
Click Create.
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
While RomM supports every platform listed in the [Supported Platforms page](../Platforms-and-Players/Supported-Platforms.md), the list is not exhaustive, and you may have ROMs in your library for other platforms. To load those files into RomM, place them in a folder for each platform, and give it a name that's **all lowercase**, with **`-` to separate words**, and with **no white spaces**. For example, `pocket-challenge-v2` would map to `Pocket Challenge V2`, and display the default platform icon in the app.
Furthermore, only a portion of the supported platforms have custom icons built-in. If your library has platforms that aren't listed in [the platforms icons list](https://github.com/rommapp/romm/tree/release/frontend/assets/platforms), RomM will display a default fallback icon.
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
[EmulatorJS](https://emulatorjs.org/) is a web-based emulator for various system; that is, it allows you to run old games in your web browser. It's based on [`RetroArch`](https://www.retroarch.com) compiled with [`Emscripten`](https://emscripten.org/), which is a toolchain for compiling C and C++ code to WebAssembly.
<!-- prettier-ignore -->
+3
View File
@@ -1,3 +1,6 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
[DOS](https://github.com/schellingb/dosbox-pure) is now supported in versions of RomM 4.0 and above thanks to the EmulatorJS player - Simply create a DOS platform to enable the integration
<!-- prettier-ignore -->
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
[Ruffle](https://ruffle.rs/) is a web-based player for flash games. With flash now discontinued, this is the best way to play your flash collection in the browser.
<!-- prettier-ignore -->
@@ -1,4 +1,6 @@
<!-- vale off -->
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
Below is a list of all supported platforms/systems/consoles and their respective folder names. Supported platforms means RomM can fetch metadata from sources for those platforms.
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## Prerequisites
This guide assumes you're familiar with Docker and have basic knowledge of server management. You'll need:
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## Prerequisites
This guide assumes you're familiar with Docker and have basic knowledge of TrueNAS. You'll need:
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## Prerequisites
Before getting started, install the [Community Apps plugin](https://forums.unraid.net/topic/38582-plug-in-community-applications/) for Unraid.
+2
View File
@@ -1,3 +1,5 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
[Igir](https://igir.io/) is a zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS. It can be used to rename your ROMs to match the RomM database, and to move them into a new directory structure.
## Setup
+6 -2
View File
@@ -1,8 +1,12 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->
<!-- trunk-ignore-all(markdownlint/MD041) -->
---
title: Introduction
description: An introduction to your beautiful, powerful, self-hosted rom manager
hide:
- toc
hide: - toc
---
<img src="./resources/romm/isotipo.svg" height="200px" width="200px" alt="RomM logo">