Skip to content

Installation

github-actions[bot] edited this page Jan 3, 2026 · 6 revisions

How to Install BeaconPlus

Getting started with BeaconPlus is easy! accurate. This guide covers everything you need to know to get the plugin running smoothly on your server.


1. Before You Start

Make sure your server meets these requirements:

  • Minecraft Version: 1.13 or newer (fully supports 1.20+).
  • Java Version: Java 17 or higher is required.
  • Server Software: Works on Spigot, Paper, or Folia.
    • Tip: We highly recommend Paper for better performance with beacons and entities.

Recommended Add-ons

  • Vault: Required if you want players to use money for upgrades.
  • Economy Plugin: You need something like EssentialsX or CMI to handle the money itself.
  • PlayerPoints: Optional, if you prefer a secondary "premium" currency.
  • PlaceholderAPI: Useful if you want to show beacon stats on scoreboards or menus.

2. Installation Steps

  1. Download: Get the latest BeaconPlus.jar file.
  2. Upload: Put the .jar file into your server's plugins/ folder.
  3. Start: Restart your server. The plugin will create these folders and files:
    • config.yml: Basic plugin settings.
    • beacon.yml: Core beacon behavior.
    • gui.yml: Menu customization.
    • storage.yml: Database settings.
    • effects/: Custom effect files.
    • languages/: Translation files.
  4. Customize: Edit the files to fit your server's style. (Check the Configuration Guide for details).
  5. Reload: Type /beaconplus reload to apply changes instantly.

3. Common Issues & Fixes

"Plugin will not enable"

  • Java Error: If you see UnsupportedClassVersionError, your server is running an old version of Java. Update to Java 17+.
  • YAML Error: If there's a syntax error in your config (like a missing colon), check the console/logs for a specific line number.

"I can't buy upgrades"

  • Check Vault: Type /plugins. If Vault is red, you might be missing an economy plugin (like EssentialsX).

"Beacons aren't working"

  • World Names: Avoid using special characters or spaces in your world names, as this can sometimes confuse the database.

Tip

Pro Tip: If you're planning a complex setup, test it on a local server first. It's safer than editing files on a live server!


4. Choosing Your Economy

Decide how players will pay for upgrades:

  • Survival Style: Pay with Experience Levels or Points.
  • Server Shop: Pay with Money (Vault).
  • Premium: Pay with PlayerPoints or specific Items (like Emeralds).

You can mix and match these later, but picking a primary one now helps keep things consistent.

Server Owner Reference

Installation
Commands & Permissions
Config.yml
Beacon.yml
GUI Reference
All Beacon Effects
All Conditions & Filters
Effect File Structure
Storage Reference

Tutorials

VIP-Only Effects
Custom Recipes
Multi-Tier Economy
MySQL Setup

Player Guide

Getting Started
Managing Beacons
Upgrading Effects
Access Control

Developer Documentation

API Basics
Custom Effects
Team Providers

Clone this wiki locally