Installation and Updating - Shopkeepers/Shopkeepers-Wiki GitHub Wiki

Installation

  1. Make sure that you are running the latest version of a supported Bukkit / Spigot server. You can find more information on server setup here: https://www.spigotmc.org/wiki/spigot/
    Note that this plugin is created to work with CraftBukkit (or alternatively Spigot). Bukkit does not have an API for some of the things necessary to make this plugin work. This means that other server software (Tekkit, Forge, etc.) will not work with this plugin.
    Other CraftBukkit or Spigot derivatives/forks might work, but are not officially supported. So if you run into issues while using those, try to reproduce your issue on a fresh and up-to-date Spigot server first.

  2. Download the latest release version of Shopkeepers here: https://dev.bukkit.org/projects/shopkeepers/files
    Each release should mention the Bukkit / Minecraft versions it supports.

  3. Stop your server. Drop the downloaded Shopkeepers.jar into your server's plugins folder. Restart your server.

  4. Check your server log for issues, and verify that everything works.

After successful installation you might have to perform some additional setup:

  • Optional: Shopkeepers will create a config.yml file inside the Shopkeepers folder. There are several configuration options you can customize. See the Configuration Page for more information.
  • Optional: If you are using a permissions plugin, you might want to assign your players and admins the permission nodes they need. See the Permissions Page for more information.
  • Once everything is setup you can start creating shops!
  • In case you run into issues (or have further questions), check out the FAQ.

Directory structure

Shopkeepers will create its base directory inside the server's plugins folder at: <serverDirectory>/plugins/Shopkeepers/

The whole directory structure looks like this:

../plugins/ # The server's plugins folder
    +--Shopkeepers/ # Base directory for the plugin
        |-- config.yml # Configuration
        +-- data/
            |-- save.yml # Saved shopkeeper data (shops, trade offers, ..)
            |-- save.yml.tmp # Temporary file, only exists briefly while saving the shopkeeper data
        +-- lang/
            |-- language-en-default.yml # Default language file, cannot be modified, acts as template for custom language files
            |-- # Additional language files (optional)
        +-- trade-logs/
            |-- # CSV trade log files (if trade logging is enabled in the config)

Updating

Most updates to newer versions of Shopkeepers can be done by simply stopping the server, replacing the Shopkeepers.jar, and starting the server again.
However, to prevent issues you should always follow these steps nevertheless:

  1. Read the changelogs for all updates since your currently installed version. Sometimes those contain notes about potential issues and migration instructions. If you are updating from a very old version, you might even have to first update to a version in-between in case the latest version does no longer support migration from your currently installed version.

  2. Backup the shopkeeper plugin folder prior to updating to prevent data loss.

  3. Sometimes the default config settings get changed, new settings get added or previous settings get removed. Check the changelogs for any config migrations you might have to manually perform. If you run into issues it might make sense to remove your config file, let the plugin regenerate the default one on the next start, and then reapply your changes to the default config.