Skip to content

Installation

Follow these steps to install CrestReferrals on your Minecraft server.

Requirements

  • Minecraft version: 1.13+ (Recommended 1.19+)
  • Server type: Paper, Pufferfish, Purpur (May also work on other forks of Paper)
  • Optional Dependencies: PlaceholderAPI (for placeholders)

Installation Steps

  1. Download the latest version of CrestReferrals from SpigotMC or BuiltByBit
  2. Place the .jar file in your server's plugins folder
  3. Restart your server or use a plugin manager to load the plugin
  4. The plugin will automatically create its configuration files

First Run Setup

Upon first run, the plugin will create the following configuration files:

  • config.yml - Main configuration settings
  • messages.yml - Customizable messages
  • milestones.yml - Milestone rewards configuration
  • leaderboard.yml - Leaderboard GUI configuration
  • webhook.yml - Discord webhook configuration
  • players.json - Data storage file (do not edit manually)

Optional Dependencies

  • PlaceholderAPI: Install this plugin to use the provided placeholders in other plugins.

After installation, players have 30 minutes (default setting) to add a referral after joining for the first time.