Skip to content

Manual installation of LMS plugins

AF-1 edited this page Nov 17, 2024 · 10 revisions

To manually install an LMS plugin hosted on GitHub:

  • Go to LMS > Settings > Manage Plugins and uninstall the currently installed version of the plugin, if applicable.

  • Download the latest GitHub version of the plugin by clicking on the green Code button and download the zip archive.

  • Now find the correct the Plugins folder for manually installed plugins:

    • Regardless of which operating system your LMS runs on, you will always find a list of the Plugin Folders used by LMS
      at the bottom of LMS > Settings > Information. Their names may be slightly different depending on your OS but some basic naming rules still apply.

    • Usually, you'll find 3 folders there:

      • one whose path contains InstalledPlugins. This one is only for plugins installed via LMS Settings > Manage Plugins, NOT for manual installations.

      • another whose path contains server. This is for pre-installed LMS plugins only. Do NOT move plugins here.

      • and the last and correct one whose path often contains the same path as the Preferences Folder and ends e.g. in Plugins. In this case the Plugins folder for manual installations and the Preferences Folder have the same parent folder.

        💡 Even if the name or path of this folder is (slightly) different on your OS, it should be the one whose path does not contain InstalledPlugins or server. So this is the Plugins folder you need.

      • Examples of LMS plugin folder paths for manual installation of plugins (no guarantees):

        • piCorePlayer: /usr/local/slimserver/Plugins
        • macOS: /Users/yourusername/Library/Application Support/Squeezebox/Plugins
        • Windows: C:\Program Files (x86)\Squeezebox\server\Plugins
  • Extract the downloaded archive and move the folder (named after the plugin) to the correct Plugins folder.

  • Restart LMS.


Manual uninstallation

  • Delete the plugin from the Plugins Folder for manually installed plugins (see installation).
  • Restart LMS.


Manual installation means no automatic updates

If you install a plugin manually, you'll have to update it yourself by manually uninstalling the old version and then installing the new one.
Manually installed plugins are not (automatically) updated by LMS.