From 6af6ba41351a6f2937d5fc05b16c4ed2f1ef1866 Mon Sep 17 00:00:00 2001 From: Richard Macias Date: Fri, 30 May 2025 14:51:25 -0500 Subject: [PATCH] fix: add missing categories keys to table links --- .gitignore | 1 + README.md | 102 ++++++++++++++++---------------------- pages/table.md | 56 ++++++++++----------- scripts/generate-table.py | 1 + 4 files changed, 73 insertions(+), 87 deletions(-) diff --git a/.gitignore b/.gitignore index 5768f5c..61fe161 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ +.DS_Store .notes/ diff --git a/README.md b/README.md index 691c7f7..d49bea6 100644 --- a/README.md +++ b/README.md @@ -31,57 +31,71 @@ The maintainer of Obtainium also hosts a collection of Crowdsourced app configur | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| +AzaharPlus+ | Add to Obtainium! | ❌ | -| Azahar | Add to Obtainium! | ✅ | -| Cemu | Add to Obtainium! | ✅ | -| Citron | Add to Obtainium! | ✅ | -| Dolphin Emulator | Add to Obtainium! | ✅ | -| Dolphin Emulator (Dev build) | Add to Obtainium! | ❌ | -| DuckStation (Beta) | Add to Obtainium! | ✅ | -| Eden | Add to Obtainium! | ✅ | -| NetherSX2 Classic | Add to Obtainium! | ✅ | -| NetherSX2 Classic (Pre-Release) | Add to Obtainium! | ❌ | -| PPSSPP | Add to Obtainium! | ✅ | -| RPCSX | Add to Obtainium! | ✅ | -| RetroArch AArch64 (Nightly) | Add to Obtainium! | ❌ | -| RetroArch AArch64 (Stable) | Add to Obtainium! | ✅ | -| ScummVM | Add to Obtainium! | ✅ | -| Vita3K | Add to Obtainium! | ✅ | -| Vita3K ZX | Add to Obtainium! | ✅ | -| Winlator | Add to Obtainium! | ✅ | -| melonDS | Add to Obtainium! | ✅ | -| melonDS Nightly | Add to Obtainium! | ❌ | +| +AzaharPlus+ | Add to Obtainium! | ❌ | +| Azahar | Add to Obtainium! | ✅ | +| Cemu | Add to Obtainium! | ✅ | +| Citron | Add to Obtainium! | ✅ | +| Dolphin Emulator | Add to Obtainium! | ✅ | +| Dolphin Emulator (Dev build) | Add to Obtainium! | ❌ | +| DuckStation (Beta) | Add to Obtainium! | ✅ | +| Eden | Add to Obtainium! | ✅ | +| NetherSX2 Classic | Add to Obtainium! | ✅ | +| NetherSX2 Classic (Pre-Release) | Add to Obtainium! | ❌ | +| PPSSPP | Add to Obtainium! | ✅ | +| RPCSX | Add to Obtainium! | ✅ | +| RetroArch AArch64 (Nightly) | Add to Obtainium! | ❌ | +| RetroArch AArch64 (Stable) | Add to Obtainium! | ✅ | +| ScummVM | Add to Obtainium! | ✅ | +| Vita3K | Add to Obtainium! | ✅ | +| Vita3K ZX | Add to Obtainium! | ✅ | +| Winlator | Add to Obtainium! | ✅ | +| melonDS | Add to Obtainium! | ✅ | +| melonDS Nightly | Add to Obtainium! | ❌ | ### Frontend | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| Daijishō | Add to Obtainium! | ✅ | -| Pegasus | Add to Obtainium! | ✅ | +| Daijishō | Add to Obtainium! | ✅ | +| Pegasus | Add to Obtainium! | ✅ | ### Streaming | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| Artemis | Add to Obtainium! | ✅ | -| Moonlight | Add to Obtainium! | ✅ | +| Artemis | Add to Obtainium! | ✅ | +| Moonlight | Add to Obtainium! | ✅ | ### Track Only | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| AdrenoToolsDrivers | Add to Obtainium! | ✅ | -| Obtainium Emulation Pack | Add to Obtainium! | ✅ | +| AdrenoToolsDrivers | Add to Obtainium! | ✅ | +| Obtainium Emulation Pack | Add to Obtainium! | ✅ | ### Utilities | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| ES-DE Android Apps | Add to Obtainium! | ✅ | -| Syncthing-Fork | Add to Obtainium! | ✅ | +| ES-DE Android Apps | Add to Obtainium! | ✅ | +| Syncthing-Fork | Add to Obtainium! | ✅ | ## FAQ +### A note about stable, beta, nightly and canary versions of the same app + +You cannot install more than one version of the same app. For example: You must choose between RetroArch (stable) or RetroArch (nightly). You cannot have both. + +To make things easier for beginners, I've omitted nightly, beta and canary versions where a stable +one exists. + +You can manually add beta/nightly applications by using the links in the README + +### How do I updated Obtainium Emulation Pack? + +Same as install method. It'll update existing resources. +It will not remove any other resources you've added. + ### Why do some applications say TRACK ONLY? As the name implies, these application versions are only tracked, not pulled. @@ -98,40 +112,10 @@ When you get notified of an update to your track only resource: - download it manually - in obtainium > click resource > click "Mark Updated" -### How do I updated Obtainium Emulation Pack? - -Same as install method. It'll update existing resources. -It will not remove any other resources you've added. - -### A new switch emulator has released! Can you add it? - -> [!NOTE] -> For context, I have a full time job and a family. I do this for fun. With that in mind... - -I want to be very selective about which switch emulators I add to this pack. The switch emulation space can be very volatile, and I don't want to be in a position where I have to chase a moving target and update the pack every day. - -The switch emulators I've added have proven to be somewhat stable in where they are and how they're -tracked. - -### A note about stable, beta, nightly and canary versions of the same app - -You cannot install more than one version of the same app. For example: You must choose between RetroArch (stable) or RetroArch (nightly). You cannot have both. - -To make things easier for beginners, I've omitted nightly, beta and canary versions where a stable -one exists. - -You can manually add beta/nightly applications by using the links in the README - -### How does this work? - -Obtainium allows you to filter for links on a page using regular expression (regex) -It also allows you to follow multiple links using regex. -see for a basic example of how this works. - ### Can this break? Yes. Absolutely it can. -Any of the scrapers that use regex can break if the maintainer changes their page. +Any of the scrapers that use regex can break if the application maintainers break convention. The applications pulling from GitHub are more stable and less likely to break. ## Development & Contribution diff --git a/pages/table.md b/pages/table.md index 67a5553..045bcdc 100644 --- a/pages/table.md +++ b/pages/table.md @@ -4,51 +4,51 @@ | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| +AzaharPlus+ | Add to Obtainium! | ❌ | -| Azahar | Add to Obtainium! | ✅ | -| Cemu | Add to Obtainium! | ✅ | -| Citron | Add to Obtainium! | ✅ | -| Dolphin Emulator | Add to Obtainium! | ✅ | -| Dolphin Emulator (Dev build) | Add to Obtainium! | ❌ | -| DuckStation (Beta) | Add to Obtainium! | ✅ | -| Eden | Add to Obtainium! | ✅ | -| NetherSX2 Classic | Add to Obtainium! | ✅ | -| NetherSX2 Classic (Pre-Release) | Add to Obtainium! | ❌ | -| PPSSPP | Add to Obtainium! | ✅ | -| RPCSX | Add to Obtainium! | ✅ | -| RetroArch AArch64 (Nightly) | Add to Obtainium! | ❌ | -| RetroArch AArch64 (Stable) | Add to Obtainium! | ✅ | -| ScummVM | Add to Obtainium! | ✅ | -| Vita3K | Add to Obtainium! | ✅ | -| Vita3K ZX | Add to Obtainium! | ✅ | -| Winlator | Add to Obtainium! | ✅ | -| melonDS | Add to Obtainium! | ✅ | -| melonDS Nightly | Add to Obtainium! | ❌ | +| +AzaharPlus+ | Add to Obtainium! | ❌ | +| Azahar | Add to Obtainium! | ✅ | +| Cemu | Add to Obtainium! | ✅ | +| Citron | Add to Obtainium! | ✅ | +| Dolphin Emulator | Add to Obtainium! | ✅ | +| Dolphin Emulator (Dev build) | Add to Obtainium! | ❌ | +| DuckStation (Beta) | Add to Obtainium! | ✅ | +| Eden | Add to Obtainium! | ✅ | +| NetherSX2 Classic | Add to Obtainium! | ✅ | +| NetherSX2 Classic (Pre-Release) | Add to Obtainium! | ❌ | +| PPSSPP | Add to Obtainium! | ✅ | +| RPCSX | Add to Obtainium! | ✅ | +| RetroArch AArch64 (Nightly) | Add to Obtainium! | ❌ | +| RetroArch AArch64 (Stable) | Add to Obtainium! | ✅ | +| ScummVM | Add to Obtainium! | ✅ | +| Vita3K | Add to Obtainium! | ✅ | +| Vita3K ZX | Add to Obtainium! | ✅ | +| Winlator | Add to Obtainium! | ✅ | +| melonDS | Add to Obtainium! | ✅ | +| melonDS Nightly | Add to Obtainium! | ❌ | ### Frontend | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| Daijishō | Add to Obtainium! | ✅ | -| Pegasus | Add to Obtainium! | ✅ | +| Daijishō | Add to Obtainium! | ✅ | +| Pegasus | Add to Obtainium! | ✅ | ### Streaming | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| Artemis | Add to Obtainium! | ✅ | -| Moonlight | Add to Obtainium! | ✅ | +| Artemis | Add to Obtainium! | ✅ | +| Moonlight | Add to Obtainium! | ✅ | ### Track Only | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| AdrenoToolsDrivers | Add to Obtainium! | ✅ | -| Obtainium Emulation Pack | Add to Obtainium! | ✅ | +| AdrenoToolsDrivers | Add to Obtainium! | ✅ | +| Obtainium Emulation Pack | Add to Obtainium! | ✅ | ### Utilities | Application Name | Add to Obtainium | Included in export json? | |------------------|------------------|---------------------------| -| ES-DE Android Apps | Add to Obtainium! | ✅ | -| Syncthing-Fork | Add to Obtainium! | ✅ | +| ES-DE Android Apps | Add to Obtainium! | ✅ | +| Syncthing-Fork | Add to Obtainium! | ✅ | diff --git a/scripts/generate-table.py b/scripts/generate-table.py index 9acca01..5afd85e 100644 --- a/scripts/generate-table.py +++ b/scripts/generate-table.py @@ -10,6 +10,7 @@ def make_obtainium_link(app): "url": app["url"], "author": app["author"], "name": app["name"], + "categories": app["categories"], "preferredApkIndex": app.get("preferredApkIndex", 0), "additionalSettings": app.get("additionalSettings", ""), }