Skip to content

installing-plugins.md

Latest commit

 

History

History
290 lines (212 loc) · 6.49 KB

installing-plugins.md

File metadata and controls

290 lines (212 loc) · 6.49 KB
Raw
title Installing Plugins
description Learn how to find, install, and configure plugins on your Minecraft server.
tags
minecraft
plugins
paper
spigot
bukkit
author NodeByte Team
lastUpdated 2025-12-21
order 2

Installing Plugins

Plugins extend your Minecraft server's functionality, adding features like economy systems, permissions, minigames, and much more. This guide covers everything you need to know about plugins.

Requirements

To use plugins, you need a compatible server software:

  • ✅ Paper
  • ✅ Purpur
  • ✅ Spigot
  • ✅ Bukkit
  • ❌ Vanilla (no plugin support)
  • ❌ Forge (use mods instead)
  • ❌ Fabric (use mods instead)

Finding Plugins

Recommended Plugin Sources

Source URL Trust Level
SpigotMC spigotmc.org ⭐⭐⭐⭐⭐
Modrinth modrinth.com ⭐⭐⭐⭐⭐
Hangar hangar.papermc.io ⭐⭐⭐⭐⭐
Bukkit/CurseForge dev.bukkit.org ⭐⭐⭐⭐
GitHub github.com ⭐⭐⭐⭐

⚠️ Warning: Never download plugins from untrusted sources. Malicious plugins can destroy your server or steal data.

Essential Plugin Categories

  1. Permissions - LuckPerms, PermissionsEx
  2. Economy - Vault, EssentialsX Economy
  3. Protection - WorldGuard, GriefPrevention
  4. Essentials - EssentialsX (commands, homes, warps)
  5. Chat - LPC, ChatControl
  6. Anti-Cheat - Vulcan, Matrix, Spartan

Installing a Plugin

Method 1: Game Panel File Manager

  1. Download the plugin .jar file to your computer
  2. Open your server in the Game Panel
  3. Navigate to Files > plugins/
  4. Click Upload or drag and drop the file
  5. Restart your server

Method 2: SFTP

  1. Connect to your server via SFTP
  2. Navigate to /plugins/
  3. Upload the .jar file
  4. Restart your server

Verifying Installation

After restarting, check the console for:

[Server] [PluginName] Enabling PluginName v1.0.0
[Server] [PluginName] Plugin enabled successfully!

Or run /plugins in-game to see loaded plugins.

Configuring Plugins

Most plugins create configuration files in their own folder:

/plugins/
├── PluginName/
│   ├── config.yml      <- Main configuration
│   ├── messages.yml    <- Customizable messages
│   └── data/           <- Plugin data

Editing Configuration

  1. Stop your server (recommended)
  2. Navigate to /plugins/PluginName/
  3. Edit config.yml
  4. Save changes
  5. Start your server

Common config.yml Structure

# Most plugins use YAML format
settings:
  enabled: true
  debug: false

features:
  some-feature: true
  another-feature: false

messages:
  prefix: "&a[Server]&r"
  welcome: "&eWelcome to the server!"

Essential Plugins Guide

LuckPerms (Permissions)

The gold standard for permission management.

# Install: Drop luckperms.jar in /plugins/
# Access web editor: /lp editor

# Common commands:
/lp user <player> permission set <permission>
/lp group <group> permission set <permission>
/lp user <player> parent set <group>

EssentialsX

All-in-one utility plugin for basics.

Features:

  • /home, /sethome - Player homes
  • /warp, /setwarp - Server warps
  • /spawn, /setspawn - Spawn management
  • /tpa, /tpaccept - Teleport requests
  • /msg, /r - Private messaging
  • /ban, /kick, /mute - Moderation

WorldGuard + WorldEdit

Region protection and world editing.

# Create a protected region:
//wand                    # Get selection tool
# Left-click first corner
# Right-click second corner
/rg create <region-name>
/rg flag <region> pvp deny

Vault

Economy and permissions API (required by many plugins).

Note: Vault is an API plugin. You also need an economy plugin like EssentialsX or a permissions plugin like LuckPerms.

Troubleshooting

Plugin Won't Enable

  1. Check version compatibility

    • Plugin must support your Minecraft version
    • Check the plugin page for requirements

  2. Check for dependencies

    [Server] [PluginName] Missing dependency: Vault

    Install any required dependencies first.

  3. Check console for errors

    [Server] Error enabling PluginName
java.lang.NullPointerException...

    Report errors to plugin developer or check their Discord.

Common Errors

Error Solution
NoClassDefFoundError Missing dependency or wrong version
InvalidPluginException Corrupted JAR or wrong version
FileNotFoundException Config file deleted or corrupted
SQLException Database connection issue

Plugin Conflicts

Some plugins don't work well together:

[Server] [PluginA] Warning: Detected incompatible plugin PluginB

Solutions:

  1. Check plugin pages for known conflicts
  2. Remove conflicting plugin
  3. Find an alternative plugin
  4. Contact developers for guidance

Best Practices

1. Test Before Production

Always test plugins on a local or staging server first.

2. Keep Plugins Updated

Regular updates fix bugs and security issues.

3. Backup Before Changes

# Always backup before installing/updating plugins

4. Limit Plugin Count

More plugins = more potential issues

  • Start with essentials
  • Add plugins as needed
  • Remove unused plugins

5. Read Documentation

Most issues are answered in plugin documentation.

Performance Impact

Plugin Type Typical Impact
Permissions 🟢 Low
Economy 🟢 Low
Chat 🟢 Low
Essentials 🟡 Low-Medium
WorldGuard 🟡 Medium
Anti-Cheat 🟠 Medium-High
Dynmap 🔴 High

Recommended Plugin Stack

For a general SMP server:

Essential:
├── LuckPerms (permissions)
├── Vault (API)
├── EssentialsX (utilities)
├── EssentialsXSpawn (spawn control)
└── EssentialsXChat (chat formatting)

Protection:
├── WorldEdit (building tool)
├── WorldGuard (region protection)
└── CoreProtect (block logging)

Optional:
├── DiscordSRV (Discord integration)
├── dynmap (live map - resource heavy!)
└── PlaceholderAPI (placeholder support)

Plugin Commands

List all plugins:

/plugins
/pl

Get plugin info:

/version <pluginname>

Reload a plugin (if supported):

/<pluginname> reload

Need Help?

  • Check the plugin's documentation
  • Visit the plugin's Discord/support
  • Ask in our Discord
  • Open a support ticket