Skip to content
Tommy Mikkelsen edited this page Sep 27, 2019 · 30 revisions

Welcome to the UAS2Res wiki!

NOTE

Since plugins are going away for Plex, we no longer accept new additions!!!!!


This git is intended for Plex bundle developers, that wants to add their work to the "Unsupported Application Store".

Note: We do NOT accept pull request, if your work covers one of the following:

  • A Commercial plugin
  • A Political plugin
  • A Plugin covering Child Porn

What is this?

The UnSupported AppStore is a plugin running under the WebTools bundle, allowing the Plex Media Server to ease the process of finding, downloading, installing, updating and (if need be) uninstalling unsupported Plex plugins. Please note that the plugins available here are not supported by the Plex Media Server 'Plex Online' store for a reason (possibly more than one reason). They may be unstable, unfinished, or provide access to content which may be offensive. If you are having trouble with any of the plugins available through this app, please make your best efforts to contact the plugin's author for support. The authors of the UnSupported AppStore addon takes no responsibility for the content/stability/suitability of the contained plugins and any complaints or requests for support in relation to specific plugins will be ignored.

Adding or removing to this repository

If you have authored a plugin and would like for it to appear in the UnSupported AppStore plugin, follow these instructions:

  • Setup a git repository (github.com) for your plugin.
  • Check that your work will install, when doing a manual install from within WebTools/UAS
  • Fork the repository for the UAS2Res.
  • Edit the plugin_details.json file in /Contents/Resources/ to add the necessary info about your plugin.
  • Add a copy of the icon for your plugin to the /Contents/Resources/ folder. Make sure it has a unique name, i.e. not the standard icon-default.png.
  • Commit your changes with an appropriate description.
  • Send a Pull Request for your changes to be merged into the master-branch.

Note: Currently active categories/types for bundles are:

  • Adult
  • Agent
  • Application
  • Metadata Agent
  • Music
  • Pictures
  • Social
  • Subtitles
  • Video

Even though the UAS will dynamically read the categories, we urge you if possible to stay with above categories

Once the changes have been reviewed, they will be merged and your plugin will appear in the UnSupported AppStore. Please keep in mind for future development that, since the AppStore pulls updates directly from your plugins git repository that until any code changes are tested, it is best to work in a branch other than 'master'. As a general rule, we suggest that channels be designated to work on all Plex clients unless there are known issues with a particular client-type. This will decrease users' reliance on the "Disable Capability Checking" option which otherwise opens the door for them to have more troubles with other channels (both official and unofficial). To make sure all clients are supported, just set the string value for the "PlexClientPlatforms" key to "*" in your plugin's Info.plist.

Details about the values in plugin_details.json

  • "title" : The title of your channel
  • "bundle" : The name of the bundle directory
  • "type" : The type of the Channel. as a comma separated array, like: ["Metadata Agent", "Subtitles"]
  • "description" : A description of your channel, like: "Metadata agent for anime movies and tv-shows"
  • "repo" : URL to your Git
  • "branch" : Future...For now, set to "master"
  • "release" : If this key is present, then branch and branches will be ignored, and instead the latest release will be downloaded. The value of this key MUST be the name of the zip-file to download, and the contents of the zip-file must match a regular branch, regarding depth of directories etc. To see an example,checkout ExportTools And note that WT V2.3 or above is needed for this
  • "branches" : This will allow user to select which branch to download. If missing, we fallback to branch setting. Value like this, and first one will be the default: [{"name": "master", "label": "Stable"},{"name": "beta", "label": "Beta"}]
  • "DeleteCacheDir" : Can be either true or false. If true, then the "Plug-in Support/Cache/" directory will be deleted during an upgrade
  • "DeleteDataDir" : Can be either true or false. If true, then the "Plug-in Support/Data/" directory will be deleted during an upgrade
  • "identifier" : Identifier of the Channel, from your Info.plist file
  • "icon" : Name of your icon
  • "supporturl" : The url to your support thread on Plex forums
  • "popupmsg" : This msg. will be shown after a successful install. (See ExportTools for an example)
  • "manual" : If present, then link to a manual page, if you have one, like a Git Wiki. (See ExportTools for an example)

Note In order to accept a PR, you have to fill out the support url link with a valid link, that points towards a thread with a name of: "[REL] your channel title". This thread has to be located in the Plex Channels Forum

Reason for doing this, is to avoid our support thread for getting flooded with support questions about your channel

Also note, that when submitting a PR here, you also automatically accept, that your support thread will be added to this thread: Find my Plug-In here for support

Opening [REL] Support forum thread

After your work has been accepted by UAS2, you should alter/edit your opening post to let your users know, that they can install via UAS2

Credits

Without any doubt, all credits for this goes to mikedm139, since he wrote the original UAS

Happy Plexing