> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vexiumhosting.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installing Plugins

> How to install Bukkit/Spigot plugins

# Installing Plugins

Plugins extend your Minecraft server with new features, commands, and gameplay mechanics.

## Best Practices

<Tip>
  **Before installing any plugins:**

  1. **Backup your server** - Before adding or updating plugins
  2. **Test first** - Try plugins on a test server when possible
  3. **Only use trusted sources** - SpigotMC, Modrinth, Hangar
  4. **Read documentation** - Each plugin has unique setup requirements
  5. **Keep plugins updated** - Update regularly for bug fixes and security
  6. **Minimize plugins** - Only use what you need for better performance
</Tip>

## Requirements

Plugins work with **Bukkit-based** server software:

* ✅ Paper (recommended)
* ✅ Spigot
* ✅ Purpur
* ❌ Vanilla (no plugin support)
* ❌ Forge/Fabric (use mods instead)

## Finding Plugins

### Trusted Sources

| Site         | URL                                                     | Description                 |
| ------------ | ------------------------------------------------------- | --------------------------- |
| **SpigotMC** | [spigotmc.org](https://www.spigotmc.org/resources/)     | Largest plugin repository   |
| **Modrinth** | [modrinth.com](https://modrinth.com/plugins)            | Modern plugin hosting       |
| **Hangar**   | [hangar.papermc.io](https://hangar.papermc.io/)         | Paper's official repository |
| **Bukkit**   | [dev.bukkit.org](https://dev.bukkit.org/bukkit-plugins) | Legacy plugin site          |

<Warning>
  Only download plugins from trusted sources. Malicious plugins can damage your server or steal data.
</Warning>

## Installing Plugins

### Method 1: Built-in Plugin Installer (Recommended)

The easiest way to install plugins:

1. Open your server in the panel
2. Click the **More** tab
3. Browse or search for plugins
4. Click **Install** on the plugin you want
5. Restart your server

### Method 2: File Manager

1. Download the plugin `.jar` file to your computer
2. Open **Files** in the panel
3. Navigate to the `plugins` folder
4. Click **Upload**
5. Select the `.jar` file
6. Restart your server

### Method 3: SFTP

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

## Verifying Installation

After restart:

1. Check console for plugin load messages
2. Run `/plugins` in-game to see loaded plugins
3. Green = enabled, Red = disabled/error

## Essential Plugins

### Administration

| Plugin          | Description                       |
| --------------- | --------------------------------- |
| **EssentialsX** | Core commands, homes, warps, kits |
| **LuckPerms**   | Advanced permissions management   |
| **Vault**       | Economy/permissions API           |
| **WorldEdit**   | In-game map editing               |
| **WorldGuard**  | Region protection                 |

### Protection & Security

| Plugin              | Description                      |
| ------------------- | -------------------------------- |
| **CoreProtect**     | Block logging and rollback       |
| **GriefPrevention** | Claim-based protection           |
| **AuthMe**          | Login security (offline servers) |

### Chat & Communication

| Plugin              | Description            |
| ------------------- | ---------------------- |
| **DiscordSRV**      | Discord integration    |
| **Essentials Chat** | Chat formatting        |
| **VentureChat**     | Advanced chat channels |

### Economy

| Plugin                  | Description                      |
| ----------------------- | -------------------------------- |
| **Vault**               | Economy API (required by others) |
| **EssentialsX Economy** | Basic economy                    |
| **ShopGUI+**            | GUI-based shops                  |
| **ChestShop**           | Player shops                     |

### Quality of Life

| Plugin              | Description           |
| ------------------- | --------------------- |
| **Multiverse-Core** | Multiple worlds       |
| **FAWE**            | Fast async WorldEdit  |
| **PlaceholderAPI**  | Variable placeholders |
| **TAB**             | Custom tablist        |

## Plugin Configuration

Most plugins create config files in `/plugins/PluginName/`:

1. Stop your server
2. Navigate to `/plugins/PluginName`
3. Edit `config.yml` or similar
4. Start your server

### YAML Tips

```yaml  theme={null}
# Correct formatting
setting:
  option: value
  list:
    - item1
    - item2

# Use spaces, not tabs!
# Be careful with indentation
```

## Updating Plugins

1. Download the new version
2. Delete the old `.jar` from `/plugins`
3. Upload the new `.jar`
4. Restart server
5. Check console for update messages

<Tip>
  Some plugins auto-update. Check their documentation.
</Tip>

## Troubleshooting

### Plugin Won't Load

**Check version compatibility:**

* Plugin must support your Minecraft version
* Plugin must support your server type (Spigot/Paper)

**Check dependencies:**

* Some plugins require other plugins
* Read the plugin's requirements

**Check console:**

```
[ERROR] Could not load 'plugins/PluginName.jar'
```

Look for specific error messages.

### Plugin Conflicts

Symptoms:

* Commands not working
* Errors in console
* Unexpected behavior

Solutions:

1. Identify conflicting plugins
2. Check for duplicate functionality
3. Update all plugins
4. Contact plugin developers

### Commands Not Working

1. Check permissions with `/lp user <name> permission check <permission>`
2. Verify plugin is loaded: `/plugins`
3. Check command syntax in plugin documentation

### Configuration Errors

```
[ERROR] Invalid config.yml
```

1. Use a YAML validator
2. Check for tab characters (use spaces)
3. Verify quotes and colons
4. Restore from backup if needed

## Best Practices

1. **Test first** - Try plugins on a test server
2. **Backup regularly** - Before adding/updating plugins
3. **Read documentation** - Each plugin has unique setup
4. **Keep updated** - Update plugins for bug fixes
5. **Minimize plugins** - Only use what you need
6. **Check compatibility** - Verify version support

## Plugin Permissions

Most plugins integrate with permission systems like LuckPerms:

```
/lp group default permission set plugin.command true
```

Common permission formats:

* `pluginname.*` - All permissions
* `pluginname.command` - Specific command
* `pluginname.feature.use` - Specific feature

## Next Steps

* [Installing Mods](/games/minecraft/mods)
* [Server Optimization](/games/minecraft/optimization)
* [Troubleshooting](/games/minecraft/troubleshooting)


Built with [Mintlify](https://mintlify.com).