diff --git a/docs/platforms/custom-platforms.md b/docs/platforms/custom-platforms.md index da260019..71b13f39 100644 --- a/docs/platforms/custom-platforms.md +++ b/docs/platforms/custom-platforms.md @@ -3,8 +3,6 @@ title: Custom Platforms description: Add custom unsupported platforms --- - - # Custom Platforms RomM ships with support for ~400 platforms. If yours isn't in [the list](supported-platforms.md), you can still load it as a custom platform, but we won't have metadata provider coverage for it. @@ -41,44 +39,3 @@ system: ``` This gets you full metadata provider support with your preferred folder name (see [Configuration File → `system.platforms`](../reference/configuration-file.md#systemplatforms)). - -## Adding a custom platform icon - -If your platform isn't in [the built-in icons list](https://github.com/rommapp/romm/tree/master/frontend/assets/platforms), RomM shows a default fallback icon. - -To load your own: - -1. Mount the platform icons directory - -Bind-mount a host directory onto the container's icon path: - -```yaml -services: - romm: - volumes: - - /path/to/your/icons:/var/www/html/assets/platforms -``` - -2. Seed it with the official icons - -The built-in icons live at [`frontend/assets/platforms`](https://github.com/rommapp/romm/tree/master/frontend/assets/platforms). Download them all and drop into your mounted directory, otherwise built-in platforms lose their icons too (because your mount overrides the whole directory). - -3. Add your custom `.ico` files - -The filename has to **match the platform slug**. Examples: - -| Platform | Platform slug | Filename | -| ------------------- | ------------------------------ | ------------------------- | -| Amstrad CPC | `acpc` | `acpc.ico` | -| My Homebrew Console | `my-homebrew-console` (custom) | `my-homebrew-console.ico` | -| NES | `nes` | `nes.ico` | - -4. Restart RomM - -`docker compose up -d` picks up the new icon mount. - -To replace an existing platform's icon, use a filename matching an existing platform's slug and your file overrides the built-in. - -## Screenshot - -Platforms view with custom icons