repo-name
-Repo description. This should exactly match the description in GitHub.
+PresetDB
+Community Sunshine game and app launch presets.
- 
+ 
+ 
+ 
+ 
+ 
+ 
+
+Community maintained launch presets for [Sunshine](https://github.com/LizardByte/Sunshine). Each game or app can have many presets across Windows, Linux, and macOS. Launch methods include direct executables, Steam, Epic Games, GOG, emulators, and other options. GitHub issue numbers provide stable preset IDs, while descriptive names distinguish emulator cores or store editions.
+
+Each GitHub issue requests **one preset**. Game requests must identify a [GameDB](https://app.lizardbyte.dev/GameDB/) record. App requests use a separate form and require a name and official source URL for maintainer review. A bot validates the request, and an authorized reviewer enters it into the approval queue. No code or pull request is needed to contribute.
+
+## Browse and use
+
+The [website](https://app.lizardbyte.dev/PresetDB/) shows games and apps with available presets. Each preset includes a Sunshine application JSON snippet. Replace supported path placeholders with paths on your host. Review community commands before running them. Game cover images come from GameDB; app images are submitted as HTTPS URLs for the catalog. These image URLs are not used as Sunshine `image-path` values, which require local files.
+
+The published JSON API contains `index.json`, `games/
+
+
+
+
+
+
+ 
+ 
+ 
+
+
+
+
+
+
+## Contribute
+
+1. Read the [preset guidelines](docs/presetGuidelines.md). For a game, copy its [IGDB game URL](https://www.igdb.com/) and [open a game preset request](https://github.com/LizardByte/PresetDB/issues/new?template=game-preset.yml). The bot resolves the URL slug to the IGDB numeric ID and checks GameDB. For another app, [open an app preset request](https://github.com/LizardByte/PresetDB/issues/new?template=app-preset.yml) with its official URL.
+2. Fill in **one** launch option. Choose the host OS and launch method, then give the preset a descriptive name such as `RetroArch with Snes9x` or `Steam URI`. Open another issue for another OS or option.
+3. Fill in one **Command**. Sunshine's [app examples](https://github.com/LizardByte/Sunshine/blob/master/docs/app_examples.md) show different Steam URI forms for Windows, Linux, and macOS. The bot stores Steam launcher URIs as Sunshine detached commands. Epic launcher URIs and executable commands become `cmd`. Commands are stored as text and never executed by validation or by the website.
+4. To replace a preset, provide its issue number and explain the change. The bot preserves the original preset ID.
+
+After validation, a listed trusted game contributor enters the approval queue automatically. Other requests wait for a listed approver or repository admin to comment `@LizardByte-bot approve`. App requests always require this separate review. The queue processes one approval at a time; see the [approver guide](docs/approverGuide.md) and [bot commands](docs/botCommands.md).
+
+Supported path placeholders in Command and Working directory are `{{ROM_PATH}}` and `{{HOME}}`; Windows also allows `{{SYSTEM_DRIVE}}`, `{{PROGRAM_FILES}}`, and `{{PROGRAM_FILES_X86}}`. Unknown or malformed placeholders are rejected. Literal commands still require maintainer review.
+
+Game submissions resolve the submitted slug through [IGDB's authenticated API](https://api-docs.igdb.com/), then check the resolved ID and slug against the live [GameDB JSON API](https://github.com/LizardByte/GameDB#data). An unavailable or mismatched result blocks approval. App submissions have no GameDB counterpart and always need separate maintainer review. Steam and Epic launcher URI syntax is checked against the selected host OS and method; binary commands still need human review.
+
+## Repository and deployment
+
+- `src/`: issue parsing, validation, database updates, and site assembly.
+- `database/`: starter database layout; approved records live on the `database` branch.
+- `gh-pages-template/`: Jekyll pages and browser assets.
+- `.github/workflows/`: request validation, approval, tests, and Pages build.
+- `auto_approved_users.json`: trusted approvers and game submitters eligible for automatic queueing.
+- `.readthedocs.yaml`: pull request preview builds using the shared LizardByte Jekyll script.
+
+The Pages workflow creates an archive from the database and site template, then calls the same [LizardByte Jekyll build workflow](https://github.com/LizardByte/LizardByte.github.io/blob/master/.github/workflows/jekyll-build.yml) used by GameDB and ThemerrDB. It deploys to `gh-pages` after changes to `master` or an approved database update.
+
+Before enabling automation in a new repository, create the `database` and `gh-pages` branches from `master`, set Pages to deploy from `gh-pages`, and configure `GH_BOT_TOKEN`, `GH_BOT_EMAIL`, `GH_BOT_NAME`, `TWITCH_CLIENT_ID`, and `TWITCH_CLIENT_SECRET` as in the existing LizardByte database projects. `GH_BOT_TOKEN` needs issue, contents, and Actions write access to publish the database and dispatch the Pages build. The Twitch credentials resolve IGDB slugs; GameDB itself needs no credentials. Create the `request-game-preset`, `request-app-preset`, `approve-queue`, and `approve-preset` labels. Set the GitHub repository description to the heading description above. The `database` branch retains the `database/` directory; approved records are written there.
+
+Connect this repository to Read the Docs and enable pull request preview builds. The preview configuration downloads the `site-source` artifact from the Pages build job and uses the shared LizardByte theme. See [developer setup](docs/developerSetup.md) for local commands.
+
+## Local checks
+
+Run `npm test` and `npm run lint`. To assemble the site locally, run `node src/build-site.js --database database --output site-build`, then serve `site-build` with a static server.
+
+## License
+
+AGPL-3.0-only. See [LICENSE](LICENSE).
diff --git a/auto_approved_users.json b/auto_approved_users.json
new file mode 100644
index 0000000000..3ec9e36631
--- /dev/null
+++ b/auto_approved_users.json
@@ -0,0 +1,9 @@
+[
+ {
+ "commands": [
+ "*"
+ ],
+ "user_id": 42013603,
+ "username": "ReenigneArcher"
+ }
+]
diff --git a/database/apps/.gitkeep b/database/apps/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/database/games/.gitkeep b/database/games/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/docs/approverGuide.md b/docs/approverGuide.md
new file mode 100644
index 0000000000..eb883e44e0
--- /dev/null
+++ b/docs/approverGuide.md
@@ -0,0 +1,13 @@
+# Approver Guide
+
+This guide is for listed approvers and repository administrators reviewing game and app preset issues.
+
+1. Open the oldest validated request in the [game queue](https://github.com/LizardByte/PresetDB/issues?q=is%3Aopen+label%3Arequest-game-preset) or [app queue](https://github.com/LizardByte/PresetDB/issues?q=is%3Aopen+label%3Arequest-app-preset). Check the latest validation comment after the last issue edit.
+2. For games, check the IGDB URL and resolved GameDB record. For apps, inspect the official URL and optional image URL. App requests always need a separate review, including when a trusted contributor submits them.
+3. Check the host OS, launch method, command, working directory, and setup notes against the [preset guidelines](presetGuidelines.md) and [Sunshine examples](https://github.com/LizardByte/Sunshine/blob/master/docs/app_examples.md). Review literal commands carefully; automated validation does not run them.
+4. Search the published record for an equivalent name, OS, and method. A replacement must identify an existing preset issue and explain the change.
+5. Comment `@LizardByte-bot approve` to enter the approval queue. The bot adds `approve-queue` and starts `approve-preset` when the active slot is free. It revalidates against IGDB and GameDB before writing to the `database` branch.
+
+The approval workflow comments its result. A successful approval closes the issue and requests a Pages rebuild. On failure, it removes the issue from the queue so the next request can proceed; fix the issue and queue it again. The `approve-preset` label remains on successfully closed issues for the approved count badge.
+
+The trusted user list lives in [`auto_approved_users.json`](../auto_approved_users.json). Add or remove an approver by changing that file in a reviewed pull request. A listed game submitter is queued automatically after successful validation. Repository administrators can also approve by comment.
diff --git a/docs/botCommands.md b/docs/botCommands.md
new file mode 100644
index 0000000000..d4fd52909e
--- /dev/null
+++ b/docs/botCommands.md
@@ -0,0 +1,8 @@
+# Bot Commands
+
+On an open game or app preset issue, a listed approver or repository administrator can comment:
+
+- `@LizardByte-bot approve` to put the request in the approval queue.
+- `@LizardByte-bot check` to rerun validation.
+
+The issue author may also use `@LizardByte-bot check`. The bot reacts to commands it accepts. Editing an issue body runs validation automatically.
diff --git a/docs/developerSetup.md b/docs/developerSetup.md
new file mode 100644
index 0000000000..ea4da8a0a1
--- /dev/null
+++ b/docs/developerSetup.md
@@ -0,0 +1,19 @@
+# Developer Setup
+
+The application, automation helpers, and site builder use Node.js 24. Install dependencies and run local checks with:
+
+```shell
+npm ci --ignore-scripts
+npm test
+npm run lint
+```
+
+Build the static site from the local database layout with:
+
+```shell
+node src/build-site.js --database database --output site-build
+```
+
+The site builder writes `index.json`, `stats.json`, two SVG contribution charts, and game and app records. It uses the `gh-pages-template` directory as the Jekyll source. The Pages workflow packages that output for the shared LizardByte Jekyll workflow.
+
+Read the Docs pull request previews use `.readthedocs.yaml` and the shared `readthedocs_build.sh` script. Connect the repository to Read the Docs, enable pull request builds, and ensure the `Build Pages` workflow can upload its `site-source` artifact for the PR commit. The shared script downloads `build.zip` from that artifact and builds the preview with the organization theme. Hosted preview and Pages deployment require the repository, credentials, and branch settings described in the README.
diff --git a/docs/presetGuidelines.md b/docs/presetGuidelines.md
new file mode 100644
index 0000000000..ba7ee8ebea
--- /dev/null
+++ b/docs/presetGuidelines.md
@@ -0,0 +1,21 @@
+# Preset Guidelines
+
+One issue requests one Sunshine launch option for one host operating system. Submit another issue for a different store, emulator, core, or operating system. Give each option a descriptive name so it can be distinguished from presets already listed on the website.
+
+## Games
+
+Use the public IGDB game URL. The bot resolves its slug to a numeric IGDB ID and requires the same game and slug in GameDB. The catalog obtains the game cover from GameDB, so the form has no image field.
+
+Choose the launch method that describes the command: Native, Steam, Epic Games, GOG, Emulator, or Other. Emulator details such as console, launcher, and core belong in the preset name or notes. They are not required fields.
+
+## Apps
+
+Provide the official HTTPS homepage or source repository. An app image is optional and must be an HTTPS URL. App requests have no GameDB record and always require separate maintainer review.
+
+## Commands and paths
+
+Enter one command. Sunshine's [application examples](https://github.com/LizardByte/Sunshine/blob/master/docs/app_examples.md) show the platform-specific Steam and Epic forms. Steam launcher URIs are stored as Sunshine detached commands; Epic launcher URIs and executable commands are stored as normal commands. The validator checks known URI forms against the selected OS and launch method. A maintainer reviews other commands before approval.
+
+The supported path placeholders are `{{ROM_PATH}}` and `{{HOME}}`. Windows also supports `{{SYSTEM_DRIVE}}`, `{{PROGRAM_FILES}}`, and `{{PROGRAM_FILES_X86}}`. These placeholders must be replaced with paths on the Sunshine host before use. Do not include a private username or a path that only exists on your computer.
+
+For replacements, enter the issue number displayed with the published preset and explain what changed. The original preset ID is retained.
diff --git a/gh-pages-template/_config.yml b/gh-pages-template/_config.yml
new file mode 100644
index 0000000000..4ffc83489a
--- /dev/null
+++ b/gh-pages-template/_config.yml
@@ -0,0 +1,3 @@
+---
+# LizardByte's shared Jekyll theme supplies the site layout.
+site-js: []
diff --git a/gh-pages-template/assets/js/app.js b/gh-pages-template/assets/js/app.js
new file mode 100644
index 0000000000..46cf6ddedf
--- /dev/null
+++ b/gh-pages-template/assets/js/app.js
@@ -0,0 +1,176 @@
+'use strict';
+
+function filterItems(index, query, kind, os) {
+ const needle = query.trim().toLowerCase();
+ return [
+ ...(index.games || []).map(item => ({ ...item, kind: 'game' })),
+ ...(index.apps || []).map(item => ({ ...item, kind: 'app' }))
+ ].filter(item =>
+ (kind === 'all' || item.kind === kind) &&
+ (os === 'all' || item.operating_systems.includes(os)) &&
+ item.name.toLowerCase().includes(needle)
+ ).sort((a, b) => a.name.localeCompare(b.name));
+}
+
+function sunshineSnippet(preset) {
+ return JSON.stringify(preset.sunshine, null, 2);
+}
+
+function normalizeBasePath(value) {
+ const configured = String(value || '');
+ return configured.includes('{{') ? '' : `/${configured}`.replace(/\/+/g, '/').replace(/\/$/, '');
+}
+
+function element(tag, className, content) {
+ const node = document.createElement(tag);
+ if (className) node.className = className;
+ if (content !== undefined) node.textContent = content;
+ return node;
+}
+
+function safeLink(url, text) {
+ const link = element('a', '', text);
+ try {
+ const parsed = new URL(url);
+ if (parsed.protocol === 'https:') {
+ link.href = parsed.href;
+ link.target = '_blank';
+ link.rel = 'noopener noreferrer';
+ }
+ } catch { /* The link stays plain text if the record has a bad URL. */ }
+ return link;
+}
+
+function safeImage(url) {
+ if (!url) return null;
+ try {
+ const parsed = new URL(url);
+ if (parsed.protocol !== 'https:') return null;
+ const img = element('img', 'd-block mx-auto mb-3');
+ img.src = parsed.href;
+ img.alt = '';
+ img.width = 100;
+ img.height = 130;
+ img.style.objectFit = 'contain';
+ img.loading = 'lazy';
+ return img;
+ } catch { return null; }
+}
+
+function boot() {
+ const base = normalizeBasePath(globalThis.PRESET_BASE);
+ const search = document.getElementById('preset-search');
+ const kind = document.getElementById('preset-kind');
+ const os = document.getElementById('preset-os');
+ const list = document.getElementById('preset-list');
+ const status = document.getElementById('preset-status');
+ const detail = document.getElementById('preset-detail');
+ let index;
+
+ function renderList() {
+ if (!index) return;
+ const items = filterItems(index, search.value, kind.value, os.value);
+ list.replaceChildren();
+ status.textContent = items.length ? `${items.length} games and apps found` : 'No matching presets yet.';
+ for (const item of items) {
+ const column = element('div', 'col');
+ const button = element('button', 'card h-100 w-100 text-start border-0 shadow-sm rounded-0 p-4');
+ button.type = 'button';
+ const image = safeImage(item.image_url);
+ if (image) button.append(image);
+ button.append(element('span', 'text-uppercase small text-warning fw-bold', item.kind));
+ button.append(element('span', 'd-block h5 mt-2 mb-1 fw-bold', item.name));
+ button.append(element('span', 'd-block text-muted', `${item.preset_count} preset${item.preset_count === 1 ? '' : 's'} · ${item.operating_systems.join(', ')}`));
+ button.addEventListener('click', () => {
+ const url = new URL(globalThis.location.href);
+ url.searchParams.set('kind', item.kind);
+ url.searchParams.set('id', String(item.id));
+ globalThis.history.pushState(null, '', url);
+ showRecord(item);
+ });
+ column.append(button);
+ list.append(column);
+ }
+ }
+
+ async function showRecord(item) {
+ detail.hidden = false;
+ detail.replaceChildren(element('p', '', 'Loading launch options…'));
+ try {
+ const folder = item.kind === 'game' ? 'games' : 'apps';
+ const response = await fetch(`${base}/${folder}/${encodeURIComponent(item.id)}.json`);
+ if (!response.ok) throw new Error(`HTTP ${response.status}`);
+ const record = await response.json();
+ const heading = element('h2', 'fw-bold', record.name);
+ detail.replaceChildren(heading, safeLink(record.source_url, item.kind === 'game' ? 'View on IGDB ↗' : 'Official app site ↗'));
+ const image = safeImage(record.image_url);
+ if (image) detail.prepend(image);
+ if (record.game_db_url) detail.append(element('span', 'mx-2'), safeLink(record.game_db_url, 'View in GameDB ↗'));
+ const presets = element('div', 'row row-cols-1 row-cols-lg-2 g-4 mt-2');
+ for (const preset of record.presets) {
+ const column = element('div', 'col');
+ const card = element('article', 'card h-100 rounded-0 shadow-sm');
+ const body = element('div', 'card-body');
+ const methodLabels = { native: 'Native', steam: 'Steam', 'epic-games': 'Epic Games', gog: 'GOG', emulator: 'Emulator', other: 'Other' };
+ const label = [preset.os, methodLabels[preset.method] || preset.method, preset.name].join(' · ');
+ body.append(element('h3', 'h5 card-title fw-bold', label));
+ if (preset.notes) body.append(element('p', 'card-text', preset.notes));
+ const command = element('pre', 'p-3 rounded bg-dark text-light overflow-auto');
+ command.append(element('code', '', sunshineSnippet(preset)));
+ body.append(command);
+ const copy = element('button', 'btn btn-warning rounded-0', 'Copy Sunshine JSON');
+ copy.type = 'button';
+ copy.addEventListener('click', async () => {
+ try {
+ await navigator.clipboard.writeText(sunshineSnippet(preset));
+ copy.textContent = 'Copied';
+ } catch {
+ copy.textContent = 'Select and copy the JSON above';
+ }
+ });
+ body.append(copy);
+ if (preset.origin_issue) body.append(element('span', 'ms-3'), safeLink(`https://github.com/LizardByte/PresetDB/issues/${preset.origin_issue}`, `Preset issue #${preset.origin_issue} ↗`));
+ if (preset.source_issue && preset.source_issue !== preset.origin_issue) {
+ body.append(element('span', 'ms-3'), safeLink(`https://github.com/LizardByte/PresetDB/issues/${preset.source_issue}`, 'Latest update ↗'));
+ }
+ card.append(body);
+ column.append(card);
+ presets.append(column);
+ }
+ detail.append(presets);
+ detail.scrollIntoView({ behavior: 'smooth', block: 'start' });
+ } catch (error) {
+ detail.replaceChildren(element('p', 'text-danger', `Could not load presets: ${error.message}`));
+ }
+ }
+
+ async function load() {
+ try {
+ const response = await fetch(`${base}/index.json`);
+ if (!response.ok) throw new Error(`HTTP ${response.status}`);
+ index = await response.json();
+ renderList();
+ const params = new URLSearchParams(globalThis.location.search);
+ const requestedKind = params.get('kind');
+ const requestedId = params.get('id');
+ if (requestedId && ['game', 'app'].includes(requestedKind)) {
+ const item = filterItems(index, '', requestedKind, 'all').find(entry => String(entry.id) === requestedId);
+ if (item) showRecord(item);
+ }
+ } catch (error) {
+ status.textContent = `Could not load the preset index: ${error.message}`;
+ }
+ }
+
+ for (const control of [search, kind, os]) control.addEventListener('input', renderList);
+ globalThis.addEventListener('popstate', () => {
+ const params = new URLSearchParams(globalThis.location.search);
+ const item = index && filterItems(index, '', params.get('kind'), 'all').find(entry => String(entry.id) === params.get('id'));
+ if (item) showRecord(item);
+ else detail.hidden = true;
+ });
+ load();
+}
+
+if (typeof document !== 'undefined') document.addEventListener('DOMContentLoaded', boot);
+if (typeof module !== 'undefined') module.exports = { filterItems, sunshineSnippet, normalizeBasePath };
diff --git a/gh-pages-template/index.html b/gh-pages-template/index.html
new file mode 100644
index 0000000000..5c26bfe58c
--- /dev/null
+++ b/gh-pages-template/index.html
@@ -0,0 +1,56 @@
+---
+title: Sunshine Presets
+layout: page
+full-width: true
+after-content:
+ - donate.html
+ - support.html
+js:
+ - /PresetDB/assets/js/app.js
+---
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/package-lock.json b/package-lock.json
new file mode 100644
index 0000000000..0e354c38f5
--- /dev/null
+++ b/package-lock.json
@@ -0,0 +1,16 @@
+{
+ "name": "presetdb",
+ "version": "0.0.0",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "presetdb",
+ "version": "0.0.0",
+ "license": "AGPL-3.0-only",
+ "engines": {
+ "node": ">=20"
+ }
+ }
+ }
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000000..3f119c17f5
--- /dev/null
+++ b/package.json
@@ -0,0 +1,14 @@
+{
+ "name": "presetdb",
+ "version": "0.0.0",
+ "private": true,
+ "description": "Community Sunshine game and app launch presets.",
+ "license": "AGPL-3.0-only",
+ "engines": {
+ "node": ">=20"
+ },
+ "scripts": {
+ "test": "node --test tests/*.test.js",
+ "lint": "node --check src/presets.js && node --check src/database.js && node --check src/issue.js && node --check src/build-site.js && node --check src/statistics.js && node --check src/approval-queue.js && node --check src/comment-command.js && node --check src/verify-approval.js && node --check src/workflow-queue.js && node --check gh-pages-template/assets/js/app.js"
+ }
+}
diff --git a/src/approval-queue.js b/src/approval-queue.js
new file mode 100644
index 0000000000..f1c485c1a3
--- /dev/null
+++ b/src/approval-queue.js
@@ -0,0 +1,82 @@
+'use strict';
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+const QUEUE_LABEL = 'approve-queue';
+const APPROVE_LABEL = 'approve-preset';
+const REQUEST_LABELS = new Set(['request-game-preset', 'request-app-preset']);
+
+function labelNames(issue) {
+ return new Set((issue.labels || []).map(label => typeof label === 'string' ? label : label.name));
+}
+
+function isPresetRequest(issue) {
+ const labels = labelNames(issue);
+ return issue.state === 'open' && !issue.pull_request &&
+ [...REQUEST_LABELS].filter(label => labels.has(label)).length === 1;
+}
+
+function loadApprovers(file = path.join(__dirname, '..', 'auto_approved_users.json')) {
+ const users = JSON.parse(fs.readFileSync(file, 'utf8'));
+ if (!Array.isArray(users)) throw new Error('auto_approved_users.json must contain a list');
+ return users;
+}
+
+function canApprove(userId, command = 'approve', users = loadApprovers()) {
+ const id = String(userId ?? '');
+ return id !== '' && users.some(user => String(user.user_id) === id &&
+ Array.isArray(user.commands) && (user.commands.includes('*') || user.commands.includes(command)));
+}
+
+function repoParams(context) {
+ return { owner: context.repo.owner, repo: context.repo.repo };
+}
+
+async function listOpenIssuesWithLabel({ github, context, label }) {
+ const issues = await github.paginate(github.rest.issues.listForRepo, {
+ ...repoParams(context), state: 'open', labels: label, per_page: 100
+ });
+ return issues.filter(issue => !issue.pull_request);
+}
+
+async function hasActiveApproval({ github, context, issueNumber }) {
+ const issues = await listOpenIssuesWithLabel({ github, context, label: APPROVE_LABEL });
+ return issues.some(issue => issue.number !== Number(issueNumber));
+}
+
+async function queueIssueForApproval({ github, context, issue = context.payload.issue }) {
+ if (!isPresetRequest(issue)) throw new Error('Only one open game or app preset request can be queued');
+ const labels = labelNames(issue);
+ if (labels.has(APPROVE_LABEL)) return [QUEUE_LABEL, APPROVE_LABEL];
+ const active = await hasActiveApproval({ github, context, issueNumber: issue.number });
+ const labelsToAdd = active ? [QUEUE_LABEL] : [QUEUE_LABEL, APPROVE_LABEL];
+ await github.rest.issues.addLabels({
+ ...repoParams(context), issue_number: issue.number, labels: labelsToAdd
+ });
+ return labelsToAdd;
+}
+
+async function releaseAndPromote({ github, context, issueNumber = context.issue.number }) {
+ const params = { ...repoParams(context), issue_number: issueNumber };
+ const { data: issue } = await github.rest.issues.get(params);
+ const labels = labelNames(issue);
+ const labelsToRemove = issue.state === 'closed' ? [QUEUE_LABEL] : [APPROVE_LABEL, QUEUE_LABEL];
+ for (const label of labelsToRemove) {
+ if (labels.has(label)) await github.rest.issues.removeLabel({ ...params, name: label });
+ }
+ if (await hasActiveApproval({ github, context, issueNumber })) return null;
+ const queued = await listOpenIssuesWithLabel({ github, context, label: QUEUE_LABEL });
+ const next = queued.filter(item => item.number !== Number(issueNumber) && isPresetRequest(item))
+ .sort((a, b) => new Date(a.created_at) - new Date(b.created_at) || a.number - b.number)[0];
+ if (!next) return null;
+ await github.rest.issues.addLabels({
+ ...repoParams(context), issue_number: next.number, labels: [APPROVE_LABEL]
+ });
+ return next;
+}
+
+module.exports = {
+ APPROVE_LABEL, QUEUE_LABEL, canApprove, hasActiveApproval, isPresetRequest,
+ labelNames, listOpenIssuesWithLabel, loadApprovers, queueIssueForApproval, releaseAndPromote
+};
diff --git a/src/build-site.js b/src/build-site.js
new file mode 100644
index 0000000000..570ca8c32e
--- /dev/null
+++ b/src/build-site.js
@@ -0,0 +1,51 @@
+'use strict';
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { buildStatistics } = require('./statistics');
+
+function buildSite(database, template, output) {
+ fs.mkdirSync(output, { recursive: true });
+ fs.cpSync(template, output, { recursive: true });
+ const index = { schema_version: 1, games: [], apps: [] };
+ const records = [];
+ for (const [folder, kind] of [['games', 'game'], ['apps', 'app']]) {
+ const directory = path.join(database, folder);
+ if (!fs.existsSync(directory)) continue;
+ const files = fs.readdirSync(directory).filter(file => file.endsWith('.json')).sort();
+ const target = path.join(output, folder);
+ fs.mkdirSync(target, { recursive: true });
+ for (const file of files) {
+ const item = JSON.parse(fs.readFileSync(path.join(directory, file), 'utf8'));
+ if (item.kind !== kind || !Array.isArray(item.presets) || item.presets.length === 0 ||
+ String(item.id) !== path.basename(file, '.json')) {
+ throw new Error(`Invalid database record: ${folder}/${file}`);
+ }
+ fs.copyFileSync(path.join(directory, file), path.join(target, file));
+ records.push(item);
+ index[folder].push({
+ id: item.id, name: item.name, preset_count: item.presets.length,
+ image_url: item.image_url || null,
+ operating_systems: [...new Set(item.presets.map(preset => preset.os))].sort()
+ });
+ }
+ index[folder].sort((a, b) => a.name.localeCompare(b.name) || String(a.id).localeCompare(String(b.id)));
+ }
+ fs.writeFileSync(path.join(output, 'index.json'), `${JSON.stringify(index, null, 2)}\n`);
+ const statistics = buildStatistics(index, records);
+ fs.writeFileSync(path.join(output, 'stats.json'), `${JSON.stringify(statistics.data, null, 2)}\n`);
+ fs.writeFileSync(path.join(output, 'top_contributors.svg'), statistics.contributorsSvg);
+ fs.writeFileSync(path.join(output, 'preset_growth.svg'), statistics.growthSvg);
+ return index;
+}
+
+function main(args = process.argv.slice(2)) {
+ const values = {};
+ for (let i = 0; i < args.length; i += 2) values[args[i]] = args[i + 1];
+ if (!values['--database'] || !values['--output']) throw new Error('Use --database and --output');
+ buildSite(values['--database'], values['--template'] || 'gh-pages-template', values['--output']);
+}
+
+if (require.main === module) main();
+
+module.exports = { buildSite };
diff --git a/src/comment-command.js b/src/comment-command.js
new file mode 100644
index 0000000000..f9a041eb1d
--- /dev/null
+++ b/src/comment-command.js
@@ -0,0 +1,43 @@
+'use strict';
+
+const { canApprove, isPresetRequest, labelNames, queueIssueForApproval } = require('./approval-queue');
+
+function commandFromComment(body) {
+ const match = String(body || '').trim().match(/^@LizardByte-bot\s+(approve|check)\s*$/i);
+ return match ? match[1].toLowerCase() : null;
+}
+
+async function isAuthorized({ github, context, command }) {
+ const user = context.payload.comment.user;
+ if (canApprove(user.id, command)) return true;
+ if (command === 'check' && user.id === context.payload.issue.user.id) return true;
+ try {
+ const { data } = await github.rest.repos.getCollaboratorPermissionLevel({
+ ...context.repo, username: user.login
+ });
+ return data.permission === 'admin';
+ } catch {
+ return false;
+ }
+}
+
+async function run({ github, context }) {
+ const command = commandFromComment(context.payload.comment.body);
+ if (!command || !isPresetRequest(context.payload.issue)) return false;
+ if (!await isAuthorized({ github, context, command })) return false;
+ if (command === 'approve') {
+ await queueIssueForApproval({ github, context });
+ } else {
+ const issue = context.payload.issue;
+ const label = labelNames(issue).has('request-game-preset') ? 'request-game-preset' : 'request-app-preset';
+ await github.rest.issues.removeLabel({ ...context.repo, issue_number: issue.number, name: label });
+ await new Promise(resolve => setTimeout(resolve, 1000));
+ await github.rest.issues.addLabels({ ...context.repo, issue_number: issue.number, labels: [label] });
+ }
+ await github.rest.reactions.createForIssueComment({
+ ...context.repo, comment_id: context.payload.comment.id, content: '+1'
+ });
+ return true;
+}
+
+module.exports = { commandFromComment, isAuthorized, run };
diff --git a/src/database.js b/src/database.js
new file mode 100644
index 0000000000..94899bcaef
--- /dev/null
+++ b/src/database.js
@@ -0,0 +1,90 @@
+'use strict';
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { PresetError } = require('./presets');
+
+function recordPath(root, preset) {
+ const folder = preset.kind === 'game' ? 'games' : 'apps';
+ const id = preset.kind === 'game' ? String(preset.gameId) : preset.appId;
+ return path.join(root, folder, `${id}.json`);
+}
+
+function readRecord(file) {
+ if (!fs.existsSync(file)) return null;
+ const record = JSON.parse(fs.readFileSync(file, 'utf8'));
+ if (!record || !Array.isArray(record.presets)) throw new PresetError(`Invalid database record: ${file}`);
+ return record;
+}
+
+function mergePreset(root, preset, {
+ issueNumber, approvedBy, authorId = null, authorLogin = null, approvedAt = new Date().toISOString()
+}, { write = false } = {}) {
+ const file = recordPath(root, preset);
+ let record = readRecord(file);
+ const name = preset.kind === 'game' ? preset.gameName : preset.appName;
+ const sourceUrl = preset.kind === 'game'
+ ? `https://www.igdb.com/games/${preset.gameSlug}` : preset.appUrl;
+ if (!record) {
+ record = {
+ schema_version: 1, kind: preset.kind, id: preset.kind === 'game' ? preset.gameId : preset.appId,
+ name, source_url: sourceUrl, image_url: null, presets: []
+ };
+ }
+ if (record.kind !== preset.kind || record.name !== name) {
+ if (preset.kind === 'app') throw new PresetError('An app with the same slug but a different name already exists');
+ record.name = name;
+ }
+ record.source_url = sourceUrl;
+ if (preset.kind === 'game') {
+ record.igdb_slug = preset.gameSlug;
+ record.game_db_url = `https://app.lizardbyte.dev/GameDB/browse/games/?id=${preset.gameId}`;
+ record.image_url = preset.gameImageUrl;
+ }
+ else if (preset.appImageUrl) record.image_url = preset.appImageUrl;
+ const previous = preset.replacementIssue == null ? -1 : record.presets.findIndex(item =>
+ item.origin_issue === preset.replacementIssue || item.source_issue === preset.replacementIssue
+ );
+ if (preset.replacementIssue != null && previous < 0) {
+ throw new PresetError(`No preset for issue #${preset.replacementIssue} exists under this ${preset.kind}`);
+ }
+ const normalizedName = preset.presetName.normalize('NFKC').toLocaleLowerCase();
+ if (record.presets.some((item, index) => index !== previous && item.os === preset.os &&
+ item.method === preset.method && item.name.normalize('NFKC').toLocaleLowerCase() === normalizedName)) {
+ throw new PresetError('A preset with this name, OS, and method already exists');
+ }
+ const originIssue = previous >= 0 ? record.presets[previous].origin_issue : issueNumber;
+ const presetId = `issue-${originIssue}`;
+ const history = previous >= 0 ? [...(record.presets[previous].history || [])] : [];
+ if (history.some(item => item.issue === issueNumber)) {
+ throw new PresetError(`Issue #${issueNumber} has already been approved for this preset`);
+ }
+ history.push({
+ issue: issueNumber, action: previous >= 0 ? 'replace' : 'add',
+ author_id: authorId, author_login: authorLogin, approved_at: approvedAt
+ });
+ const entry = {
+ id: presetId, name: preset.presetName, os: preset.os, method: preset.method,
+ sunshine: {
+ name: `${name} (${preset.presetName})`,
+ ...(preset.commandMode === 'detached' ? { detached: [preset.command] } : { cmd: preset.command }),
+ ...(preset.workingDir ? { 'working-dir': preset.workingDir } : {})
+ },
+ notes: preset.notes,
+ origin_issue: originIssue,
+ source_issue: issueNumber,
+ replacement_reason: preset.replacementReason || null,
+ approved_by: approvedBy,
+ history
+ };
+ if (previous >= 0) record.presets[previous] = entry;
+ else record.presets.push(entry);
+ record.presets.sort((a, b) => a.id.localeCompare(b.id));
+ if (write) {
+ fs.mkdirSync(path.dirname(file), { recursive: true });
+ fs.writeFileSync(file, `${JSON.stringify(record, null, 2)}\n`);
+ }
+ return { file, record, id: presetId, action: previous >= 0 ? 'replace' : 'add' };
+}
+
+module.exports = { mergePreset, readRecord, recordPath };
diff --git a/src/issue.js b/src/issue.js
new file mode 100644
index 0000000000..70e1d22d63
--- /dev/null
+++ b/src/issue.js
@@ -0,0 +1,68 @@
+'use strict';
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { parseIssue, validateFields, validateGameDb, PresetError } = require('./presets');
+const { mergePreset } = require('./database');
+
+function requestKind(issue) {
+ const labels = new Set((issue.labels || []).map(label => typeof label === 'string' ? label : label.name));
+ const game = labels.has('request-game-preset');
+ const app = labels.has('request-app-preset');
+ if (game === app) throw new PresetError('Issue must have exactly one request type label');
+ return game ? 'game' : 'app';
+}
+
+async function processIssue(event, database, { approve = false, actor = '', fetcher = globalThis.fetch, credentials = {} } = {}) {
+ const issue = event.issue;
+ if (!issue || !Number.isInteger(issue.number)) throw new PresetError('A GitHub issue event is required');
+ const kind = requestKind(issue);
+ const fields = parseIssue(issue.body || '');
+ const preset = await validateGameDb(validateFields(fields, kind), fetcher, credentials);
+ const merged = mergePreset(database, preset, {
+ issueNumber: issue.number, approvedBy: actor,
+ authorId: issue.user?.id ?? null, authorLogin: issue.user?.login ?? null
+ }, { write: approve });
+ return { ...merged, preset, kind };
+}
+
+function argsToObject(args) {
+ const options = {};
+ for (let i = 0; i < args.length; i += 2) {
+ if (!args[i]?.startsWith('--') || !args[i + 1]) throw new Error('Use --event, --database, --mode, and --report');
+ options[args[i].slice(2)] = args[i + 1];
+ }
+ if (!options.event || !options.database || !['check', 'approve'].includes(options.mode) || !options.report) {
+ throw new Error('Use --event, --database, --mode, and --report');
+ }
+ return options;
+}
+
+async function main(args = process.argv.slice(2)) {
+ const options = argsToObject(args);
+ let message;
+ let success = false;
+ try {
+ const event = JSON.parse(fs.readFileSync(options.event, 'utf8'));
+ const result = await processIssue(event, options.database, {
+ approve: options.mode === 'approve', actor: process.env.GITHUB_ACTOR || 'local'
+ });
+ const item = result.kind === 'game' ? `GameDB game ${result.preset.gameId}` : `app ${result.preset.appName}`;
+ const entry = result.record.presets.find(preset => preset.id === result.id);
+ message = `Preset ${result.action === 'replace' ? 'replacement' : 'request'} validated for ${item}.\n\n` +
+ `- Host: ${result.preset.os}\n- Method: ${result.preset.method}\n- Preset ID: \`${result.id}\`\n` +
+ `- Status: ${options.mode === 'approve' ? 'approved and saved' : 'awaiting maintainer review'}\n\n` +
+ `Sunshine application preview:\n\n\`\`\`json\n${JSON.stringify(entry.sunshine, null, 2)}\n\`\`\`\n`;
+ success = true;
+ } catch (error) {
+ message = `Preset validation failed: ${String(error.message).replace(/[\r\n]+/g, ' ').slice(0, 500)}\n`;
+ }
+ fs.mkdirSync(path.dirname(options.report), { recursive: true });
+ fs.writeFileSync(options.report, message);
+ console.log(message);
+ if (!success) process.exitCode = 1;
+}
+
+if (require.main === module) main().catch(error => { console.error(error); process.exitCode = 1; });
+
+module.exports = { processIssue, requestKind };
diff --git a/src/presets.js b/src/presets.js
new file mode 100644
index 0000000000..60953b46b0
--- /dev/null
+++ b/src/presets.js
@@ -0,0 +1,230 @@
+'use strict';
+
+const GAME_DB = 'https://app.lizardbyte.dev/GameDB';
+const PATH_PLACEHOLDERS = new Set(['ROM_PATH', 'HOME', 'SYSTEM_DRIVE', 'PROGRAM_FILES', 'PROGRAM_FILES_X86']);
+const WINDOWS_PATH_PLACEHOLDERS = new Set(['SYSTEM_DRIVE', 'PROGRAM_FILES', 'PROGRAM_FILES_X86']);
+const FIELD_NAMES = {
+ 'IGDB game URL': 'gameUrl',
+ 'App name': 'appName',
+ 'Official app URL': 'appUrl',
+ 'App image URL': 'appImageUrl',
+ 'Host operating system': 'os',
+ 'Launch method': 'method',
+ 'Preset name': 'presetName',
+ Command: 'command',
+ 'Working directory': 'workingDir',
+ Notes: 'notes',
+ 'Preset to replace (issue number)': 'replacementIssue',
+ 'Replacement reason': 'replacementReason'
+};
+
+class PresetError extends Error {}
+
+function parseIssue(body) {
+ const result = {};
+ const sections = body.split(/^### (.+)\s*$/m);
+ for (let i = 1; i < sections.length; i += 2) {
+ const key = FIELD_NAMES[sections[i].trim()];
+ if (key) {
+ if (Object.hasOwn(result, key)) throw new PresetError(`Duplicate issue field: ${key}`);
+ const value = sections[i + 1].trim();
+ result[key] = value === '_No response_' ? '' : value;
+ }
+ }
+ return result;
+}
+
+function field(values, name, { required = false, limit = 1024, singleLine = false } = {}) {
+ const value = String(values[name] || '').trim();
+ if (required && !value) throw new PresetError(`${name} is required`);
+ if (value.length > limit || /[\x00-\x08\x0B-\x1F\x7F]/.test(value) || (singleLine && /[\r\n]/.test(value))) {
+ throw new PresetError(`${name} is too long or contains invalid characters`);
+ }
+ return value;
+}
+
+function positiveId(value, label) {
+ if (!/^[1-9][0-9]{0,14}$/.test(value) || !Number.isSafeInteger(Number(value))) {
+ throw new PresetError(`${label} must be a positive issue number`);
+ }
+ return Number(value);
+}
+
+function slug(value) {
+ const result = value.toLowerCase().normalize('NFKD').replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
+ if (!result) throw new PresetError('Name must contain letters or digits');
+ return result;
+}
+
+function validatePlaceholders(value, os, label) {
+ const tokens = [...value.matchAll(/\{\{([A-Z0-9_]+)\}\}/g)];
+ const remainder = value.replace(/\{\{[A-Z0-9_]+\}\}/g, '');
+ if (remainder.includes('{{') || remainder.includes('}}')) {
+ throw new PresetError(`${label} contains a malformed path placeholder`);
+ }
+ for (const [, token] of tokens) {
+ if (!PATH_PLACEHOLDERS.has(token)) throw new PresetError(`${label} uses unsupported placeholder {{${token}}}`);
+ if (os !== 'Windows' && WINDOWS_PATH_PLACEHOLDERS.has(token)) {
+ throw new PresetError(`{{${token}}} is available on Windows only`);
+ }
+ }
+}
+
+function validateFields(values, kind) {
+ if (kind !== 'game' && kind !== 'app') throw new PresetError('Exactly one request type is required');
+ const os = field(values, 'os', { required: true, limit: 20, singleLine: true });
+ const method = field(values, 'method', { required: true, limit: 30, singleLine: true });
+ if (!['Windows', 'Linux', 'macOS'].includes(os) ||
+ !['Native', 'Steam', 'Epic Games', 'GOG', 'Emulator', 'Other'].includes(method)) {
+ throw new PresetError('Choose a supported host OS and launch method');
+ }
+ const presetName = field(values, 'presetName', { required: true, limit: 100, singleLine: true });
+
+ let gameId = null;
+ let gameSlug = null;
+ let appName = null;
+ let appUrl = null;
+ let appId = null;
+ let appImageUrl = null;
+ if (kind === 'game') {
+ const gameUrl = field(values, 'gameUrl', { required: true, limit: 300, singleLine: true });
+ let url;
+ try { url = new URL(gameUrl); } catch { throw new PresetError('IGDB game URL is invalid'); }
+ const match = url.pathname.match(/^\/games\/([a-z0-9-]+)\/?$/);
+ if (url.origin !== 'https://www.igdb.com' || url.search || url.hash || !match) {
+ throw new PresetError('IGDB game URL must be https://www.igdb.com/games/
+
+
+
+
+ Sunshine game and app presets
+Community launch options for Windows, Linux, and macOS. Find a game or app, then choose the preset that fits your host.
+ +Browse presets
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Loading presets…
+ +
+ 
+ 
diff --git a/gh-pages-template/index.html b/gh-pages-template/index.html
index 5c26bfe58c..d6ea6b9fa8 100644
--- a/gh-pages-template/index.html
+++ b/gh-pages-template/index.html
@@ -48,7 +48,7 @@ Browse presets
Loading presets…
+ diff --git a/package.json b/package.json index 3f119c17f5..6dbcc7a574 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ }, "scripts": { "test": "node --test tests/*.test.js", - "lint": "node --check src/presets.js && node --check src/database.js && node --check src/issue.js && node --check src/build-site.js && node --check src/statistics.js && node --check src/approval-queue.js && node --check src/comment-command.js && node --check src/verify-approval.js && node --check src/workflow-queue.js && node --check gh-pages-template/assets/js/app.js" + "lint": "node --check src/presets.js && node --check src/database.js && node --check src/issue.js && node --check src/build-site.js && node --check src/statistics.js && node --check src/approval-queue.js && node --check src/comment-command.js && node --check src/verify-approval.js && node --check src/workflow-queue.js && node --check gh-pages-template/assets/js/app.js", + "test:ci": "node --test --experimental-test-coverage --test-reporter=junit --test-reporter=lcov --test-reporter-destination=junit.xml --test-reporter-destination=lcov.info tests/*.test.js" } } diff --git a/src/build-site.js b/src/build-site.js index 570ca8c32e..24bbb8aaab 100644 --- a/src/build-site.js +++ b/src/build-site.js @@ -26,7 +26,7 @@ function buildSite(database, template, output) { index[folder].push({ id: item.id, name: item.name, preset_count: item.presets.length, image_url: item.image_url || null, - operating_systems: [...new Set(item.presets.map(preset => preset.os))].sort() + operating_systems: [...new Set(item.presets.map(preset => preset.os))].sort((a, b) => a.localeCompare(b)) }); } index[folder].sort((a, b) => a.name.localeCompare(b.name) || String(a.id).localeCompare(String(b.id))); diff --git a/src/comment-command.js b/src/comment-command.js index f9a041eb1d..059fe9dfc6 100644 --- a/src/comment-command.js +++ b/src/comment-command.js @@ -3,7 +3,7 @@ const { canApprove, isPresetRequest, labelNames, queueIssueForApproval } = require('./approval-queue'); function commandFromComment(body) { - const match = String(body || '').trim().match(/^@LizardByte-bot\s+(approve|check)\s*$/i); + const match = /^@LizardByte-bot\s+(approve|check)\s*$/i.exec(String(body || '').trim()); return match ? match[1].toLowerCase() : null; } diff --git a/src/database.js b/src/database.js index 94899bcaef..cfd868862a 100644 --- a/src/database.js +++ b/src/database.js @@ -17,14 +17,12 @@ function readRecord(file) { return record; } -function mergePreset(root, preset, { - issueNumber, approvedBy, authorId = null, authorLogin = null, approvedAt = new Date().toISOString() -}, { write = false } = {}) { +function prepareRecord(root, preset) { const file = recordPath(root, preset); - let record = readRecord(file); const name = preset.kind === 'game' ? preset.gameName : preset.appName; const sourceUrl = preset.kind === 'game' ? `https://www.igdb.com/games/${preset.gameSlug}` : preset.appUrl; + let record = readRecord(file); if (!record) { record = { schema_version: 1, kind: preset.kind, id: preset.kind === 'game' ? preset.gameId : preset.appId, @@ -42,6 +40,10 @@ function mergePreset(root, preset, { record.image_url = preset.gameImageUrl; } else if (preset.appImageUrl) record.image_url = preset.appImageUrl; + return { file, record, name }; +} + +function replacementIndex(record, preset) { const previous = preset.replacementIssue == null ? -1 : record.presets.findIndex(item => item.origin_issue === preset.replacementIssue || item.source_issue === preset.replacementIssue ); @@ -53,6 +55,14 @@ function mergePreset(root, preset, { item.method === preset.method && item.name.normalize('NFKC').toLocaleLowerCase() === normalizedName)) { throw new PresetError('A preset with this name, OS, and method already exists'); } + return previous; +} + +function mergePreset(root, preset, { + issueNumber, approvedBy, authorId = null, authorLogin = null, approvedAt = new Date().toISOString() +}, { write = false } = {}) { + const { file, record, name } = prepareRecord(root, preset); + const previous = replacementIndex(record, preset); const originIssue = previous >= 0 ? record.presets[previous].origin_issue : issueNumber; const presetId = `issue-${originIssue}`; const history = previous >= 0 ? [...(record.presets[previous].history || [])] : []; diff --git a/src/presets.js b/src/presets.js index 60953b46b0..d43f96fd54 100644 --- a/src/presets.js +++ b/src/presets.js @@ -22,7 +22,7 @@ class PresetError extends Error {} function parseIssue(body) { const result = {}; - const sections = body.split(/^### (.+)\s*$/m); + const sections = body.split(/^### ([^\r\n]+)$/m); for (let i = 1; i < sections.length; i += 2) { const key = FIELD_NAMES[sections[i].trim()]; if (key) { @@ -44,7 +44,7 @@ function field(values, name, { required = false, limit = 1024, singleLine = fals } function positiveId(value, label) { - if (!/^[1-9][0-9]{0,14}$/.test(value) || !Number.isSafeInteger(Number(value))) { + if (!/^[1-9]\d{0,14}$/.test(value) || !Number.isSafeInteger(Number(value))) { throw new PresetError(`${label} must be a positive issue number`); } return Number(value); @@ -70,53 +70,49 @@ function validatePlaceholders(value, os, label) { } } -function validateFields(values, kind) { - if (kind !== 'game' && kind !== 'app') throw new PresetError('Exactly one request type is required'); - const os = field(values, 'os', { required: true, limit: 20, singleLine: true }); - const method = field(values, 'method', { required: true, limit: 30, singleLine: true }); - if (!['Windows', 'Linux', 'macOS'].includes(os) || - !['Native', 'Steam', 'Epic Games', 'GOG', 'Emulator', 'Other'].includes(method)) { - throw new PresetError('Choose a supported host OS and launch method'); +function gameIdentity(values) { + const gameUrl = field(values, 'gameUrl', { required: true, limit: 300, singleLine: true }); + let url; + try { url = new URL(gameUrl); } catch { throw new PresetError('IGDB game URL is invalid'); } + const match = /^\/games\/([a-z0-9-]+)\/?$/.exec(url.pathname); + if (url.origin !== 'https://www.igdb.com' || url.search || url.hash || !match) { + throw new PresetError('IGDB game URL must be https://www.igdb.com/games/
-
+ 
From 0fe8146ad19cc3b1034d15d2b3c44965a7b1bc4b Mon Sep 17 00:00:00 2001
From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
Date: Wed, 23 Sep 2026 14:01:56 -0400
Subject: [PATCH 04/12] docs: restore dashboard Codecov badge
---
.github/workflows/ci-tests.yml | 6 +++---
README.md | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
index 94e595a047..2be839ec22 100644
--- a/.github/workflows/ci-tests.yml
+++ b/.github/workflows/ci-tests.yml
@@ -32,6 +32,9 @@ jobs:
id: test
run: npm run test:ci
+ - name: Lint
+ run: npm run lint
+
- name: Upload test coverage
# any except cancelled or skipped
if:
@@ -65,6 +68,3 @@ jobs:
report_type: test_results
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true
-
- - name: Lint
- run: npm run lint
diff --git a/README.md b/README.md
index 2bf7281eee..f9d94551b8 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
-
+
@@ -67,7 +67,7 @@ Game submissions resolve the submitted slug through [IGDB's authenticated API](h
The Pages workflow creates an archive from the database and site template, then calls the same [LizardByte Jekyll build workflow](https://github.com/LizardByte/LizardByte.github.io/blob/master/.github/workflows/jekyll-build.yml) used by GameDB and ThemerrDB. It deploys to `gh-pages` after changes to `master` or an approved database update.
-Before enabling automation in a new repository, create the `database` and `gh-pages` branches from `master`, set Pages to deploy from `gh-pages`, and configure `GH_BOT_TOKEN`, `GH_BOT_EMAIL`, `GH_BOT_NAME`, `TWITCH_CLIENT_ID`, and `TWITCH_CLIENT_SECRET` as in the existing LizardByte database projects. `GH_BOT_TOKEN` needs issue, contents, and Actions write access to publish the database and dispatch the Pages build. The Twitch credentials resolve IGDB slugs; GameDB itself needs no credentials. Create the `request-game-preset`, `request-app-preset`, `approve-queue`, and `approve-preset` labels. Set the GitHub repository description to the heading description above. The `database` branch retains the `database/` directory; approved records are written there.
+The empty `database` branch is initialized with `database/apps` and `database/games`. Before enabling automation, create the `gh-pages` branch from `master`, set Pages to deploy from `gh-pages`, and configure `GH_BOT_TOKEN`, `GH_BOT_EMAIL`, `GH_BOT_NAME`, `TWITCH_CLIENT_ID`, and `TWITCH_CLIENT_SECRET` as in the existing LizardByte database projects. `GH_BOT_TOKEN` needs issue, contents, and Actions write access to publish the database and dispatch the Pages build. The Twitch credentials resolve IGDB slugs; GameDB itself needs no credentials. Create the `request-game-preset`, `request-app-preset`, `approve-queue`, and `approve-preset` labels. Set the GitHub repository description to the heading description above. The `database` branch retains the `database/` directory; approved records are written there.
Connect this repository to Read the Docs and enable pull request preview builds. The preview configuration downloads the `site-source` artifact from the Pages build job and uses the shared LizardByte theme. See [developer setup](docs/developerSetup.md) for local commands.
From 827faaf91433cfb7f34c17f4850cf8f9b5b3a1af Mon Sep 17 00:00:00 2001
From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
Date: Wed, 23 Sep 2026 14:44:02 -0400
Subject: [PATCH 05/12] Refine preset submission methods and generated names
---
.github/ISSUE_TEMPLATE/app-preset.yml | 24 +--------
.github/ISSUE_TEMPLATE/game-preset.yml | 15 +++---
.readthedocs.yaml | 2 +-
README.md | 12 ++---
docs/approverGuide.md | 4 +-
docs/developerSetup.md | 10 +++-
docs/presetGuidelines.md | 10 ++--
gh-pages-template/assets/js/app.js | 4 +-
src/database.js | 26 +++++++---
src/issue.js | 3 +-
src/presets.js | 71 +++++++++++++++++---------
tests/presets.test.js | 61 +++++++++++++++-------
12 files changed, 144 insertions(+), 98 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/app-preset.yml b/.github/ISSUE_TEMPLATE/app-preset.yml
index c06eac75e8..ffe9811795 100644
--- a/.github/ISSUE_TEMPLATE/app-preset.yml
+++ b/.github/ISSUE_TEMPLATE/app-preset.yml
@@ -9,7 +9,7 @@ body:
attributes:
value: |
Apps have no GameDB record. A maintainer reviews the official URL and command before approval.
- Submit one host OS and launch option per issue.
+ Submit one host OS and command per issue. The preset name is generated from the app name and OS.
- type: input
id: app_name
attributes:
@@ -39,33 +39,13 @@ body:
- macOS
validations:
required: true
- - type: dropdown
- id: method
- attributes:
- label: Launch method
- options:
- - Native
- - Steam
- - Epic Games
- - GOG
- - Emulator
- - Other
- validations:
- required: true
- - type: input
- id: preset_name
- attributes:
- label: Preset name
- description: Short display name for this launch option.
- validations:
- required: true
- type: input
id: command
attributes:
label: Command
description: |
Use {{HOME}} for a variable path. Windows also allows {{SYSTEM_DRIVE}}, {{PROGRAM_FILES}}, and
- {{PROGRAM_FILES_X86}}. Steam launcher URIs are stored as Sunshine detached commands automatically.
+ {{PROGRAM_FILES_X86}}. Use only host-independent paths; literal home directories are rejected.
validations:
required: true
- type: input
diff --git a/.github/ISSUE_TEMPLATE/game-preset.yml b/.github/ISSUE_TEMPLATE/game-preset.yml
index 3b5e90272c..1e9a0f4c9a 100644
--- a/.github/ISSUE_TEMPLATE/game-preset.yml
+++ b/.github/ISSUE_TEMPLATE/game-preset.yml
@@ -9,7 +9,7 @@ body:
attributes:
value: |
One issue represents one launch option. Provide the IGDB game URL; the bot resolves its ID and checks GameDB.
- Use a descriptive preset name to distinguish stores, emulators, cores, or other choices.
+ Add an emulator variant only when the operating system and launch method cannot distinguish the preset.
- type: input
id: game_url
attributes:
@@ -36,24 +36,23 @@ body:
- Steam
- Epic Games
- GOG
+ - Microsoft Store
- Emulator
- - Other
validations:
required: true
- type: input
- id: preset_name
+ id: variant_name
attributes:
- label: Preset name
- description: Short display name, for example RetroArch with Snes9x.
- validations:
- required: true
+ label: Emulator variant name
+ description: Optional emulator, console, or core label when needed to distinguish launch options.
- type: input
id: command
attributes:
label: Command
description: |
Use {{ROM_PATH}} or {{HOME}} for variable paths. Windows also allows {{SYSTEM_DRIVE}}, {{PROGRAM_FILES}},
- and {{PROGRAM_FILES_X86}}. Steam launcher URIs are stored as Sunshine detached commands automatically.
+ and {{PROGRAM_FILES_X86}}. Use only host-independent paths; literal home directories are rejected.
+ Steam launcher URIs require detached commands; use a Steam executable command.
validations:
required: true
- type: input
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index e57188179f..89e2d2c8f2 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -22,4 +22,4 @@ build:
chmod +x "./tmp/readthedocs_build.sh"
build:
html:
- - GITHUB_WORKFLOW=build SITE_ARTIFACT=site-source EXTRACT_ARCHIVE=build.zip ./tmp/readthedocs_build.sh
+ - ./tmp/readthedocs_build.sh
diff --git a/README.md b/README.md
index f9d94551b8..d565c9dad0 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@
Sunshine game and app presets
Community launch options for Windows, Linux, and macOS. Find a game or app, then choose the preset that fits your host.
- Contribute a game preset + Contribute a game preset Contribute an app preset
diff --git a/src/build-site.js b/src/build-site.js index 24bbb8aaab..33b38b70b0 100644 --- a/src/build-site.js +++ b/src/build-site.js @@ -4,11 +4,46 @@ const fs = require('node:fs'); const path = require('node:path'); const { buildStatistics } = require('./statistics'); -function buildSite(database, template, output) { +function supportedOs(preset) { + if (preset.os) return [preset.os]; + return preset.sunshine_by_os ? Object.keys(preset.sunshine_by_os) : ['Windows', 'Linux', 'macOS']; +} + +const PROTON_TIERS = new Set(['borked', 'bronze', 'silver', 'gold', 'platinum', 'native']); + +async function protonDbRating(appId, fetcher) { + try { + const response = await fetcher('https://www.protondb.com/api/v1/reports/summaries/' + appId + '.json', { + headers: { Accept: 'application/json' }, signal: AbortSignal.timeout(5000) + }); + if (!response.ok) return null; + const summary = await response.json(); + if (!summary || !PROTON_TIERS.has(summary.tier)) return null; + return { + tier: summary.tier, + reports: Number.isInteger(summary.total) && summary.total >= 0 ? summary.total : null + }; + } catch { + return null; + } +} + +async function addProtonDb(item, fetcher, cache) { + for (const preset of item.presets) { + if (preset.method !== 'steam' || !/^[1-9]\d{0,9}$/.test(preset.launch_id || '')) continue; + const appId = preset.launch_id; + preset.protondb_url = 'https://www.protondb.com/app/' + appId; + if (!cache.has(appId)) cache.set(appId, await protonDbRating(appId, fetcher)); + preset.protondb = cache.get(appId); + } +} + +async function buildSite(database, template, output, fetcher = globalThis.fetch) { fs.mkdirSync(output, { recursive: true }); fs.cpSync(template, output, { recursive: true }); const index = { schema_version: 1, games: [], apps: [] }; const records = []; + const protonCache = new Map(); for (const [folder, kind] of [['games', 'game'], ['apps', 'app']]) { const directory = path.join(database, folder); if (!fs.existsSync(directory)) continue; @@ -21,12 +56,13 @@ function buildSite(database, template, output) { String(item.id) !== path.basename(file, '.json')) { throw new Error(`Invalid database record: ${folder}/${file}`); } - fs.copyFileSync(path.join(directory, file), path.join(target, file)); + await addProtonDb(item, fetcher, protonCache); + fs.writeFileSync(path.join(target, file), JSON.stringify(item, null, 2) + '\n'); records.push(item); index[folder].push({ id: item.id, name: item.name, preset_count: item.presets.length, image_url: item.image_url || null, - operating_systems: [...new Set(item.presets.map(preset => preset.os))].sort((a, b) => a.localeCompare(b)) + operating_systems: [...new Set(item.presets.flatMap(supportedOs))].sort((a, b) => a.localeCompare(b)) }); } index[folder].sort((a, b) => a.name.localeCompare(b.name) || String(a.id).localeCompare(String(b.id))); @@ -39,13 +75,13 @@ function buildSite(database, template, output) { return index; } -function main(args = process.argv.slice(2)) { +async function main(args = process.argv.slice(2)) { const values = {}; for (let i = 0; i < args.length; i += 2) values[args[i]] = args[i + 1]; if (!values['--database'] || !values['--output']) throw new Error('Use --database and --output'); - buildSite(values['--database'], values['--template'] || 'gh-pages-template', values['--output']); + await buildSite(values['--database'], values['--template'] || 'gh-pages-template', values['--output']); } -if (require.main === module) main(); +if (require.main === module) main().catch(error => { console.error(error); process.exitCode = 1; }); -module.exports = { buildSite }; +module.exports = { buildSite, protonDbRating }; diff --git a/src/database.js b/src/database.js index 3eb3dfa360..8d235b1e4c 100644 --- a/src/database.js +++ b/src/database.js @@ -43,15 +43,18 @@ function prepareRecord(root, preset) { return { file, record, name }; } -function displayName(name, preset) { - if (preset.kind === 'app') return `${name} (${preset.os})`; - const labels = { +function methodLabel(method) { + return { native: 'Native', steam: 'Steam', 'epic-games': 'Epic Games', gog: 'GOG', 'microsoft-store': 'Microsoft Store', emulator: 'Emulator' - }; - const method = labels[preset.method]; + }[method]; +} + +function displayName(name, preset) { + if (preset.kind === 'app') return `${name} (${preset.os})`; + const method = methodLabel(preset.method); const variant = preset.variantName ? `: ${preset.variantName}` : ''; - return `${name} (${preset.os}, ${method}${variant})`; + return preset.os ? name + ' (' + preset.os + ', ' + method + variant + ')' : name + ' (' + method + variant + ')'; } function replacementIndex(record, preset) { @@ -90,11 +93,17 @@ function mergePreset(root, preset, { id: presetId, name: generatedName, os: preset.os, method: preset.method, ...(preset.variantName ? { variant_name: preset.variantName } : {}), ...(preset.launchId ? { launch_id: preset.launchId } : {}), - sunshine: { - name: generatedName, - cmd: preset.command, - ...(preset.workingDir ? { 'working-dir': preset.workingDir } : {}) - }, + ...(preset.commandsByOs ? { + sunshine_by_os: Object.fromEntries(Object.entries(preset.commandsByOs).map(([os, cmd]) => [ + os, { name: name + ' (' + os + ', ' + methodLabel(preset.method) + ')', cmd } + ])) + } : { + sunshine: { + name: generatedName, + cmd: preset.command, + ...(preset.workingDir ? { 'working-dir': preset.workingDir } : {}) + } + }), notes: preset.notes, origin_issue: originIssue, source_issue: issueNumber, diff --git a/src/issue.js b/src/issue.js index 80cfaff31e..ac01649d47 100644 --- a/src/issue.js +++ b/src/issue.js @@ -5,6 +5,23 @@ const path = require('node:path'); const { parseIssue, validateFields, validateGameDb, PresetError } = require('./presets'); const { mergePreset } = require('./database'); +const METHOD_LABELS = { + 'method-native': 'Native', + 'method-steam': 'Steam', + 'method-epic-games': 'Epic Games', + 'method-gog': 'GOG', + 'method-microsoft-store': 'Microsoft Store', + 'method-emulator': 'Emulator' +}; + +function requestMethod(issue, kind) { + if (kind === 'app') return null; + const labels = (issue.labels || []).map(label => typeof label === 'string' ? label : label.name); + const methods = labels.filter(label => Object.hasOwn(METHOD_LABELS, label)); + if (methods.length !== 1) throw new PresetError('Game issue must have exactly one launch method label'); + return METHOD_LABELS[methods[0]]; +} + function requestKind(issue) { const labels = new Set((issue.labels || []).map(label => typeof label === 'string' ? label : label.name)); const game = labels.has('request-game-preset'); @@ -18,6 +35,9 @@ async function processIssue(event, database, { approve = false, actor = '', fetc if (!issue || !Number.isInteger(issue.number)) throw new PresetError('A GitHub issue event is required'); const kind = requestKind(issue); const fields = parseIssue(issue.body || ''); + const method = requestMethod(issue, kind); + if (fields.method && fields.method !== method) throw new PresetError('Issue launch method does not match its template'); + if (method) fields.method = method; const preset = await validateGameDb(validateFields(fields, kind), fetcher, credentials); const merged = mergePreset(database, preset, { issueNumber: issue.number, approvedBy: actor, @@ -49,11 +69,12 @@ async function main(args = process.argv.slice(2)) { }); const item = result.kind === 'game' ? `GameDB game ${result.preset.gameId}` : `app ${result.preset.appName}`; const entry = result.record.presets.find(preset => preset.id === result.id); + const preview = entry.sunshine || entry.sunshine_by_os; const methodLine = result.kind === 'game' ? `- Method: ${result.preset.method}\n` : ''; message = `Preset ${result.action === 'replace' ? 'replacement' : 'request'} validated for ${item}.\n\n` + - `- Host: ${result.preset.os}\n` + methodLine + `- Preset ID: \`${result.id}\`\n` + + `- Host: ${result.preset.os || 'OS independent'}\n` + methodLine + `- Preset ID: \`${result.id}\`\n` + `- Status: ${options.mode === 'approve' ? 'approved and saved' : 'awaiting maintainer review'}\n\n` + - `Sunshine application preview:\n\n\`\`\`json\n${JSON.stringify(entry.sunshine, null, 2)}\n\`\`\`\n`; + `Sunshine application JSON preview:\n\n\`\`\`json\n${JSON.stringify(preview, null, 2)}\n\`\`\`\n`; success = true; } catch (error) { message = `Preset validation failed: ${String(error.message).replace(/[\r\n]+/g, ' ').slice(0, 500)}\n`; diff --git a/src/presets.js b/src/presets.js index 598587773e..3304576f3f 100644 --- a/src/presets.js +++ b/src/presets.js @@ -79,7 +79,7 @@ function validatePortablePath(value, os, label) { if (homeRoot.test(normalized) || homeVariable.test(normalized)) { throw new PresetError(`${label} contains a literal home directory; use {{HOME}}`); } - if (os === 'Windows' && + if ((os === 'Windows' || os === null) && /(?:^|[/\s"'=])(?:con|prn|aux|nul|com[1-9\u00B9\u00B2\u00B3]|lpt[1-9\u00B9\u00B2\u00B3])(?:\.[^/\s"']*)?(?=$|[/\s"'])/i.test(normalized)) { throw new PresetError(`${label} contains a reserved Windows device name`); } @@ -121,36 +121,44 @@ function appIdentity(values) { }; } -function generatedLaunch(values, method, os) { - const id = field(values, 'launchId', { limit: 300, singleLine: true }); - if (!['Steam', 'Epic Games', 'Microsoft Store'].includes(method)) { - if (id) throw new PresetError('Launch ID requires Steam, Epic Games, or Microsoft Store'); - return null; +function steamLaunch(id) { + if (!/^[1-9]\d{0,9}$/.test(id) || Number(id) > 4294967295) { + throw new PresetError('Steam app ID must be a positive 32-bit number'); } + const uri = 'steam://rungameid/' + id; + return { launchId: id, commandsByOs: { + Windows: 'cmd /c start "" "' + uri + '"', + Linux: 'steam "' + uri + '"', + macOS: 'open "' + uri + '"' + } }; +} - if (method === 'Steam') { - if (!/^[1-9]\d{0,9}$/.test(id) || Number(id) > 4294967295) { - throw new PresetError('Steam app ID must be a positive 32-bit number'); - } - const uri = 'steam://rungameid/' + id; - const command = os === 'Windows' ? 'cmd /c start "" "' + uri + '"' - : os === 'macOS' ? 'open "' + uri + '"' : 'steam "' + uri + '"'; - return { command, launchId: id }; - } - if (method === 'Epic Games') { - const parts = id.split(/%3A|:/i); - if (parts.length !== 3 || parts.some(part => !/^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/.test(part))) { - throw new PresetError('Epic launch ID must contain Sandbox ID, Catalog ID, and Artifact ID'); - } - const launchId = parts.join('%3A'); - const uri = 'com.epicgames.launcher://apps/' + launchId + '?action=launch&silent=true'; - const command = os === 'Windows' ? 'cmd /c start "" "' + uri + '"' : 'open "' + uri + '"'; - return { command, launchId }; +function epicLaunch(id) { + const parts = id.split(/%3A|:/i); + if (parts.length !== 3 || parts.some(part => !/^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/.test(part))) { + throw new PresetError('Epic launch ID must contain Sandbox ID, Catalog ID, and Artifact ID'); } + const launchId = parts.join('%3A'); + const uri = 'com.epicgames.launcher://apps/' + launchId + '?action=launch&silent=true'; + return { launchId, commandsByOs: { + Windows: 'cmd /c start "" "' + uri + '"', + macOS: 'open "' + uri + '"' + } }; +} + +function microsoftStoreLaunch(id) { if (!/^[A-Za-z0-9][A-Za-z0-9._-]*_[A-Za-z0-9]{13}![A-Za-z0-9][A-Za-z0-9._-]*$/.test(id)) { throw new PresetError('Microsoft Store AUMID must contain a package family name and application ID'); } - return { command: 'explorer.exe shell:AppsFolder\\' + id, launchId: id }; + return { launchId: id, commandsByOs: { Windows: 'explorer.exe shell:AppsFolder\\' + id } }; +} + +function generatedLaunch(values, method) { + const id = field(values, 'launchId', { limit: 300, singleLine: true }); + const generators = { Steam: steamLaunch, 'Epic Games': epicLaunch, 'Microsoft Store': microsoftStoreLaunch }; + if (Object.hasOwn(generators, method)) return generators[method](id); + if (id) throw new PresetError('Launch ID requires Steam, Epic Games, or Microsoft Store'); + return null; } function validateManualLaunchCommand(command) { @@ -169,50 +177,59 @@ function replacementFields(values) { return { replacementIssue, replacementReason }; } -function validateFields(values, kind) { - if (kind !== 'game' && kind !== 'app') throw new PresetError('Exactly one request type is required'); - const os = field(values, 'os', { required: true, limit: 20, singleLine: true }); - if (!['Windows', 'Linux', 'macOS'].includes(os)) { - throw new PresetError('Choose a supported host OS'); - } +function gameMethod(values, kind) { const suppliedMethod = field(values, 'method', { limit: 30, singleLine: true }); - const method = kind === 'app' ? 'Native' : suppliedMethod; - if (kind === 'app' && suppliedMethod) { - throw new PresetError('App requests do not have a launch method'); + if (kind === 'app') { + if (suppliedMethod) throw new PresetError('App requests do not have a launch method'); + return 'Native'; } - if (kind === 'game' && - !['Native', 'Steam', 'Epic Games', 'GOG', 'Microsoft Store', 'Emulator'].includes(method)) { + if (!['Native', 'Steam', 'Epic Games', 'GOG', 'Microsoft Store', 'Emulator'].includes(suppliedMethod)) { throw new PresetError('Choose a supported game launch method'); } - if (method === 'Microsoft Store' && os !== 'Windows') { - throw new PresetError('Microsoft Store is available on Windows only'); - } - if (method === 'Epic Games' && os === 'Linux') { - throw new PresetError('Epic Games launcher IDs are available on Windows and macOS only'); - } - const variantName = field(values, 'variantName', { limit: 100, singleLine: true }); - if (variantName && method !== 'Emulator') { - throw new PresetError('An emulator variant name requires the Emulator launch method'); - } - const identity = kind === 'game' ? gameIdentity(values) : appIdentity(values); - const launch = generatedLaunch(values, method, os); + return suppliedMethod; +} + +function hostOs(values, kind, method) { + const required = kind === 'app' || method === 'Native' || method === 'GOG'; + const os = field(values, 'os', { required, limit: 20, singleLine: true }); + if (os && !['Windows', 'Linux', 'macOS'].includes(os)) throw new PresetError('Choose a supported host OS'); + if (!required && os) throw new PresetError('This launch method does not accept a host OS'); + return os || null; +} + +function manualCommand(values, method, os, launch) { const submittedCommand = field(values, 'command', { required: !launch, singleLine: true }); const workingDir = field(values, 'workingDir', { limit: 512, singleLine: true }); if (launch && submittedCommand) throw new PresetError('Do not provide a command for a store ID launch'); if (launch && workingDir) throw new PresetError('Working directory is not used with a store ID launch'); - const command = launch ? launch.command : submittedCommand; - validatePlaceholders(command, os, 'Launch command'); + if (launch) return { command: null, workingDir: null }; + validatePlaceholders(submittedCommand, os, 'Launch command'); validatePlaceholders(workingDir, os, 'Working directory'); - if (method !== 'Emulator' && (command.includes('{{ROM_PATH}}') || workingDir.includes('{{ROM_PATH}}'))) { + if (method !== 'Emulator' && + (submittedCommand.includes('{{ROM_PATH}}') || workingDir.includes('{{ROM_PATH}}'))) { throw new PresetError('{{ROM_PATH}} requires the Emulator launch method'); } - validatePortablePath(command, os, 'Launch command'); + validatePortablePath(submittedCommand, os, 'Launch command'); validatePortablePath(workingDir, os, 'Working directory'); - if (!launch) validateManualLaunchCommand(command); + validateManualLaunchCommand(submittedCommand); + return { command: submittedCommand, workingDir: workingDir || null }; +} + +function validateFields(values, kind) { + if (kind !== 'game' && kind !== 'app') throw new PresetError('Exactly one request type is required'); + const method = gameMethod(values, kind); + const os = hostOs(values, kind, method); + const variantName = field(values, 'variantName', { limit: 100, singleLine: true }); + if (variantName && method !== 'Emulator') { + throw new PresetError('An emulator variant name requires the Emulator launch method'); + } + const identity = kind === 'game' ? gameIdentity(values) : appIdentity(values); + const launch = generatedLaunch(values, method); + const { command, workingDir } = manualCommand(values, method, os, launch); return { kind, ...identity, variantName: variantName || null, ...replacementFields(values), - os, method: slug(method), command, launchId: launch ? launch.launchId : null, - workingDir: workingDir || null, + os, method: slug(method), command, launchId: launch?.launchId || null, + commandsByOs: launch?.commandsByOs || null, workingDir, notes: field(values, 'notes', { limit: 2000 }) || null }; } diff --git a/tests/presets.test.js b/tests/presets.test.js index f433b77958..d39dc7cba4 100644 --- a/tests/presets.test.js +++ b/tests/presets.test.js @@ -13,7 +13,7 @@ const { filterItems, sunshineSnippet, normalizeBasePath } = require('../gh-pages const credentials = { clientId: 'client-id', clientSecret: 'client-secret' }; const gameValues = { - gameUrl: 'https://www.igdb.com/games/one-tap-hero', os: 'Windows', method: 'Emulator', + gameUrl: 'https://www.igdb.com/games/one-tap-hero', method: 'Emulator', variantName: 'RetroArch Snes9x', command: 'retroarch -L snes9x "{{ROM_PATH}}"', workingDir: '{{HOME}}', notes: 'Install the core first.' }; @@ -56,24 +56,23 @@ test('form parses the slug URL and rejects duplicate fields', () => { assert.throws(() => parseIssue(`${formBody(gameValues)}\n\n### Command\n\nother`), /Duplicate issue field/); }); -test('game submission needs no ID and validates path placeholders', () => { +test('emulator needs no OS and validates portable path placeholders', () => { const preset = validateFields(gameValues, 'game'); assert.equal(preset.gameId, null); assert.equal(preset.gameSlug, 'one-tap-hero'); + assert.equal(preset.os, null); assert.equal(preset.variantName, 'RetroArch Snes9x'); - assert.equal(validateFields({ ...gameValues, command: '{{PROGRAM_FILES}}\\Game\\game.exe' }, 'game').os, 'Windows'); - assert.throws(() => validateFields({ ...gameValues, os: 'Linux', command: '{{PROGRAM_FILES}}/game' }, 'game'), /Windows only/); + assert.throws(() => validateFields({ ...gameValues, os: 'Windows' }, 'game'), /does not accept a host OS/); + assert.throws(() => validateFields({ ...gameValues, command: '{{PROGRAM_FILES}}/game' }, 'game'), /Windows only/); assert.throws(() => validateFields({ ...gameValues, command: '{{EMULATOR_PATH}} -L core' }, 'game'), /unsupported placeholder/); assert.throws(() => validateFields({ ...gameValues, command: '{{rom_path}}' }, 'game'), /malformed path placeholder/); for (const command of ['C:\\Users\\Alice\\Game\\game.exe', '%USERPROFILE%\\Game\\game.exe']) { assert.throws(() => validateFields({ ...gameValues, command }, 'game'), /literal home directory/); } - for (const workingDir of ['C:\\Games\\CON.txt', 'C:\\Games\\COM1\\Game', 'C:\\Games\\COM\u00B9']) { + for (const workingDir of ['C:\\Games\\CON.txt', 'C:\\Games\\COM1\\Game']) { assert.throws(() => validateFields({ ...gameValues, workingDir }, 'game'), /reserved Windows device name/); } - assert.throws(() => validateFields({ ...gameValues, os: 'Linux', workingDir: '/home/alice/Games' }, 'game'), - /literal home directory/); - assert.throws(() => validateFields({ ...gameValues, os: 'macOS', workingDir: '/Users/alice/Games' }, 'game'), + assert.throws(() => validateFields({ ...gameValues, workingDir: '/home/alice/Games' }, 'game'), /literal home directory/); assert.throws(() => validateFields({ ...gameValues, workingDir: '~/Games' }, 'game'), /literal home directory/); }); @@ -116,37 +115,26 @@ test('apps use an HTTPS image URL and have separate review identity', () => { assert.throws(() => validateFields({ ...values, command: '{{ROM_PATH}}' }, 'app'), /ROM_PATH.*Emulator/); }); -test('store IDs generate OS-specific Sunshine commands', () => { +test('store IDs generate commands for each launcher OS without asking for OS', () => { const base = { ...gameValues, variantName: '', command: '', workingDir: '' }; - const steamCommands = { + const steam = validateFields({ ...base, method: 'Steam', launchId: '464920' }, 'game'); + assert.equal(steam.os, null); + assert.deepEqual(steam.commandsByOs, { Windows: 'cmd /c start "" "steam://rungameid/464920"', Linux: 'steam "steam://rungameid/464920"', macOS: 'open "steam://rungameid/464920"' - }; - for (const [os, command] of Object.entries(steamCommands)) { - const preset = validateFields({ ...base, os, method: 'Steam', launchId: '464920' }, 'game'); - assert.equal(preset.command, command); - assert.equal(preset.launchId, '464920'); - } - const epic = 'fn%3A4fe75bbc5a674f4f9b356b5c90567da5%3AFortnite'; - const epicUri = 'com.epicgames.launcher://apps/' + epic + '?action=launch&silent=true'; - for (const [os, command] of [ - ['Windows', 'cmd /c start "" "' + epicUri + '"'], - ['macOS', 'open "' + epicUri + '"'] - ]) { - const preset = validateFields({ ...base, os, method: 'Epic Games', - launchId: 'fn:4fe75bbc5a674f4f9b356b5c90567da5:Fortnite' }, 'game'); - assert.equal(preset.launchId, epic); - assert.equal(preset.command, command); - } + }); + const epic = validateFields({ ...base, method: 'Epic Games', + launchId: 'fn:4fe75bbc5a674f4f9b356b5c90567da5:Fortnite' }, 'game'); + assert.equal(epic.launchId, 'fn%3A4fe75bbc5a674f4f9b356b5c90567da5%3AFortnite'); + assert.deepEqual(Object.keys(epic.commandsByOs), ['Windows', 'macOS']); const aumid = 'Microsoft.WindowsCalculator_8wekyb3d8bbwe!App'; const store = validateFields({ ...base, method: 'Microsoft Store', launchId: aumid }, 'game'); - assert.equal(store.command, 'explorer.exe shell:AppsFolder\\' + aumid); - assert.equal(store.launchId, aumid); + assert.deepEqual(store.commandsByOs, { Windows: 'explorer.exe shell:AppsFolder\\' + aumid }); assert.equal(parseIssue(formBody({ ...base, method: 'Steam', launchId: '464920' })).launchId, '464920'); }); -test('store IDs validate syntax, method, and host OS', () => { +test('store IDs validate syntax and reject host OS or manual commands', () => { const base = { ...gameValues, variantName: '', command: '', workingDir: '' }; assert.throws(() => validateFields({ ...base, method: 'Steam' }, 'game'), /Steam app ID/); assert.throws(() => validateFields({ ...base, method: 'Steam', launchId: '1&whoami' }, 'game'), /Steam app ID/); @@ -155,32 +143,33 @@ test('store IDs validate syntax, method, and host OS', () => { command: 'other.exe' }, 'game'), /Do not provide a command/); assert.throws(() => validateFields({ ...base, method: 'Steam', launchId: '464920', workingDir: '{{HOME}}' }, 'game'), /Working directory is not used/); - assert.throws(() => validateFields({ ...base, method: 'Native', launchId: '464920', + assert.throws(() => validateFields({ ...base, method: 'Native', os: 'Windows', launchId: '464920', command: 'game.exe' }, 'game'), /Launch ID requires/); assert.throws(() => validateFields({ ...base, method: 'Epic Games', os: 'Linux', - launchId: 'fn:catalog:Fortnite' }, 'game'), /Windows and macOS only/); + launchId: 'fn:catalog:Fortnite' }, 'game'), /does not accept a host OS/); assert.throws(() => validateFields({ ...base, method: 'Epic Games', launchId: 'fn:catalog:Game&calc' }, 'game'), /Epic launch ID/); assert.throws(() => validateFields({ ...base, method: 'Microsoft Store', launchId: '9WZDNCRFHVJL' }, 'game'), /Microsoft Store AUMID/); - assert.throws(() => validateFields({ ...base, method: 'Microsoft Store', os: 'Linux', - launchId: 'Microsoft.WindowsCalculator_8wekyb3d8bbwe!App' }, 'game'), /Windows only/); }); -test('Native, GOG, and Emulator still require reviewed commands', () => { +test('Native and GOG require OS; Emulator accepts a portable command', () => { const base = { ...gameValues, variantName: '', command: '', workingDir: '' }; - for (const method of ['Native', 'GOG', 'Emulator']) { - assert.throws(() => validateFields({ ...base, method }, 'game'), /command is required/); + for (const method of ['Native', 'GOG']) { + assert.throws(() => validateFields({ ...base, method }, 'game'), /os is required/); + assert.throws(() => validateFields({ ...base, method, os: 'Windows' }, 'game'), /command is required/); } - assert.equal(validateFields({ ...base, method: 'GOG', command: 'game.exe' }, 'game').command, 'game.exe'); + assert.throws(() => validateFields({ ...base, method: 'Emulator' }, 'game'), /command is required/); + assert.equal(validateFields({ ...base, method: 'GOG', os: 'Windows', command: 'game.exe' }, 'game').command, + 'game.exe'); assert.throws(() => validateFields({ ...base, method: 'Other', command: 'game.exe' }, 'game'), /supported game launch method/); - assert.throws(() => validateFields({ ...base, method: 'Native', command: 'steam://rungameid/464920' }, 'game'), - /Launcher URIs require/); - assert.throws(() => validateFields({ ...base, method: 'Native', command: '{{ROM_PATH}}' }, 'game'), - /ROM_PATH.*Emulator/); - assert.throws(() => validateFields({ ...base, method: 'Native', command: 'game.exe', - variantName: 'Alternate' }, 'game'), /Emulator/); + assert.throws(() => validateFields({ ...base, method: 'Native', os: 'Windows', + command: 'steam://rungameid/464920' }, 'game'), /Launcher URIs require/); + assert.throws(() => validateFields({ ...base, method: 'Native', os: 'Windows', + command: '{{ROM_PATH}}' }, 'game'), /ROM_PATH.*Emulator/); + assert.throws(() => validateFields({ ...base, method: 'Native', os: 'Windows', + command: 'game.exe', variantName: 'Alternate' }, 'game'), /Emulator/); }); test('approved presets get issue IDs and replacements preserve identity', async t => { @@ -199,7 +188,7 @@ test('approved presets get issue IDs and replacements preserve identity', async const record = JSON.parse(fs.readFileSync(path.join(root, 'games/100245.json'))); assert.equal(record.presets.length, 2); assert.equal(record.presets.find(item => item.id === 'issue-10').sunshine.cmd, 'new-command'); - assert.equal(record.presets.find(item => item.id === 'issue-10').name, 'One Tap Hero (Windows, Emulator: RetroArch Snes9x)'); + assert.equal(record.presets.find(item => item.id === 'issue-10').name, 'One Tap Hero (Emulator: RetroArch Snes9x)'); assert.equal(record.presets.find(item => item.id === 'issue-10').origin_issue, 10); assert.equal(record.presets.find(item => item.id === 'issue-10').source_issue, 13); assert.throws(() => validateFields({ ...gameValues, replacementIssue: '10' }, 'game'), /replacement needs both/); @@ -207,17 +196,18 @@ test('approved presets get issue IDs and replacements preserve identity', async { issueNumber: 14, approvedBy: 'maintainer' }), /No preset/); }); -test('Steam app ID publishes a generated Sunshine command without detached or image paths', async t => { +test('Steam app ID publishes one logical preset with host-specific Sunshine commands', async t => { const root = fs.mkdtempSync(path.join(os.tmpdir(), 'preset-steam-')); t.after(() => fs.rmSync(root, { recursive: true, force: true })); const steam = await validateGameDb(validateFields({ ...gameValues, method: 'Steam', variantName: '', command: '', workingDir: '', launchId: '464920' }, 'game'), mockApis, credentials); const { record } = mergePreset(root, steam, { issueNumber: 30, approvedBy: 'reviewer' }, { write: true }); assert.equal(record.presets[0].launch_id, '464920'); - assert.equal(record.presets[0].sunshine.cmd, 'cmd /c start "" "steam://rungameid/464920"'); - assert.equal(record.presets[0].sunshine.name, 'One Tap Hero (Windows, Steam)'); - assert.ok(!Object.hasOwn(record.presets[0].sunshine, 'detached')); - assert.ok(!Object.hasOwn(record.presets[0].sunshine, 'image-path')); + assert.equal(record.presets[0].sunshine_by_os.Windows.cmd, 'cmd /c start "" "steam://rungameid/464920"'); + assert.equal(record.presets[0].sunshine_by_os.Linux.cmd, 'steam "steam://rungameid/464920"'); + assert.equal(record.presets[0].name, 'One Tap Hero (Steam)'); + assert.ok(!Object.hasOwn(record.presets[0], 'detached')); + assert.ok(!Object.hasOwn(record.presets[0], 'image-path')); }); test('issue processing and site build publish both game and app JSON', async t => { @@ -225,14 +215,15 @@ test('issue processing and site build publish both game and app JSON', async t = t.after(() => fs.rmSync(root, { recursive: true, force: true })); const database = path.join(root, 'database'); const output = path.join(root, 'site'); - await processIssue({ issue: { number: 21, labels: [{ name: 'request-game-preset' }], body: formBody(gameValues) } }, + await processIssue({ issue: { number: 21, labels: [{ name: 'request-game-preset' }, { name: 'method-emulator' }], body: formBody(gameValues) } }, database, { approve: true, actor: 'reviewer', fetcher: mockApis, credentials }); await processIssue({ issue: { number: 22, labels: [{ name: 'request-app-preset' }], body: formBody({ appName: 'App One', appUrl: 'https://example.org', appImageUrl: 'https://example.org/icon.png', os: 'Linux', command: '{{HOME}}/app-one' }) } }, database, { approve: true, actor: 'reviewer' }); - const index = buildSite(database, path.join(__dirname, '..', 'gh-pages-template'), output); + const index = await buildSite(database, path.join(__dirname, '..', 'gh-pages-template'), output); assert.equal(index.games[0].preset_count, 1); + assert.deepEqual(index.games[0].operating_systems, ['Linux', 'macOS', 'Windows']); assert.equal(index.apps[0].id, 'app-one'); assert.equal(index.apps[0].image_url, 'https://example.org/icon.png'); assert.equal(JSON.parse(fs.readFileSync(path.join(output, 'apps/app-one.json'))).presets[0].name, 'App One (Linux)'); @@ -253,3 +244,56 @@ test('site filters and serializes Sunshine application JSON', () => { assert.equal(normalizeBasePath('/PresetDB'), '/PresetDB'); assert.equal(normalizeBasePath('en/pr-123'), '/en/pr-123'); }); + +test('Pages build adds a ProtonDB tier to Steam presets and keeps the source link', async t => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'preset-proton-')); + t.after(() => fs.rmSync(root, { recursive: true, force: true })); + const database = path.join(root, 'database'); + const output = path.join(root, 'site'); + const steam = await validateGameDb(validateFields({ ...gameValues, method: 'Steam', + variantName: '', command: '', workingDir: '', launchId: '464920' }, 'game'), mockApis, credentials); + mergePreset(database, steam, { issueNumber: 31, approvedBy: 'reviewer' }, { write: true }); + const fetcher = async url => { + assert.equal(url, 'https://www.protondb.com/api/v1/reports/summaries/464920.json'); + return { ok: true, json: async () => ({ tier: 'gold', total: 73 }) }; + }; + const index = await buildSite(database, path.join(__dirname, '..', 'gh-pages-template'), output, fetcher); + assert.deepEqual(index.games[0].operating_systems, ['Linux', 'macOS', 'Windows']); + const published = JSON.parse(fs.readFileSync(path.join(output, 'games/100245.json'))); + assert.deepEqual(published.presets[0].protondb, { tier: 'gold', reports: 73 }); + assert.equal(published.presets[0].protondb_url, 'https://www.protondb.com/app/464920'); + assert.equal(JSON.parse(sunshineSnippet(published.presets[0], 'Linux')).cmd, + 'steam "steam://rungameid/464920"'); +}); + +test('game method labels select the form and reject conflicting issue fields', async t => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'preset-method-')); + t.after(() => fs.rmSync(root, { recursive: true, force: true })); + const issue = { number: 42, body: formBody({ gameUrl: gameValues.gameUrl, + launchId: '464920' }), labels: ['request-game-preset', 'method-steam'] }; + const result = await processIssue({ issue }, root, { fetcher: mockApis, credentials }); + assert.equal(result.preset.method, 'steam'); + await assert.rejects(processIssue({ issue: { ...issue, labels: ['request-game-preset'] } }, + root, { fetcher: mockApis, credentials }), /exactly one launch method label/); + await assert.rejects(processIssue({ issue: { ...issue, + labels: ['request-game-preset', 'method-steam', 'method-native'] } }, + root, { fetcher: mockApis, credentials }), /exactly one launch method label/); + await assert.rejects(processIssue({ issue: { ...issue, + body: formBody({ gameUrl: gameValues.gameUrl, method: 'Native', launchId: '464920' }) } }, + root, { fetcher: mockApis, credentials }), /does not match its template/); +}); + +test('missing ProtonDB ratings remain unknown without failing the Pages build', async t => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'preset-proton-missing-')); + t.after(() => fs.rmSync(root, { recursive: true, force: true })); + const database = path.join(root, 'database'); + const output = path.join(root, 'site'); + const steam = await validateGameDb(validateFields({ ...gameValues, method: 'Steam', + variantName: '', command: '', workingDir: '', launchId: '464920' }, 'game'), mockApis, credentials); + mergePreset(database, steam, { issueNumber: 43, approvedBy: 'reviewer' }, { write: true }); + await buildSite(database, path.join(__dirname, '..', 'gh-pages-template'), output, + async () => ({ ok: false, status: 404 })); + const published = JSON.parse(fs.readFileSync(path.join(output, 'games/100245.json'))); + assert.equal(published.presets[0].protondb, null); + assert.equal(published.presets[0].protondb_url, 'https://www.protondb.com/app/464920'); +}); From fed77813c32d0a173f072e495f9e82ef5641b53d Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Wed, 23 Sep 2026 17:06:03 -0400 Subject: [PATCH 12/12] Simplify catalog preset card rendering --- gh-pages-template/assets/js/app.js | 128 +++++++++++++++++------------ 1 file changed, 76 insertions(+), 52 deletions(-) diff --git a/gh-pages-template/assets/js/app.js b/gh-pages-template/assets/js/app.js index d4249821b1..532bfa0f00 100644 --- a/gh-pages-template/assets/js/app.js +++ b/gh-pages-template/assets/js/app.js @@ -59,6 +59,81 @@ function safeImage(url) { } catch { return null; } } +function protonRatingLabel(preset) { + const tier = preset.protondb?.tier; + if (!tier) return 'Check Linux compatibility on ProtonDB'; + let label = 'ProtonDB: ' + tier[0].toUpperCase() + tier.slice(1); + if (Number.isInteger(preset.protondb.reports)) label += ' (' + preset.protondb.reports + ' reports)'; + return label; +} + +function appendProtonRating(body, preset) { + if (!preset.protondb_url) return; + const proton = element('p', 'card-text'); + proton.append(safeLink(preset.protondb_url, protonRatingLabel(preset))); + body.append(proton); +} + +function hostSelection(body, preset) { + if (!preset.sunshine_by_os) return null; + const label = element('label', 'form-label', 'Host OS'); + const select = element('select', 'form-select rounded-0 mb-3'); + for (const host of Object.keys(preset.sunshine_by_os)) { + const option = element('option', '', host); + option.value = host; + select.append(option); + } + label.append(select); + body.append(label); + return select; +} + +function appendIssueLinks(body, preset) { + if (preset.origin_issue) { + body.append(element('span', 'ms-3'), safeLink( + 'https://github.com/LizardByte/PresetDB/issues/' + preset.origin_issue, + 'Preset issue #' + preset.origin_issue + ' ↗' + )); + } + if (preset.source_issue && preset.source_issue !== preset.origin_issue) { + body.append(element('span', 'ms-3'), safeLink( + 'https://github.com/LizardByte/PresetDB/issues/' + preset.source_issue, + 'Latest update ↗' + )); + } +} + +function renderPresetCard(preset) { + const column = element('div', 'col'); + const card = element('article', 'card h-100 rounded-0 shadow-sm'); + const body = element('div', 'card-body'); + body.append(element('h3', 'h5 card-title fw-bold', preset.name)); + if (preset.notes) body.append(element('p', 'card-text', preset.notes)); + appendProtonRating(body, preset); + const hostSelect = hostSelection(body, preset); + const snippet = () => sunshineSnippet(preset, hostSelect?.value); + const command = element('pre', 'p-3 rounded bg-dark text-light overflow-auto'); + const code = element('code', '', snippet()); + command.append(code); + if (hostSelect) hostSelect.addEventListener('change', () => { code.textContent = snippet(); }); + body.append(command); + const copy = element('button', 'btn btn-warning rounded-0', 'Copy Sunshine JSON'); + copy.type = 'button'; + copy.addEventListener('click', async () => { + try { + await navigator.clipboard.writeText(snippet()); + copy.textContent = 'Copied'; + } catch { + copy.textContent = 'Select and copy the JSON above'; + } + }); + body.append(copy); + appendIssueLinks(body, preset); + card.append(body); + column.append(card); + return column; +} + function boot() { const base = normalizeBasePath(globalThis.PRESET_BASE); const search = document.getElementById('preset-search'); @@ -109,58 +184,7 @@ function boot() { if (image) detail.prepend(image); if (record.game_db_url) detail.append(element('span', 'mx-2'), safeLink(record.game_db_url, 'View in GameDB ↗')); const presets = element('div', 'row row-cols-1 row-cols-lg-2 g-4 mt-2'); - for (const preset of record.presets) { - const column = element('div', 'col'); - const card = element('article', 'card h-100 rounded-0 shadow-sm'); - const body = element('div', 'card-body'); - body.append(element('h3', 'h5 card-title fw-bold', preset.name)); - if (preset.notes) body.append(element('p', 'card-text', preset.notes)); - if (preset.protondb_url) { - const tier = preset.protondb?.tier; - const reports = preset.protondb?.reports; - const rating = tier ? 'ProtonDB: ' + tier[0].toUpperCase() + tier.slice(1) + - (reports === null ? '' : ' (' + reports + ' reports)') : 'Check Linux compatibility on ProtonDB'; - const proton = element('p', 'card-text'); - proton.append(safeLink(preset.protondb_url, rating)); - body.append(proton); - } - let hostSelect; - if (preset.sunshine_by_os) { - const hostLabel = element('label', 'form-label', 'Host OS'); - hostSelect = element('select', 'form-select rounded-0 mb-3'); - for (const host of Object.keys(preset.sunshine_by_os)) { - const option = element('option', '', host); - option.value = host; - hostSelect.append(option); - } - hostLabel.append(hostSelect); - body.append(hostLabel); - } - const snippet = () => sunshineSnippet(preset, hostSelect?.value); - const command = element('pre', 'p-3 rounded bg-dark text-light overflow-auto'); - const code = element('code', '', snippet()); - command.append(code); - if (hostSelect) hostSelect.addEventListener('change', () => { code.textContent = snippet(); }); - body.append(command); - const copy = element('button', 'btn btn-warning rounded-0', 'Copy Sunshine JSON'); - copy.type = 'button'; - copy.addEventListener('click', async () => { - try { - await navigator.clipboard.writeText(snippet()); - copy.textContent = 'Copied'; - } catch { - copy.textContent = 'Select and copy the JSON above'; - } - }); - body.append(copy); - if (preset.origin_issue) body.append(element('span', 'ms-3'), safeLink(`https://github.com/LizardByte/PresetDB/issues/${preset.origin_issue}`, `Preset issue #${preset.origin_issue} ↗`)); - if (preset.source_issue && preset.source_issue !== preset.origin_issue) { - body.append(element('span', 'ms-3'), safeLink(`https://github.com/LizardByte/PresetDB/issues/${preset.source_issue}`, 'Latest update ↗')); - } - card.append(body); - column.append(card); - presets.append(column); - } + for (const preset of record.presets) presets.append(renderPresetCard(preset)); detail.append(presets); detail.scrollIntoView({ behavior: 'smooth', block: 'start' }); } catch (error) {