You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can find examples of full binded <a href="https://github.com/rommapp/romm/blob/release/examples/config.batocera-retrobat.yml" target="_blank" rel="noopener noreferrer">batocera</a> or <a href="https://github.com/rommapp/romm/blob/release/examples/config.es-de.example.yml" target="_blank" rel="noopener noreferrer">es-de</a> config files.
93
+
You can find examples of full binded <a href="https://github.com/rommapp/romm/blob/master/examples/config.batocera-retrobat.yml" target="_blank" rel="noopener noreferrer">batocera</a> or <a href="https://github.com/rommapp/romm/blob/master/examples/config.es-de.example.yml" target="_blank" rel="noopener noreferrer">es-de</a> config files.
94
94
95
95
<!-- prettier-ignore -->
96
96
!!! warning
97
97
Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults.
98
-
For a full example, see the <a href="https://github.com/rommapp/romm/blob/release/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file.
98
+
For a full example, see the <a href="https://github.com/rommapp/romm/blob/master/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file.
Copy file name to clipboardExpand all lines: docs/Getting-Started/Folder-Structure.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,7 +155,7 @@ For multifile games (games stored as folders with multiple files or folders insi
155
155
156
156
## Configuration file
157
157
158
-
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 <ahref="https://github.com/rommapp/romm/blob/release/examples/config.example.yml"target="_blank"rel="noopener noreferrer">config.example.yml</a> file and adapt it to your library.
158
+
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 <ahref="https://github.com/rommapp/romm/blob/master/examples/config.example.yml"target="_blank"rel="noopener noreferrer">config.example.yml</a> file and adapt it to your library.
159
159
160
160
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.
Copy file name to clipboardExpand all lines: docs/Getting-Started/Quick-Start-Guide.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ This guide will assume that you already have the following done, if not - stop h
24
24
25
25
Now that we have everything gathered, we can begin getting your instance set up!
26
26
27
-
1. Download a copy of the latest <ahref="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
27
+
1. Download a copy of the latest <ahref="https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml"target="_blank"rel="noopener noreferrer">docker-compose.example.yml</a> file from GitHub
28
28
2. Edit the file and modify the following values to configure the database
29
29
-`MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_)
30
30
-`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!
54
54
6. Modify the following values in the **volumes** to configure the application
55
55
- `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder)
56
56
- `/path/to/assets`: Path to the directory where you will store your saves, etc
57
-
- `/path/to/config`: Path to the directory where you will store the config.yml
58
-
> At this step store the `config.yml` file in this folder
57
+
- `/path/to/config`: Path to the directory where you will store the config.yml (store the `config.yml` file in this folder)
59
58
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
60
59
61
60
<!-- prettier-ignore -->
@@ -83,10 +82,10 @@ Now that we have everything gathered, we can begin getting your instance set up!
83
82
}
84
83
```
85
84
86
-
1. Run `docker ps -f name=romm` to verify that the containers are running
87
-
2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page
88
-
3. Go through the setup wizard, setting your admin username and password
89
-
4. Log in with the credentials you setin the last step
85
+
10. Run `docker ps -f name=romm` to verify that the containers are running
86
+
11. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page
87
+
12. Go through the setup wizard, setting your admin username and password
88
+
13. Log in with the credentials you setin the last step
Copy file name to clipboardExpand all lines: docs/Platforms-and-Players/Custom-Platforms.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@
3
3
4
4
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.
5
5
6
-
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.
6
+
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.
7
7
8
-
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.
8
+
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.
9
9
10
10
**The name of the `.ico` file should match the slug of the platform on IGDB.** For example, the URL for the AmstradCPC is <https://www.igdb.com/platforms/acpc>, so the filename should be `acpc.ico`.
Copy file name to clipboardExpand all lines: docs/System-Setup/Unraid-Compose-Setup.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Click **Add New Stack**
24
24
25
25

26
26
27
-
- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml)
27
+
- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml)
28
28
29
29
- Add your environment variables, for example: API keys, MariaDB info, and metadata providers
Copy file name to clipboardExpand all lines: docs/System-Setup/Unraid-Setup-Guide.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ MariaDB is required to run RomM, so install it from the plugin registry. Only th
16
16
17
17

18
18
19
-
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.
19
+
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.
20
20
21
21
<!-- prettier-ignore -->
22
22
!!! warning
@@ -32,7 +32,7 @@ From the Unraid dashboard, click `APPS` in the navigation bar. In the search bar
32
32
33
33
## Configuration
34
34
35
-
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.
35
+
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.
0 commit comments