Skip to content

Home

Jump to bottom
Peter J. Mello edited this page Oct 6, 2021 · 2 revisions

AddonSync Wiki - Home

AddonSync Logo

Introduction

You can install this addon from the following zip file: service.addonsync-main.zip

The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all the other installations (referred to as "Slaves") synchronize their addons to the settings used by the Master install. Behind the scenes, the master installation uploads a copy of the configuration files for all of its addons to a network share each time it launches or only when you open its settings and click the Manual Sync option.

The slave installations do the same but in reverse, checking the network share for new changes on the Master each time they're launched or when you click their Manual Sync option, at which point they quietly download and apply any settings you changed on the Master since the last time they ran.

Setup

As described above, AddonSync uses a Master/Slave model. There can be only a single Master installation for each network share, but an unlimited number of slave installations.

First determine which of your Kodi installations will be the Master, once it's configured and has completed the initial upload of its addons' settings to the network share, we can begin to setup the slaves that will mirror from it.

Exclusions

There are some addons that the typical Kodi user will not want to be sync'd between installations, usually because they're sensitive to the particular device you're using to run Kodi, like its display resolution or the graphics chipset it uses. Common addons like this include:

  • Skin settings
  • Metadata addons
  • Built-in screensavers
  • Addons whose latest versions are different across different architectures

Settings

AddonSync

  • Installation Type

    • Declares this Kodi installation to work as either a Master or Slave

  • Central Store Location

    • The location where AddonSync will store/retrieve the configuration data from

  • Run On Startup

    • If AddonSync should backup/restore each time Kodi starts

  • Update Interval (in minutes)

    • How often AddonSync should check to see if any settings have changed

  • Restart Updated Service Addons

    • If a Slave installation finds and retrieves changes to a Service addon, restart it to apply the changes without the need for you to close and re-open Kodi itself

Debugging

  • Enable debug logging
    • Enables AddonSync debug logging (Required if reporting an issue here) - for this to work, logging must also be enabled in the overall Kodi settings as well

Operations

  • Run Synchronisation Now
    • Manually trigger the synchronize operation

Filter

  • Only Synchronise If Addon Version Matches
    • Controls whether addons that have different versions on different systems will be synchronised - some addons tolerate this and others don't
  • Addon Synchronise Selection
    • Determines whether all addons will be synchronized, or whether you're going to manually select to include/exclude some of them
  • Select Addons
    • If you elected not to sync all addons in the previous option, this shows the list of installed addons and only the ones selected here are included

Debugging

If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:

  • Logging in the Kodi system settings menu
  • Debug logging in the AddonSync settings menu

Please do not paste the log into the issue, copy it to a Gist here on GitHub and simply provide the link to the Gist in the issue.

Clone this wiki locally