mirror of
https://github.com/rommapp/docs.git
synced 2026-04-23 06:54:41 +00:00
fixup bad prettier fixes
This commit is contained in:
Georges-Antoine Assi
@@ -88,9 +88,11 @@ filesystem: { roms_folder: "my_roms" }
|
||||
|
||||
---
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
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.
|
||||
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.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning
|
||||
Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults.
|
||||
Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults.
|
||||
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.
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
<!-- trunk-ignore-all(prettier) -->
|
||||
<!-- trunk-ignore-all(markdownlint/MD033) -->
|
||||
<!-- trunk-ignore-all(markdownlint/MD041) -->
|
||||
|
||||
@@ -17,6 +16,7 @@ RomM organizes content in two main categories: ROMs and BIOS files.
|
||||
- `/{platform}/roms/` - Contains all game files for that platform
|
||||
- `/{platform}/bios/` - Contains all BIOS files for that platform
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note
|
||||
The BIOS folder is entirely optional and only needed for platforms that require BIOS files.
|
||||
|
||||
@@ -37,8 +37,9 @@ For multifile games (games stored as folders with multiple files or folders insi
|
||||
- `translation`
|
||||
- `prototype`
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
For folder naming conventions, review the [Platform Support](../Platforms-and-Players/Supported-Platforms.md) section. To override default system names in the folder structure (if your directories are named differently), see the [Configuration File](Configuration-File.md) section.
|
||||
For folder naming conventions, review the [Platform Support](../Platforms-and-Players/Supported-Platforms.md) section. To override default system names in the folder structure (if your directories are named differently), see the [Configuration File](Configuration-File.md) section.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -148,8 +149,9 @@ For multifile games (games stored as folders with multiple files or folders insi
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note
|
||||
RomM can be setup without a prior folder structure. If files are manually uploaded from the webUI, RomM will automatically create the folder **Structure A**
|
||||
RomM can be setup without a prior folder structure. If files are manually uploaded from the webUI, RomM will automatically create the folder **Structure A**
|
||||
|
||||
## Configuration file
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
<!-- trunk-ignore-all(prettier) -->
|
||||
<!-- trunk-ignore-all(markdownlint/MD033) -->
|
||||
<!-- trunk-ignore-all(markdownlint/MD041) -->
|
||||
|
||||
@@ -25,16 +24,16 @@ 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 <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
|
||||
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
|
||||
- `MARIADB_USER`: User to connect to the database with. This can be modified - but it's not necessary
|
||||
- `MARIADB_PASSWORD`: Password for the user to connect to the database with. Use a unique and secure password (_use a password generator for simplicity_)
|
||||
4. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
|
||||
3. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
|
||||
- `DB_NAME`: Name of the database set in the database section
|
||||
- `DB_USER`: Name of the user to connect to the database
|
||||
- `DB_PASSWD`: Password of the user to connect to the database
|
||||
5. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
|
||||
4. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
|
||||
```sh
|
||||
openssl rand -hex 32
|
||||
```
|
||||
@@ -42,7 +41,7 @@ Now that we have everything gathered, we can begin getting your instance set up!
|
||||
```sh
|
||||
03a054b6ca27e0107c5eed552ea66becd9f3a2a8a91e7595cd462a593f9ecd09
|
||||
```
|
||||
6. Add your metadata sources API keys:
|
||||
5. Add your metadata sources API keys:
|
||||
- IGDB: `IGDB_CLIENT_ID` and `IGDB_CLIENT_SECRET`
|
||||
- ScreenScraper.fr: `SCREENSCRAPER_USER` and `SCREENSCRAPER_PASSWORD`
|
||||
- RetroAchievements: `RETROACHIEVEMENTS_USERNAME` and `RETROACHIEVEMENTS_API_KEY`
|
||||
@@ -51,11 +50,11 @@ Now that we have everything gathered, we can begin getting your instance set up!
|
||||
- PlayMatch: `PLAYMATCH_API_ENABLED=true`
|
||||
- Hasheous: `HASHEOUS_API_ENABLED=true`
|
||||
- LaunchBox: `LAUNCHBOX_API_ENABLED=true`
|
||||
7. Modify the following values in the **volumes** to configure the application
|
||||
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
|
||||
8. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
|
||||
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
???+ example "Example Docker Compose"
|
||||
@@ -63,8 +62,9 @@ Now that we have everything gathered, we can begin getting your instance set up!
|
||||
--8<-- "quick-start.docker-compose.yml"
|
||||
```
|
||||
|
||||
9. Open the terminal and navigate to the directory containing the docker-compose file
|
||||
10. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network:
|
||||
8. Open the terminal and navigate to the directory containing the docker-compose file
|
||||
9. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network:
|
||||
|
||||
```asciinema-player
|
||||
{
|
||||
"file": "../latest/resources/asciinema/quick-start-docker-compose.cast",
|
||||
|
||||
@@ -29,5 +29,6 @@ We use PortMaster to install the app on devices running EmulationStation.
|
||||
2. Make the `RomM App.sh` file executable by running `chmod +x RomM App.sh`.
|
||||
3. Launch EmulationStation and navigate to the `Ports` section.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note
|
||||
Your device must connect to your RomM instance or home server over Wi-Fi. The easiest method is to keep them on the same network and set HOST to the server's IP and the port where RomM is running. Advanced users or those using reverse proxies can configure their network and DNS settings as needed, using a URL with a domain like `https://romm.domain.com`.
|
||||
Your device must connect to your RomM instance or home server over Wi-Fi. The easiest method is to keep them on the same network and set HOST to the server's IP and the port where RomM is running. Advanced users or those using reverse proxies can configure their network and DNS settings as needed, using a URL with a domain like `https://romm.domain.com`.
|
||||
|
||||
@@ -6,12 +6,14 @@
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning
|
||||
This will need the same settings as the PSP emulation which you can find [here](https://docs.romm.app/latest/Platforms-and-Players/EmulatorJS-Player/) to enable the play button
|
||||
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info
|
||||
I highly suggest you upload the games as .zip as the core can take advantage of unzipping and auto mounting options which are explained more below.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info
|
||||
Loading and saving states ARE supported so it's possible you only need to do the below steps once to load the game.
|
||||
Loading and saving states ARE supported so it's possible you only need to do the below steps once to load the game.
|
||||
|
||||
#### Running Games
|
||||
|
||||
@@ -34,8 +36,9 @@ The official method to run the games from the EmulatorJS dev is the following (O
|
||||
|
||||
#### Advanced Running Games
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning
|
||||
This is not for the faint of heart and will require a lot of trial and error.
|
||||
This is not for the faint of heart and will require a lot of trial and error.
|
||||
|
||||
As the system is using DOSBOX pure it has a neat trick where it will run .CONF files it finds and automatically mount locations and run .exe files automatically, at the minute this is highly experimental and might be more effort then it is worth, but if you want the files running perfectly then I would suggest you look into this method, but it is extremely trail and error.
|
||||
|
||||
@@ -309,8 +312,9 @@ exit
|
||||
|
||||
### Advanced Running Retail Games
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info
|
||||
At the minute DOS games redesigned by GOG are NOT supported, this is due to how they mount and use the locations. I am looking into how I can figure this out but I have had a 100% failure rate from the GOG DOS Games.
|
||||
At the minute DOS games redesigned by GOG are NOT supported, this is due to how they mount and use the locations. I am looking into how I can figure this out but I have had a 100% failure rate from the GOG DOS Games.
|
||||
|
||||
Retail games usually require to run alongside a disk even if the game has been "installed" locally. I will use Dungeon Keeper Gold as an example for a retail game with a disc and the configuration needed.
|
||||
|
||||
|
||||
@@ -4,11 +4,13 @@
|
||||
|
||||
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.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info
|
||||
For platforms that can be playable in the browser, please check [emulatorjs supported platforms](./EmulatorJS-Player.md) and [ruffle player](./RuffleRS-Player.md).
|
||||
For platforms that can be playable in the browser, please check [emulatorjs supported platforms](./EmulatorJS-Player.md) and [ruffle player](./RuffleRS-Player.md).
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! danger
|
||||
**The folder name is case-sensitive and must be used exactly as it appears in the list below.**
|
||||
**The folder name is case-sensitive and must be used exactly as it appears in the list below.**
|
||||
|
||||
| Platform Name | Folder Name | Metadata Providers |
|
||||
| ----------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|
||||
@@ -44,8 +44,9 @@ Apply the changes, then head to the `DOCKER` tab. You should see both containers
|
||||
|
||||
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning
|
||||
It's strongly recommended to backup the `appdata` folder (or mount it in a safe location) before updating, since tearing down the container will wipe the resources (covers, screenshots, etc.)
|
||||
It's strongly recommended to backup the `appdata` folder (or mount it in a safe location) before updating, since tearing down the container will wipe the resources (covers, screenshots, etc.)
|
||||
|
||||
## Video tutorial
|
||||
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{% extends "base.html" %} {% block extrahead %}
|
||||
<meta
|
||||
http-equiv="Content-Security-Policy"
|
||||
content="default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' fonts.googleapis.com; img-src 'self' data: github.com *.s3.amazonaws.com img.youtube.com invidget.switchblade.xyz; font-src 'self' data: fonts.gstatic.com; connect-src 'self';"
|
||||
content="default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' fonts.googleapis.com; img-src 'self' data: github.com raw.githubusercontent.com *.s3.amazonaws.com img.youtube.com invidget.switchblade.xyz; font-src 'self' data: fonts.gstatic.com; connect-src 'self';"
|
||||
/>
|
||||
{% endblock %}
|
||||
|
||||
Reference in New Issue
Block a user