How to Install PerPlayerKit on Your Minecraft Server

Installing PerPlayerKit takes only a few minutes. The plugin has a minimal required configuration — all you must decide upfront is which storage backend to use. Follow the steps below to go from a fresh download to a fully running plugin.

PerPlayerKit requires Paper or Spigot 1.19 or newer and Java 17 or newer. Starting the plugin on an older server version or an older JDK will cause it to fail to load. Verify both before proceeding.

Installation Steps

Download the Plugin

Grab the latest PerPlayerKit-x.x.x.jar from the official releases page. Always use the most recent stable release to get the latest bug fixes and features.

Stop Your Server and Place the JAR

Shut down your server completely before adding any new plugin. Once it has stopped, copy the .jar file into your server’s plugins/ folder.

Start the Server to Generate Config Files

Start the server. PerPlayerKit will initialize and create its configuration files inside plugins/PerPlayerKit/. Watch your console for any startup errors, then let the server finish loading.

Stop the Server Again

Stop the server before editing any configuration files. Editing config files while the server is running will cause your changes to be overwritten on the next save cycle.

Edit config.yml and Set Your Storage Type

Open plugins/PerPlayerKit/config.yml in a text editor. Find the storage block and set type to your chosen backend (sqlite, mysql, or postgresql). If you choose MySQL or PostgreSQL, fill in the corresponding connection details as shown in the Database Configuration section below.

Restart the Server

Start the server one final time. PerPlayerKit will connect to your chosen database and complete its initialization. The plugin is now ready to use.

Database Configuration

Choose the storage backend that fits your server setup. All three options are fully supported; the right choice depends on your infrastructure.

Use SQLite if you run a single server and want zero-configuration storage — no external database required. Choose MySQL or PostgreSQL only if you run a network of servers that need to share kit data, or if you already manage a dedicated database server.

The YAML storage type is included for development and testing purposes only. Do not use it in production — it does not scale and offers no data integrity guarantees.

SQLite (Recommended)
MySQL
PostgreSQL

SQLite stores all kit data in a local file inside the plugins/PerPlayerKit/ directory. No external database software or credentials needed.

storage:
  type: "sqlite"

That is the only change required. Restart the server and the plugin creates the database file automatically.

Use MySQL (or a compatible drop-in like MariaDB) when you need a shared database across multiple server instances.

storage:
  type: "mysql"
mysql:
  host: "localhost"
  port: "3306"
  dbname: "kitdatabase"
  username: "username"
  password: "pa55w0rd"
  useSSL: false
  maximumPoolSize: 10

Create the target database on your MySQL server before starting the plugin. PerPlayerKit creates its own tables automatically on first launch.

PostgreSQL is supported for servers that prefer it over MySQL, or for environments where a PostgreSQL instance is already available.

storage:
  type: "postgresql"
postgresql:
  host: "localhost"
  port: "5432"
  dbname: "kitdatabase"
  username: "username"
  password: "pa55w0rd"
  useSSL: false
  maximumPoolSize: 10

As with MySQL, create the target database before first launch. The plugin handles table creation automatically.

Next Steps

With the plugin installed and storage configured, set up your Virtual Kit Room and assign permissions so players can start building kits.

Follow the Quickstart guide to configure a Kit Room and test the plugin end-to-end.
Browse the Configuration reference for the full list of available settings.

​Installation Steps

​Database Configuration

​Next Steps

Installation Steps

Database Configuration

Next Steps