Kodi

In order for multi-scrobbler to communicate with Kodi you must have the Web Interface enabled. This can be done in the Kodi GUI:

• Settings -> Services -> Control
  • Check Allow remote control via HTTP
  • Ensure you have a Username and Password set, you will need to provide them in the ENV/File configuration below.

URL

The URL used to connect to Kodi, set in your file config as url. The URL used to connect ultimately must be formed like this:

Syntax  => [protocol]://[hostname]:[port]/[path]
Default =>       http://localhost:8080/jsonrpc

If any part of this URL is missing multi-scrobbler will use a default value. This also means that if any part of your URL is not standard you must explicitly define it.

Kodi Settings

• Make sure the port number matches what is found in Port in the Control section mentioned above.
• If your installation is on the same machine but you cannot connect using localhost try 0.0.0.0 instead.

URL Transform Examples

Examples of a given url in your file config and the final URL multi-scrobbler will use to connect to Kodi:

url	Transformed URL
(none set)	http://localhost:8080/jsonrpc
kodi.mydomain.com	http://kodi.mydomain.com:8080/jsonrpc
192.168.0.101:3456	http://192.168.0.101:3456/jsonprc
mydomain.com:80/kodiReverse/jsonrpc	http://mydomain.com:80/kodiReverse/jsonrpc

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
KODI_ID	string		A globally unique ID EX myComponentId
KODI_NAME	string	Value of KODI_ID	A vanity name EX My Cool Component
KODI_ENABLE	boolean	true	Should this component be used?
KODI_URL	string	http://localhost:8080/jsonrpc	URL of the Kodi HTTP server to connect to
KODI_USER	string		The username set for Remote Control via Web Sever
KODI_PASSWORD	string		The password set for Remote Control via Web Sever

Bold/Italic = Required

File

Config Structure

This displays the structure of the File Configuration for a kodi type Source with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Config Example

This displays an example config file of a kodi Source File Configuration that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuration is correct. Any errors show up as squiggly lines.

Important

Only source kodi configs will validate correctly in the editor but both source and client kodi configs are allowed in the real CONFIG/kodi.json

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a kodi Source File Configuration that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/kodi.json

[
  {
    "id": "myKodi",
    "name": "My Kodi Server",
    "data": {
      "url": "http://localhost:8080/jsonrpc",
      "username": "myUser",
      "password": "myPassword"
    },
    "enable": true
  }
]

AIO

Config Structure

This displays the structure of the all-in-one (config.json) configuration with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Select the kodi type from the respective sources node below, then expand it.

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a kodi Source that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuraion is correct. Any errors show up as squiggly lines.

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a all-in-one (config.json) configuration that includes a kodi Source that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/config.json

{
  "sources": [
    {
      "type": "kodi",
      "id": "myKodi",
      "name": "My Kodi Server",
      "data": {
        "url": "http://localhost:8080/jsonrpc",
        "username": "myUser",
        "password": "myPassword"
      },
      "enable": true
    }
  ]
}