mirror of
https://github.com/rommapp/docs.git
synced 2026-04-23 06:54:41 +00:00
Deployed 4d4dae4 to 3.9.0 with MkDocs 1.6.1 and mike 2.1.3
This commit is contained in:
@@ -290,6 +290,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -372,6 +374,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/3.9.0/Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/3.9.0/Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -420,6 +422,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -420,6 +422,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
<link rel="prev" href="../Quick-Start-Guide/">
|
||||
|
||||
|
||||
<link rel="next" href="../Generate-API-Keys/">
|
||||
<link rel="next" href="../Configuration-File/">
|
||||
|
||||
|
||||
<link rel="icon" href="../../resources/romm/isotipo.png">
|
||||
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -449,6 +451,39 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#configuration-file" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Configuration file
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#naming-convention" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Naming Convention
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Naming Convention">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#tag-support" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Tag Support
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -466,6 +501,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
@@ -1498,6 +1555,39 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#configuration-file" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Configuration file
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#naming-convention" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Naming Convention
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Naming Convention">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#tag-support" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Tag Support
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -1563,7 +1653,7 @@
|
||||
</ul>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>For folder naming conventions, review the <a href="../../Platforms-and-Players/Supported-Platforms/">Platform Support</a> section. To override default system names in the folder structure (if your directories are named differently), see the <a href="../../Configuration-File">Configuration File</a> section.</p>
|
||||
<p>For folder naming conventions, review the <a href="../../Platforms-and-Players/Supported-Platforms">Platform Support</a> section. To override default system names in the folder structure (if your directories are named differently), see the <a href="../../Getting-Started/Configuration-File">Configuration File</a> section.</p>
|
||||
</div>
|
||||
<table>
|
||||
<tr>
|
||||
@@ -1676,7 +1766,18 @@
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>RomM can be setup without a prior folder structure. If files are manually uploaded from the webUI, RomM will automatically create the folder <strong>Structure A</strong></p>
|
||||
</div></div>
|
||||
</div>
|
||||
<h2 id="configuration-file">Configuration file</h2>
|
||||
<p>RomM's behavior can be customized using a <code>config.yml</code> file or through the <code>Library Management</code> page in the <code>Settings</code> menu. You can grab the example <a href="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.</p>
|
||||
<p>What is shown in the <code>Library Management</code> page is the content of the <code>config.yml</code>. For more details read the <a href="../../Getting-Started/Configuration-File">configuration file</a> section.</p>
|
||||
<h2 id="naming-convention">Naming Convention</h2>
|
||||
<h3 id="tag-support">Tag Support</h3>
|
||||
<p>Games can be tagged with region, revision, or other tags by using parentheses in the file name. Additionally, you can set the region and language by adding a prefix: <code>(USA)</code>, <code>[reg-J]</code>, <code>(French)</code>, <code>[De]</code>.</p>
|
||||
<ul>
|
||||
<li>Revision tags must be prefixed with <code>rev</code> or <code>rev-</code> (e.g. <code>rev v1</code> or <code>rev-1</code>)</li>
|
||||
<li>Other tags will also be imported, for example: <code>tetris [1.0001](HACK)[!].gba</code></li>
|
||||
</ul>
|
||||
<p>Tags can be used to search for games in the search bar. For example, searching for <code>(USA)</code> will return all games with the USA tag.</p></div>
|
||||
|
||||
|
||||
|
||||
@@ -1699,7 +1800,7 @@
|
||||
<span class="md-icon" title="Last update">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||
</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T10:32:38+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T15:06:08+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
</span>
|
||||
|
||||
|
||||
@@ -1763,13 +1864,13 @@
|
||||
|
||||
|
||||
|
||||
<a href="../Generate-API-Keys/" class="md-footer__link md-footer__link--next" aria-label="Next: Generate API Keys">
|
||||
<a href="../Configuration-File/" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration File">
|
||||
<div class="md-footer__title">
|
||||
<span class="md-footer__direction">
|
||||
Next
|
||||
</span>
|
||||
<div class="md-ellipsis">
|
||||
Generate API Keys
|
||||
Configuration File
|
||||
</div>
|
||||
</div>
|
||||
<div class="md-footer__button md-icon">
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
<link rel="canonical" href="https://docs.romm.app/3.9.0/Getting-Started/Generate-API-Keys/">
|
||||
|
||||
|
||||
<link rel="prev" href="../Folder-Structure/">
|
||||
<link rel="prev" href="../Configuration-File/">
|
||||
|
||||
|
||||
<link rel="next" href="../Environment-Variables/">
|
||||
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1589,24 +1613,12 @@
|
||||
<p>The name you pick has to be unique! Picking an existing name will fail silently, with no error messages. We recommend using <code>romm-<random hash></code>, like <code>romm-3fca6fd7f94dea4a05d029f654c0c44b</code></p>
|
||||
</div>
|
||||
<p>Note the client ID and secret that appear on screen, and use them to set <code>IGDB_CLIENT_ID</code> and <code>IGDB_CLIENT_SECRET</code> in your environment variables.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th><a class="glightbox" href="https://github.com/rommapp/romm/assets/3247106/7a93bf68-f6d9-46a5-ab72-719f2d5ec9d3" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="IGDB Creation" src="https://github.com/rommapp/romm/assets/3247106/7a93bf68-f6d9-46a5-ab72-719f2d5ec9d3"></a></th>
|
||||
<th><a class="glightbox" href="https://github.com/rommapp/romm/assets/3247106/7a9dc056-52be-41c4-aec5-e2758aa520b5" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="IGDB Secret" src="https://github.com/rommapp/romm/assets/3247106/7a9dc056-52be-41c4-aec5-e2758aa520b5"></a></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><a class="glightbox" href="https://github.com/rommapp/romm/assets/3247106/7a93bf68-f6d9-46a5-ab72-719f2d5ec9d3" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="IGDB Creation" src="https://github.com/rommapp/romm/assets/3247106/7a93bf68-f6d9-46a5-ab72-719f2d5ec9d3"></a> <a class="glightbox" href="https://github.com/rommapp/romm/assets/3247106/7a9dc056-52be-41c4-aec5-e2758aa520b5" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="IGDB Secret" src="https://github.com/rommapp/romm/assets/3247106/7a9dc056-52be-41c4-aec5-e2758aa520b5"></a></p>
|
||||
<h2 id="screenscraper">ScreenScraper</h2>
|
||||
<p>To access the ScreenScraper API, create a <a href="https://www.screenscraper.fr/membreinscription.php">ScreenScraper</a> and copy the <strong>user</strong> and <strong>password</strong> you just created to <code>SCREENSCRAPER_USER</code> and <code>SCREENSCRAPER_PASSWORD</code> respectively.</p>
|
||||
<h2 id="steamgriddb">SteamGridDB</h2>
|
||||
<p>To access steamGridDB API, you need to login into their <a href="https://www.steamgriddb.com/">website</a> with a <a href="https://store.steampowered.com/join">steam account</a>. Once logged in, go to your <a href="https://www.steamgriddb.com/profile/preferences/api">API tab under the preferences page</a>. Copy the key shown and use it to set <code>STEAMGRIDDB_API_KEY</code>.</p>
|
||||
<p>SteamGridDB only provides custom cover art for games or collections. It's not accessed through the scanner but from the search cover button when manually editing a game.</p>
|
||||
<h2 id="mobygames">MobyGames</h2>
|
||||
<p>To access the MobyGames API, <a href="https://www.mobygames.com/user/register/">create a MobyGames account</a> and then visit your profile page. Click the <strong>API</strong> link under your user name to sign up for an API key. Copy the key shown and use it to set <code>MOBYGAMES_API_KEY</code>.</p>
|
||||
<!-- prettier-ignore -->
|
||||
@@ -1636,7 +1648,7 @@
|
||||
<span class="md-icon" title="Last update">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||
</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-13T08:56:16+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-13</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T15:06:08+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
</span>
|
||||
|
||||
|
||||
@@ -1683,7 +1695,7 @@
|
||||
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
||||
|
||||
|
||||
<a href="../Folder-Structure/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Folder Structure">
|
||||
<a href="../Configuration-File/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration File">
|
||||
<div class="md-footer__button md-icon">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||||
@@ -1693,7 +1705,7 @@
|
||||
Previous
|
||||
</span>
|
||||
<div class="md-ellipsis">
|
||||
Folder Structure
|
||||
Configuration File
|
||||
</div>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -523,6 +525,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -338,6 +338,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -420,6 +422,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -334,6 +334,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -416,6 +418,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -332,6 +332,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -414,6 +416,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
@@ -1458,6 +1482,7 @@
|
||||
<li>Getting Started<ul>
|
||||
<li><a href="../Getting-Started/Quick-Start-Guide/">Quick Start Guide</a></li>
|
||||
<li><a href="../Getting-Started/Folder-Structure/">Folder Structure</a></li>
|
||||
<li><a href="../Getting-Started/Configuration-File/">Configuration File</a></li>
|
||||
<li><a href="../Getting-Started/Generate-API-Keys/">Generate API Keys</a></li>
|
||||
<li><a href="../Getting-Started/Environment-Variables/">Environment Variables</a></li>
|
||||
<li><a href="../Getting-Started/Reverse-Proxy/">Reverse Proxy</a></li>
|
||||
@@ -1534,7 +1559,7 @@
|
||||
<span class="md-icon" title="Last update">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||
</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T10:28:50+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T15:06:08+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -331,6 +331,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -413,6 +415,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -331,6 +331,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -413,6 +415,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -331,6 +331,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -413,6 +415,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
@@ -1461,7 +1485,8 @@
|
||||
|
||||
<h1>Supported Platforms</h1>
|
||||
|
||||
<div><p>Below is a list of all supported platforms/systems/consoles and their respective folder names. <strong>The folder name is case-sensitive and must be used exactly as it appears in the list below.</strong></p>
|
||||
<div><p>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. For platforms that can be playable in the browser, please check <a href="../../Platforms-and-Players/EmulatorJS-Player">emulatorjs supported platforms</a> and <a href="../../Platforms-and-Players/RuffleRS-Player">ruffle player</a>.</p>
|
||||
<p><strong>The folder name is case-sensitive and must be used exactly as it appears in the list below.</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -3915,7 +3940,7 @@
|
||||
<span class="md-icon" title="Last update">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
||||
</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-03-13T19:09:03+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-03-13</span>
|
||||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-05-29T15:06:08+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-05-29</span>
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
@@ -336,6 +336,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -418,6 +420,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
@@ -400,6 +400,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -482,6 +484,28 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="Getting-Started/Configuration-File/" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Configuration File
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="Getting-Started/Generate-API-Keys/" class="md-nav__link">
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -12,6 +12,10 @@
|
||||
<loc>https://docs.romm.app/3.9.0/Getting-Started/Authentication/</loc>
|
||||
<lastmod>2025-05-29</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://docs.romm.app/3.9.0/Getting-Started/Configuration-File/</loc>
|
||||
<lastmod>2025-05-29</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://docs.romm.app/3.9.0/Getting-Started/Environment-Variables/</loc>
|
||||
<lastmod>2025-05-29</lastmod>
|
||||
|
||||
Binary file not shown.
Reference in New Issue
Block a user