Installation

This guide will walk you through installing Obfeco on your Minecraft server.

Prerequisites

Before installing, ensure your server meets these requirements:

  • Minecraft Version: 1.17 or higher
  • Server Software: Paper, Spigot, or Folia
  • Java Version: 16 or higher (matching your server's version)

Step 1: Download the Plugin

Download the latest version of Obfeco:

Step 2: Install the Plugin

  1. Stop your server (if running)
  2. Place Obfeco.jar in your server's plugins folder
  3. Start your server
  4. The plugin will generate its configuration files

Step 3: Verify Installation

Once your server starts, verify the plugin is running:

/plugins

You should see Obfeco in green, indicating it's enabled.

Check the console for installation messages:

[Obfeco] Obfeco has been enabled!
[Obfeco] Hooked into Vault!
[Obfeco] Hooked into PlaceholderAPI!

Step 4: Initial Configuration

After installation, you'll find these files in plugins/Obfeco/:

Obfeco/
ā”œā”€ā”€ config.yml              (Main configuration)
ā”œā”€ā”€ messages.yml            (Message customization)
ā”œā”€ā”€ obfeco.db               (Database file if SQLite)
ā””ā”€ā”€ currencies/             (Currency data if YAML)

Step 5: Reload Configuration

After making changes, reload the plugin:

/obfeco reload

Important: Never use /reload to reload the entire server. Always use /obfeco reload to reload just this plugin.

Optional Dependencies

Vault

Obfeco provides a Vault hook for a primary currency, allowing it to work with most other plugins.

Installation:

  1. Download from SpigotMC
  2. Place in plugins folder
  3. Restart server
  4. Configure your primary currency in config.yml

PlaceholderAPI

Enables placeholders for use in other plugins (GUIs, Scoreboards, etc.).

Installation:

  1. Download from SpigotMC
  2. Place in plugins folder
  3. Restart server
  4. Obfeco will automatically detect it

Troubleshooting Installation

Plugin Not Loading

Check console for errors:

  • Look for stack traces or error messages
  • Common issues: Java version mismatch, missing Vault (if enabled)

Configuration Not Generating

Ensure proper permissions:

  • The server must have write permissions to the plugins folder
  • Check file system permissions