diff --git a/docs/Getting-Started/Configuration-File.md b/docs/Getting-Started/Configuration-File.md index 4cbcc15..2fc9d90 100644 --- a/docs/Getting-Started/Configuration-File.md +++ b/docs/Getting-Started/Configuration-File.md @@ -90,9 +90,9 @@ filesystem: { roms_folder: "my_roms" } !!! tip - You can find examples of full binded batocera or es-de config files. + You can find examples of full binded batocera or es-de config files. !!! warning Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults. -For a full example, see the config.example.yml file. +For a full example, see the config.example.yml file. diff --git a/docs/Getting-Started/Folder-Structure.md b/docs/Getting-Started/Folder-Structure.md index bd4b90d..c57dec1 100644 --- a/docs/Getting-Started/Folder-Structure.md +++ b/docs/Getting-Started/Folder-Structure.md @@ -155,7 +155,7 @@ For multifile games (games stored as folders with multiple files or folders insi ## Configuration file -RomM's behavior can be customized using a `config.yml` file or through the `Library Management` page in the `Settings` menu. You can grab the example config.example.yml file and adapt it to your library. +RomM's behavior can be customized using a `config.yml` file or through the `Library Management` page in the `Settings` menu. You can grab the example config.example.yml file and adapt it to your library. What is shown in the `Library Management` page is the content of the `config.yml`. For more details read the [configuration file](Configuration-File.md) section. diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index c59fe0c..30c2b6c 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -24,7 +24,7 @@ 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! -1. Download a copy of the latest docker-compose.example.yml file from GitHub +1. Download a copy of the latest docker-compose.example.yml file from GitHub 2. 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_) - `MARIADB_DATABASE`: Sets the database name for RomM. This can be modified - but it's not necessary @@ -54,8 +54,7 @@ Now that we have everything gathered, we can begin getting your instance set up! 6. Modify the following values in the **volumes** to configure the application - `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder) - `/path/to/assets`: Path to the directory where you will store your saves, etc - - `/path/to/config`: Path to the directory where you will store the config.yml - > At this step store the `config.yml` file in this folder + - `/path/to/config`: Path to the directory where you will store the config.yml (store the `config.yml` file in this folder) 7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this: @@ -83,10 +82,10 @@ Now that we have everything gathered, we can begin getting your instance set up! } ``` -1. Run `docker ps -f name=romm` to verify that the containers are running -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 +10. Run `docker ps -f name=romm` to verify that the containers are running +11. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page +12. Go through the setup wizard, setting your admin username and password +13. Log in with the credentials you set in the last step ## Configure diff --git a/docs/Platforms-and-Players/Custom-Platforms.md b/docs/Platforms-and-Players/Custom-Platforms.md index 56fee89..7566bbd 100644 --- a/docs/Platforms-and-Players/Custom-Platforms.md +++ b/docs/Platforms-and-Players/Custom-Platforms.md @@ -3,9 +3,9 @@ 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. +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/master/frontend/assets/platforms), RomM will display a default fallback icon. -If you'd like to load your own custom icons for missing platforms, you can mount `/var/www/html/assets/platforms` to some local folder and place all of your custom **`.ico`** platform icons in there. You'll also want to download the ones [provided in this project](https://github.com/rommapp/romm/tree/release/frontend/assets/platforms) and place them in the same folder. If you'd like to use your own icons for platforms already supported by RomM, just replace the file with another using the exact same name. +If you'd like to load your own custom icons for missing platforms, you can mount `/var/www/html/assets/platforms` to some local folder and place all of your custom **`.ico`** platform icons in there. You'll also want to download the ones [provided in this project](https://github.com/rommapp/romm/tree/master/frontend/assets/platforms) and place them in the same folder. If you'd like to use your own icons for platforms already supported by RomM, just replace the file with another using the exact same name. **The name of the `.ico` file should match the slug of the platform on IGDB.** For example, the URL for the AmstradCPC is , so the filename should be `acpc.ico`. diff --git a/docs/System-Setup/TrueNAS-Setup-Guide.md b/docs/System-Setup/TrueNAS-Setup-Guide.md index 9cdafbe..f72f45a 100644 --- a/docs/System-Setup/TrueNAS-Setup-Guide.md +++ b/docs/System-Setup/TrueNAS-Setup-Guide.md @@ -5,7 +5,7 @@ This guide assumes you're familiar with Docker and have basic knowledge of TrueNAS. You'll need: - A running TrueNAS installation -- Your games setup in the [required folder structure](https://github.com/rommapp/romm/blob/release/README.md) +- Your games setup in the [required folder structure](https://github.com/rommapp/romm/blob/master/README.md) ## Setup Process diff --git a/docs/System-Setup/Unraid-Compose-Setup.md b/docs/System-Setup/Unraid-Compose-Setup.md index de01e58..b7d6dcd 100644 --- a/docs/System-Setup/Unraid-Compose-Setup.md +++ b/docs/System-Setup/Unraid-Compose-Setup.md @@ -24,7 +24,7 @@ Click **Add New Stack** ![Edit Stack](../resources/unraid/edit-stack.png) -- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) +- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml) - Add your environment variables, for example: API keys, MariaDB info, and metadata providers diff --git a/docs/System-Setup/Unraid-Setup-Guide.md b/docs/System-Setup/Unraid-Setup-Guide.md index 0a1f547..944d61b 100644 --- a/docs/System-Setup/Unraid-Setup-Guide.md +++ b/docs/System-Setup/Unraid-Setup-Guide.md @@ -16,7 +16,7 @@ MariaDB is required to run RomM, so install it from the plugin registry. Only th ![community apps search results for MariaDB](https://github.com/user-attachments/assets/76f4b6ef-5b63-454f-9357-d2920b9afd0e) -Now fill in all the environment variables; descriptions of the options and sensible defaults are listed in the [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file. +Now fill in all the environment variables; descriptions of the options and sensible defaults are listed in the [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml) file. !!! warning @@ -32,7 +32,7 @@ From the Unraid dashboard, click `APPS` in the navigation bar. In the search bar ## Configuration -Configure the required environment variables, ports and paths as per the [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file. +Configure the required environment variables, ports and paths as per the [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml) file. !!! warning