Quick Start Guide

Single Server Setup

For standalone Bukkit/Spigot/Paper servers without a proxy.

Steps:

1. Download SkinsRestorer from Modrinth
2. Place SkinsRestorer.jar in your plugins folder
3. Restart your server
4. Done! The default config works out of the box

Recommended config tweaks:

# Optional: Set default skins for players without Mojang accounts
storage:
  defaultSkins:
    enabled: true
    list:
      - "<random>"

# Optional: Reduce cooldown for smaller servers
commands:
  skinChangeCooldown: 15

Test it:

/skin Notch

Small Network Setup

For BungeeCord/Velocity networks with 2-5 backend servers.

Steps:

1. Download SkinsRestorer
2. Place SkinsRestorer.jar in:
   • Proxy plugins folder
   • Each backend server's plugins folder
3. Configure player information forwarding
4. Restart all servers

Proxy config (BungeeCord/Velocity):

# Default config works well for small networks
# No database needed - file storage is fine

Backend server config:

# Should auto-detect proxy mode
# Verify by checking logs for "Proxy Mode"

Verify setup:

• Check each backend server shows "Proxy Mode" in startup logs
• Run /skin Notch and switch servers - skin should persist

Large Network Setup

For networks with 5+ servers, high player counts, or need for API access on backends.

Requirements:

• MySQL database
• BungeeCord or Velocity proxy

Steps:

1. Set up a MySQL database
2. Install SkinsRestorer on proxy and all backends
3. Configure database on all servers
4. Restart everything

Proxy config:

database:
  enabled: true
  host: your-mysql-host
  port: 3306
  database: skinsrestorer
  username: sr_user
  password: secure_password
  maxPoolSize: 20

# Optional: Get a MineSkin API key for high volume
api:
  mineSkinApiKey: "your-key-here"

Backend server config:

# Same database config as proxy
database:
  enabled: true
  host: your-mysql-host
  port: 3306
  database: skinsrestorer
  username: sr_user
  password: secure_password
  maxPoolSize: 10

# API will work on backends with shared database
server:
  proxyMode:
    detection: AUTO
    api: true

Benefits of this setup:

• Centralized skin storage
• API works on all servers
• Better performance at scale
• Plugins like BedWars/Dynmap can access skins