Skip to content

noodlejetski/apps.obtainium.imranr.dev

 
 

Repository files navigation

Crowdsourced App Configurations website for Obtainium.

The website is accessible at apps.obtainium.imranr.dev

URL Redirection

Obtainium's custom protocol links (obtainium://) may not be easily clickable (for example, neither GitHub's MarkDown renderer nor popular messaging apps like WhatsApp support them). To work around this, you can use the web-based redirect to get a normal http:// link that opens a webpage which redirects to Obtainium (if installed).

For example:

Link Types

As of this writing, there are two types of Obtainium links:

  1. /add: These redirect the user to the "Add App" page with the URL pre-filled in. The user can then modify any app-specific setting before adding it themselves.
  2. /app: These links contain an entire app configuration JSON and opening them in Obtainium results in the app being added directly into the user's list, with the app-specific settings included in the link.

Minimal Example

To add an app config to this repo, your app configuration JSON must contain at least the id, url, author, name, and additionalSettings keys. Note that for any app-specific setting you don't define in additionalSettings, the default value will be used.

For example:

Usage

  • To contribute content, create a pull request with valid changes/additions to the config files in data/.
    • You can auto-generate config files from an Obtainium export by running node generateFromExport.js <path to Obtainium export>
    • Note: Auto-generated entries will not have icon, category, or description data. Adding those manually is not required but would result in a better user experience.
  • To test locally, run: node buildData.js; python -m http.server 8080
  • See ImranR98/Obtainium#1214 for background/context for this repo.

Badge Graphic

You may want to use the following graphic to link users to your App:

Get it on Obtainium

About

Collection of suggested apps for Obtainium.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 52.1%
  • HTML 47.9%