Skip to content

docs: remove the custom platform icon guide #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gantoine merged 2 commits into from
Sep 26, 2026
Merged

docs: remove the custom platform icon guide #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4079aac
docs: note custom platform icons only apply to the classic UI
gantoine Sep 26, 2026
7b04219
docs: remove the custom platform icon guide
gantoine Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 0 additions & 43 deletions docs/platforms/custom-platforms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Custom Platforms
description: Add custom unsupported platforms
---

<!-- trunk-ignore-all(markdownlint/MD033) -->

# 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.
Expand Down Expand Up @@ -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

<img width="2459" alt="Platforms view with custom icons" src="https://github.com/rommapp/romm/assets/3247106/1831c206-b431-41c2-9761-49c132f40ee0">