Merge branch 'rommapp:main' into main

Author: FallenWyvern

docs/Getting-Started/Environment-Variables.md

@@ -70,6 +70,8 @@ This is a complete list of available environment variables; required variables a
 | LAUNCHBOX_API_ENABLED                | Enable LaunchBox API integration                   |          | `false` |
 | PLAYMATCH_API_ENABLED                | Enable PlayMatch API integration                   |          | `false` |
 | HASHEOUS_API_ENABLED                 | Enable Hasheous API integration                    |          | `false` |
+| FLASHPOINT_API_ENABLED                | Enable Flashpoint API integration                   |          | `false` |
+| HLTB_API_ENABLED                      | Enable HowLongToBeat API integration                |          | `false` |
 
 ## Authentication
 

docs/Maintenance/Migrating-to-new-machine.md

@@ -0,0 +1,93 @@
+<!-- trunk-ignore-all(markdownlint/MD041) -->
+
+## Migrating RomM to a new system
+
+Migrating RomM to a new system is possible, but all of the docker volumes must be copied for RomM to run correctly.
+
+Following the the setup in the [Quick Start Guide](https://docs.romm.app/latest/Getting-Started/Quick-Start-Guide/#build) these volumes are created be default
+
+RomM should be stopped before following this guide.
+
+```yaml
+volumes:
+    mysql_data:
+    romm_resources:
+    romm_redis_data:
+
+services:
+    romm:
+        volumes:
+            - romm_resources
+            - romm_redis_data
+    romm-db:
+        volumes:
+            - mysql_data
+```
+
+These volumes will need to manually moved to the new system. This is a straightforward process that includes determining their location and then copying them.
+
+### Determining the docker root directory and copying the volumes
+
+1. First determine the docker root directory
+
+```bash
+docker info | grep 'Docker Root Dir'
+```
+
+The expected output on a standard linux system:
+
+```bash
+Docker Root Dir: /var/lib/docker
+```
+
+2. Double check that the volumes have been created by docker and are owned by the docker engine
+
+```bash
+docker volume ls
+```
+
+Following the default quick start guide the following volumes will have been made
+
+```bash
+DRIVER    VOLUME NAME
+local     romm_mysql_data
+local     romm_romm_redis_data
+local     romm_romm_resources
+```
+
+3. Inspect each volume to get the exact location of the volume data
+
+```bash
+docker volume inspect romm_mysql_data | grep Mountpoint
+```
+
+- The output of the `docker inspect` will return the exact storage location of the volumes data
+
+```bash
+"Mountpoint": "/var/lib/docker/volumes/romm_mysql_data/_data",
+```
+
+4. Copy those volumes into a new location so that they can be safely migrated to a new system **each volume needs to be in its own folder**
+
+```bash
+cp -r /var/lib/docker/volumes/romm_mysql_data/_data/ /your/new/path/romm_mysql_data
+
+cp -r /var/lib/docker/volumes/romm_romm_redis_data/_data /your/new/path/romm_romm_redis_data
+
+cp -r /var/lib/docker/volumes/romm_romm_resources/_data /your/new/path/romm_romm_resources
+```
+
+5. Update the `docker-compose.yml` volume paths with the newly copied data to determine RomM still loads correctly.
+
+```yaml
+services:
+    romm:
+        volumes:
+            - /your/new/path/romm_romm_resources # romm_resources
+            - /your/new/path/romm_romm_redis_data # romm_redis_data
+    romm-db:
+        volumes:
+            - /your/new/path/romm_mysql_data # mysql_data
+```
+
+If RomM starts up correctly, then it is safe to copy all of your RomM folders to a new system.

docs/Platforms-and-Players/Supported-Platforms.md

@@ -15,6 +15,9 @@ In all views, a grid icon is present in the upper right of the screen or contain
 
 Platform cards can be clicked to go directly to the platform. A game card can be interacted in a few ways: putting your mouse over it allows you to download the game, play the game if the system is supported, or open a context menu giving you the option to manually match game information using a metadata agent, edit existing data, refresh the metadata, and add or remove the game from favourites or collections.
 
+![game card](https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/usage/gameCard.png)
+![context menu](https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/usage/ContextMenu.png)
+
 Clicking a platform will take you to the platform view, while clicking a game will take you to the game view.
 
 ### Filters
@@ -39,7 +42,7 @@ The filters that can be toggled include:
 Next there is a platform drop down. This allows you to select a platform you want to restrict your view to showing.
 
 After this you can filter by metadata: Game Genre, Franchise, Collections, Company, Age Rating, Region, and Language.
-One additional filter exists after these: Status. This allows you to use the "personal" data tab on any game to track your progress of the game (Never Playing, Backlogged, Compete, etc).
+One additional filter exists after these: Status. This allows you to use the "personal" data tab on any game to track your progress of the game (never playing, backlogged, complete, etc).
 
 ## The Menu bar
 
@@ -49,6 +52,8 @@ The menu bar is designed for quick access to the tools of your RomM server.
 
 Simply typing text into the search bar will bring up game cards for each game that matches the query. To the left of the search bar are two icons: the view filters and the new collection button.
 
+![search bar](https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/usage/SearchBar.png)
+
 ### List Platforms
 
 The Platforms button opens a drawer listing all of the known platforms in RomM. Clicking on any of these will create a search that is limited to that platform.
@@ -112,6 +117,8 @@ Following that are the platform settings, which consists of the style of cover u
 
 Finally, in the Danger Zone, is a Delete Platform button. This removes the platform from the database, it does NOT touch the files on your system. If you delete a platform in this way, scanning for new platforms will restore it, and all games will have to have their metadata re-matched.
 
+![platform drawer](https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/usage/PlatformView.png)
+
 ### Firmware
 
 Next to the platform drawer button is the firmware button. This allows you to review all of the firmware for that system, and upload firmware using the user interface.