From da29ea46d9078df2ca41b5be33ed44a8adc3014a Mon Sep 17 00:00:00 2001 From: Nadia Liliana Kulczycka Date: Thu, 23 Jul 2026 22:50:33 +0200 Subject: [PATCH] Add guide for getting Sable from Obtainium. --- .vscode/settings.json | 2 +- README.md | 31 +++++++++++++++++++++++++++++++ obtainium-source-nightly.json | 11 +++++++++++ obtainium-source-stable.json | 11 +++++++++++ 4 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 obtainium-source-nightly.json create mode 100644 obtainium-source-stable.json diff --git a/.vscode/settings.json b/.vscode/settings.json index 78a3d23b9..6c391fa53 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -11,7 +11,7 @@ "editor.defaultFormatter": "oxc.oxc-vscode" }, "[json]": { - "editor.defaultFormatter": "oxc.oxc-vscode" + "editor.defaultFormatter": "vscode.json-language-features" }, "[rust]": { "editor.defaultFormatter": "rust-lang.rust-analyzer" diff --git a/README.md b/README.md index bc361d5b6..e715a2501 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,37 @@ Sable iOS builds are distributed as unsigned IPAs through [AltStore](https://alt iOS builds are produced by the `ios` job in [`tauri-build.yml`](.github/workflows/tauri-build.yml) and track the same `dev`/`v*` triggers as desktop builds. +## Android (Obtainium) + +### Nightly Source + +Add to Obtainium +  + +### Stable Source + +Add to Obtainium +  + +### Setup and install + +1. Set up [Obtainium](https://wiki.obtainium.imranr.dev/) on your device. +2. Add the Sable source by either: + - Tapping one of the buttons above. + - Importing one of the JSON files: + - [Nightly](https://raw.githubusercontent.com/SableClient/Sable/refs/heads/dev/obtainium-source-nightly.json) + - [Stable](https://raw.githubusercontent.com/SableClient/Sable/refs/heads/dev/obtainium-source-stable.json) + - Adding it manually - use as the GitHub link and follow the section below with regards to setting app variables +3. Install Sable from the source. + +### Relevant variables and switching between Nightly and Stable + +Relevant variable differences between Nightly and Stable: +- *Include prereleases* - `true` for Nightly, `false` for Stable +- *Fallback to older releases* - `false` for Nightly, `true` for Stable +- *Use latest asset upload as release date* - `true` for Nightly, `false` for Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones) +- *Use release date as version string (pseudo-version)* - `true` for Nightly, `false` for Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones) + ## Self-hosting You have a few options for self hosting, you can: 1. Run the prebuilt docker container. diff --git a/obtainium-source-nightly.json b/obtainium-source-nightly.json new file mode 100644 index 000000000..9d4e3bdd0 --- /dev/null +++ b/obtainium-source-nightly.json @@ -0,0 +1,11 @@ +{ + "apps": [ + { + "id": "moe.sable.client", + "url": "https://github.com/SableClient/Sable", + "author": "SableClient", + "name": "Sable", + "additionalSettings": "{\"includePrereleases\":true,\"fallbackToOlderReleases\":false,\"filterReleaseTitlesByRegEx\":\"\",\"filterReleaseNotesByRegEx\":\"\",\"verifyLatestTag\":false,\"dontSortReleasesList\":false,\"useLatestAssetDateAsReleaseDate\":true,\"trackOnly\":false,\"versionExtractionRegEx\":\"\",\"matchGroupToUse\":\"\",\"versionDetection\":true,\"releaseDateAsVersion\":true,\"useVersionCodeAsOSVersion\":false,\"apkFilterRegEx\":\"\",\"invertAPKFilter\":false,\"autoApkFilterByArch\":true,\"appName\":\"Sable\",\"shizukuPretendToBeGooglePlay\":false,\"exemptFromBackgroundUpdates\":false,\"skipUpdateNotifications\":false,\"about\":\"An almost stable Matrix client\",\"appAuthor\":\"SableClient\"}" + } + ] +} \ No newline at end of file diff --git a/obtainium-source-stable.json b/obtainium-source-stable.json new file mode 100644 index 000000000..9d4e3bdd0 --- /dev/null +++ b/obtainium-source-stable.json @@ -0,0 +1,11 @@ +{ + "apps": [ + { + "id": "moe.sable.client", + "url": "https://github.com/SableClient/Sable", + "author": "SableClient", + "name": "Sable", + "additionalSettings": "{\"includePrereleases\":true,\"fallbackToOlderReleases\":false,\"filterReleaseTitlesByRegEx\":\"\",\"filterReleaseNotesByRegEx\":\"\",\"verifyLatestTag\":false,\"dontSortReleasesList\":false,\"useLatestAssetDateAsReleaseDate\":true,\"trackOnly\":false,\"versionExtractionRegEx\":\"\",\"matchGroupToUse\":\"\",\"versionDetection\":true,\"releaseDateAsVersion\":true,\"useVersionCodeAsOSVersion\":false,\"apkFilterRegEx\":\"\",\"invertAPKFilter\":false,\"autoApkFilterByArch\":true,\"appName\":\"Sable\",\"shizukuPretendToBeGooglePlay\":false,\"exemptFromBackgroundUpdates\":false,\"skipUpdateNotifications\":false,\"about\":\"An almost stable Matrix client\",\"appAuthor\":\"SableClient\"}" + } + ] +} \ No newline at end of file