Documentation
Install on Velocity

Installation on Velocity

Before installing, we recommend you to read the main installation page.

Basic Installation

In this section, you can read how to set up SkinsRestorer on your Velocity proxy.

ℹ️

Heads up! SkinsRestorer works best when you also install it on your backend servers. This is not required, but you will miss out on some features. Read more below.

ℹ️

Paper (or a fork of Paper) is suggested for Velocity

Download the plugin

Download the latest version from SpigotMC (opens in a new tab)

Put it in the Velocity folder

Place the SkinsRestorer.jar in the plugins folder of the Velocity proxy.

Put it into every Spigot folder

Place the SkinsRestorer.jar in the plugins folders of every Spigot server.

Setup player information forwarding

You need to setup player information forwarding in order for SkinsRestorer to communicate with your backend servers. For that, follow the Velocity forwarding guide (opens in a new tab). This step is required for the plugin to work correctly on your network. If this step is not done correctly, the plugin will not work correctly.

Restart your servers

Restart (/restart, /stop or /end) all Spigot servers and the Velocity proxy.

Ensure the plugin is in Proxy Mode on the servers

In every Spigot server, check the server logs for the messages like these:

[SkinsRestorer] ----------------------------------------------
[SkinsRestorer]     +==================+
[SkinsRestorer]     |   SkinsRestorer  |
[SkinsRestorer]     |------------------|
[SkinsRestorer]     |    Proxy Mode    |
[SkinsRestorer]     +==================+
[SkinsRestorer] ----------------------------------------------

The plugin has to say that it is using "Proxy Mode". If you see this message, you're good to go!

If you don't see this message, make sure you you set up player information forwarding correctly. SkinsRestorer will not work correctly if you don't see this message.

Configure the plugin

You may now configure SkinsRestorer on the Velocity proxy.

Sync configs

Make sure you have the same plugins/SkinsRestorer/config.yml file on all servers and the Velocity proxy. This file contains important settings that are required for the plugin to work the same on all servers. If you don't have the same config.yml file on all servers, you may experience issues.

Restart your servers

Restart (/restart, /stop or /end) all Spigot servers and the Velocity proxy.

Check console for errors

Check the console logs of Velocity and all servers for errors If you see any errors, report them to us on Discord.

That's it!

Our plugin should now work on your network!