From bf395ec40cdbaf6647efac21822c05caab5b7d1f Mon Sep 17 00:00:00 2001 From: DecDuck Date: Wed, 25 Feb 2026 23:17:58 +1100 Subject: [PATCH 1/6] feat: add migration guide --- docs/astro.config.mjs | 1 + .../content/docs/admin/guides/migrating.mdx | 48 +++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 docs/src/content/docs/admin/guides/migrating.mdx diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 45c24dff..8e81ea0f 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -42,6 +42,7 @@ export default defineConfig({ label: "Admin", items: [ { slug: "admin/quickstart" }, + { slug: "admin/guides/migrating" }, { label: "Guides", items: [ diff --git a/docs/src/content/docs/admin/guides/migrating.mdx b/docs/src/content/docs/admin/guides/migrating.mdx new file mode 100644 index 00000000..8481b90b --- /dev/null +++ b/docs/src/content/docs/admin/guides/migrating.mdx @@ -0,0 +1,48 @@ +--- +title: Migrating from v0.3.x +description: A guide on how to migrate to v0.4.0 from v0.3.X +--- + +:::caution +Because of the new manifest format and configuration, all your imported versions will be deleted. +::: + +## Updating the `compose.yaml` + +To get started, simply update the tag in your `compose.yaml` to the tag you're using: + +```diff compose.yaml +services: + postgres: + image: postgres:14-alpine + healthcheck: + test: pg_isready -d drop -U drop + interval: 30s + timeout: 60s + retries: 5 + start_period: 10s + volumes: + - ./db:/var/lib/postgresql/data + environment: + - POSTGRES_PASSWORD=drop + - POSTGRES_USER=drop + - POSTGRES_DB=drop + drop: +- image: ghcr.io/drop-oss/drop:latest ++ image: ghcr.io/drop-oss/drop:v0.4.0-rc-1 + depends_on: + postgres: + condition: service_healthy + ports: + - 3000:3000 + volumes: + - ./library:/library + - ./data:/data + environment: + - DATABASE_URL=postgres://drop:drop@postgres:5432/drop + - EXTERNAL_URL=http://localhost:3000 # default, customise if accessing from another computer or behind a reverse proxy +``` + +## Re-importing all your versions + +Head to the admin library and re-import your versions one at a time. Optionally, you can use the new "Mass Import Tool", but keep in mind you can't configure many of the fancy new features with it. From f467493ffe699f5f169ec8046f6e1c4156206a64 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Wed, 25 Feb 2026 23:57:07 +1100 Subject: [PATCH 2/6] feat: emulators guide --- docs/astro.config.mjs | 5 +- .../docs/admin/going-further/emulators.mdx | 51 +++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 docs/src/content/docs/admin/going-further/emulators.mdx diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 8e81ea0f..13b5054f 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -54,7 +54,10 @@ export default defineConfig({ }, { label: "Going further", - items: [{ slug: "admin/going-further/importing-update" }], + items: [ + { slug: "admin/going-further/importing-update" }, + { slug: "admin/going-further/emulators" }, + ], }, { label: "Metadata", diff --git a/docs/src/content/docs/admin/going-further/emulators.mdx b/docs/src/content/docs/admin/going-further/emulators.mdx new file mode 100644 index 00000000..753cd24d --- /dev/null +++ b/docs/src/content/docs/admin/going-further/emulators.mdx @@ -0,0 +1,51 @@ +--- +title: Emulators +--- + +import { Steps } from "@astrojs/starlight/components"; + +Emulation, broadly speaking, is launching one game with another executable, instead of directly as a native game. For Drop, we have to import at minimum, two versions: + +- Our emulator (referred to as MyEmulator) +- Our game (referred to as MyGame) + +For convenience's sake, we can also specify file extensions for Drop's auto-detect features. For this guide, we'll use `.rom` + + +1. ## Import the emulator + + When importing a game, you can now select it as an "emulator". This enables other configuration options for emulators later down the line, and **hides it from the store.** + + Your metadata providers are unlikely to be able to find it. You might have to use the manual import option. + +2. ## Import the emulator version + + Once you've imported your emulator, open the version importer for your game. + + :::caution + The client currently will panic with a `todo!()` marker if you set the setup executable. + ::: + + Add a launch executable for every platform you want to support. The options are fairly self-explanatory, but make sure to use the `{rom}` placeholder, and optionally add the file extensions. + + Read the [Command Parsing](/reference/command-parsing/) article to understand how it's parsed and substituted. + +3. ## Import your game + + Import your emulated game as usual. + +4. ## Import your version (auto-suggest) + + If you set your file extension above, simply select the ROM from the dropdown in one of your launch executables. It'll auto-fill the configuration needed. + +5. ## Import your version (manually) + + If you didn't set your file extension, enter the name of your ROM in the launch executable field. Then, click "Select new emulator", and search for your emulator game, select the version, and launch command. + + It'll automatically pre-fill the platform field with the platform of your emulator. + + + +:::note +Setup executables cannot be configured to be executed through the emulator. +::: From d4ae9ab62d62563ef0614cb80d761b2b136e8ff7 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Wed, 25 Feb 2026 23:58:27 +1100 Subject: [PATCH 3/6] fix: update quickstart tag --- docs/src/content/docs/admin/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/admin/quickstart.md b/docs/src/content/docs/admin/quickstart.md index 606f4e6c..38cee03b 100644 --- a/docs/src/content/docs/admin/quickstart.md +++ b/docs/src/content/docs/admin/quickstart.md @@ -24,7 +24,7 @@ services: - POSTGRES_USER=drop - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:latest + image: ghcr.io/drop-oss/drop:v0.4.0-rc-1 depends_on: postgres: condition: service_healthy From 3e45f0e3b8a2a27cdb1f0b08178d82a99d4645d7 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Thu, 26 Feb 2026 01:56:37 +1100 Subject: [PATCH 4/6] fix: image tags --- docs/src/content/docs/admin/guides/migrating.mdx | 2 +- docs/src/content/docs/admin/quickstart.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/admin/guides/migrating.mdx b/docs/src/content/docs/admin/guides/migrating.mdx index 8481b90b..2dbbe7b8 100644 --- a/docs/src/content/docs/admin/guides/migrating.mdx +++ b/docs/src/content/docs/admin/guides/migrating.mdx @@ -29,7 +29,7 @@ services: - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:latest -+ image: ghcr.io/drop-oss/drop:v0.4.0-rc-1 ++ image: ghcr.io/drop-oss/drop:0.4.0-rc-1 depends_on: postgres: condition: service_healthy diff --git a/docs/src/content/docs/admin/quickstart.md b/docs/src/content/docs/admin/quickstart.md index 38cee03b..c5018b8f 100644 --- a/docs/src/content/docs/admin/quickstart.md +++ b/docs/src/content/docs/admin/quickstart.md @@ -24,7 +24,7 @@ services: - POSTGRES_USER=drop - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:v0.4.0-rc-1 + image: ghcr.io/drop-oss/drop:0.4.0-rc-1 depends_on: postgres: condition: service_healthy From 0a7da8b2f5bd5e5fa5c8c16b6b9ee6beead7ebef Mon Sep 17 00:00:00 2001 From: DecDuck Date: Fri, 27 Feb 2026 09:16:53 +1100 Subject: [PATCH 5/6] feat: update rc tag --- docs/src/content/docs/admin/guides/migrating.mdx | 2 +- docs/src/content/docs/admin/quickstart.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/admin/guides/migrating.mdx b/docs/src/content/docs/admin/guides/migrating.mdx index 2dbbe7b8..54a32214 100644 --- a/docs/src/content/docs/admin/guides/migrating.mdx +++ b/docs/src/content/docs/admin/guides/migrating.mdx @@ -29,7 +29,7 @@ services: - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:latest -+ image: ghcr.io/drop-oss/drop:0.4.0-rc-1 ++ image: ghcr.io/drop-oss/drop:0.4.0-rc-2 depends_on: postgres: condition: service_healthy diff --git a/docs/src/content/docs/admin/quickstart.md b/docs/src/content/docs/admin/quickstart.md index c5018b8f..f6790ff4 100644 --- a/docs/src/content/docs/admin/quickstart.md +++ b/docs/src/content/docs/admin/quickstart.md @@ -24,7 +24,7 @@ services: - POSTGRES_USER=drop - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:0.4.0-rc-1 + image: ghcr.io/drop-oss/drop:0.4.0-rc-2 depends_on: postgres: condition: service_healthy From 9ce1a8f8d9aee8c9c89e4496dced70ff38dad021 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Fri, 27 Feb 2026 15:16:54 +1100 Subject: [PATCH 6/6] feat: update rc number --- docs/src/content/docs/admin/guides/migrating.mdx | 2 +- docs/src/content/docs/admin/quickstart.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/admin/guides/migrating.mdx b/docs/src/content/docs/admin/guides/migrating.mdx index 54a32214..0991a5f1 100644 --- a/docs/src/content/docs/admin/guides/migrating.mdx +++ b/docs/src/content/docs/admin/guides/migrating.mdx @@ -29,7 +29,7 @@ services: - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:latest -+ image: ghcr.io/drop-oss/drop:0.4.0-rc-2 ++ image: ghcr.io/drop-oss/drop:0.4.0-rc-3 depends_on: postgres: condition: service_healthy diff --git a/docs/src/content/docs/admin/quickstart.md b/docs/src/content/docs/admin/quickstart.md index f6790ff4..e75816d7 100644 --- a/docs/src/content/docs/admin/quickstart.md +++ b/docs/src/content/docs/admin/quickstart.md @@ -24,7 +24,7 @@ services: - POSTGRES_USER=drop - POSTGRES_DB=drop drop: - image: ghcr.io/drop-oss/drop:0.4.0-rc-2 + image: ghcr.io/drop-oss/drop:0.4.0-rc-3 depends_on: postgres: condition: service_healthy