OmniConsole Platforms

🌐 English | 繁體中文

Community-maintained platform definitions for OmniConsole. Share the ones you love so everyone can add them in one click!

💡 How it works

OmniConsole reads this repository directly. Once your platform is merged here, it appears in the in-app Community Platforms browser (Settings → ☰ → General → Custom → Community) for everyone to browse and add — credited to your GitHub account as the submitter.

A platform is one small JSON file — just add it and open a pull request.

---

📁 Repository structure

platforms/
└── <id>.json        ← one platform per file — this is what you submit
covers/
└── <id>.png         ← 800×560 cover card (optional; made by the maintainer if absent)
index.json           ← aggregated by the tool — do NOT edit by hand

• <id> is the file name, and it must be the slug of displayName: lowercased, with every run of non-alphanumeric characters (spaces, punctuation) collapsed to a single -. For example, Steam Big Picture (GameInput) → steam-big-picture-gameinput.
• index.json is the aggregated catalog OmniConsole reads to show every community platform in-app. It is rebuilt by the maintainer after every merge; do not edit it by hand. Pull requests that edit it directly will be asked to remove that change.

---

🚀 How to submit a platform

1. Fork this repository.
2. Add one file platforms/<id>.json — see the examples below, or copy an existing file as a template. 💡 Easiest way: set the platform up in OmniConsole first, then right-click its card → Export. That JSON is the complete submission file — paste it as-is.
3. (Optional) add a cover covers/<id>.png, exactly 800×560 PNG, text-style artwork only — do not include trademarked logos or copyrighted images. If you skip it, an OmniConsole-style card marked Community is made for you.
4. Open a pull request.

Pick the launch type that fits

Not sure which type? The Export above fills it in for you — the examples below just show what each looks like.

ProtocolUri — best when the platform registers a protocol. Works on every console, no path issues.

{
  "shell": "OmniConsole",
  "displayName": "Steam Big Picture",
  "launchType": "ProtocolUri",
  "launchTarget": "steam://open/bigpicture"
}

PackagedApp — for Microsoft Store / MSIX / APPX apps. Also works on any console.

{
  "shell": "OmniConsole",
  "displayName": "XBOX",
  "launchType": "PackagedApp",
  "packageFamilyName": "Microsoft.GamingApp_8wekyb3d8bbwe"
}

Executable — when there is no protocol. Use the default install path; for per-user installs use environment variables so it works on every console. arguments is optional.

{
  "shell": "OmniConsole",
  "displayName": "Playnite Desktop",
  "launchType": "Executable",
  "launchTarget": "%LocalAppData%\\Playnite\\Playnite.DesktopApp.exe",
  "arguments": "--hidesplashscreen"
}

displayName uses the product's original name. Supported variables: %LocalAppData%, %AppData%, %UserProfile%, %ProgramFiles%, %ProgramFiles(x86)%, %ProgramData% — OmniConsole's Export writes them automatically. Users who installed elsewhere are prompted to locate the file when adding.

---

✅ Review criteria

Every submission is reviewed before merging:

• The file name and fields follow the format rules above (<id> matches the displayName slug).
• The platform actually launches with the given data — please test it on your console first.
• Launch targets and arguments contain nothing suspicious or destructive.
• No duplicates of built-in platforms (Steam, XBOX, Epic, Armoury Crate SE, Playnite) or existing entries.
• Cover images follow the artwork rules above.

Thank you for contributing! 💜

📄 License

Platform definitions and any cover art you submit are licensed under Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0).

You are free to share and adapt these contributions for noncommercial use, with attribution to the submitters. By contributing, you agree your submission is provided under this license.

OmniConsole-style cover cards for submissions without a cover are made by 8bit2qubit, who holds the copyright, and provided under the same license.