Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 2.72 KB

README.md

File metadata and controls

36 lines (27 loc) · 2.72 KB

Kodi GitHub virtual repository

Build Status Codacy Badge

This add-on creates a virtual repository for Kodi. This way, one does not need to use a GitHub repository for storing add-ons zips when all that information is already accessible from each add-on repository.

It works by setting a HTTP server which has the following endpoints:

Endpoint Description
http://127.0.0.1:{port}/addons.xml Main xml file containing all add-ons information
http://127.0.0.1:{port}/addons.xml.md5 Checksum of the main xml file
http://127.0.0.1:{port}/{addon_id}/{asset_path} Endpoint for serving add-ons assets/zips
http://127.0.0.1:{port}/update Endpoint for updating repository entries and clearing caches

Installation

Get the latest release from github. Then, install from zip within Kodi.

Add-on entries

In order to know which repositories to proxy, the virtual repository needs to be provided with a list of add-on entries. An example can be found here. Each entry must follow the following schema (also available as json schema):

Property Required Description
id true Add-on id.
username true GitHub repository username.
branch false GitHub repository branch. If not defined, it will be the commit of the latest release or, in case there are no releases, master branch.
assets false Dictionary containing string/string key-value pairs, where the key corresponds to the relative asset location and the value corresponds to the real asset location. One can also set "zip" asset, which is a special case for the add-on zip. If an asset is not defined, its location will be automatically evaluated.
Note: assets are treated as "new style" format strings with the following keywords - id, username, repository, branch, system and arch.
asset_prefix false Prefix to use on the real asset location when it is automatically evaluated.
repository false GitHub repository name. If not set, it is assumed to be the same as the add-on id.
platforms false Platforms where the add-on is supported. If not set, it is assumed all platforms are supported.