Setup

Installation

Install OBX as one plugin JAR, start the server, and check that storage, commands, and optional hooks loaded the way you expect.

Wiki navigation
Wiki homeGetting startedCommandsConfigurationModulesAdministration
Server owner setup

Install OBX

OBX is a drop-in essentials core for Paper, Spigot, PurPur, and Folia servers. Most installs only need the OBX JAR, a server restart, and a quick console check.

1Plugin JAR
0Required plugin hooks
SQLiteAuto-created storage

Short version: stop the server, put OBX-<version>.jar in plugins/, start the server, then confirm OBX says it loaded and opened plugins/OBX/data/obx.db.

Before You Install

Server software

Use Paper when you can. Spigot, PurPur, and Folia are supported too, and OBX detects the platform when it starts.

Minecraft and Java

OBX targets Minecraft 1.8.8 through current releases and is built for Java 8+. Your server version may require a newer Java version, so follow your server software's Java requirement first.

Backups

Before adding or updating plugins, make a backup of your server folder or at least plugins/, world/, and any permission data.

One JAR

Do not look for separate platform builds. OBX is designed as one JAR that adapts to the server it is running on.

Dependencies

OBX does not require Vault, PlaceholderAPI, ProtocolLib, TheNewEconomy, TNE, ExcellentEconomy, or another economy plugin to start.

Required

OBX JAR

Download the latest OBX-<version>.jar from BuiltByBit or GitHub Releases and place it in plugins/.

Required

Java runtime

OBX supports Java 8+. Modern Paper or Folia builds may require Java 17, 21, or newer because of Minecraft itself.

Included

SQLite storage

OBX creates its own SQLite database at plugins/OBX/data/obx.db. You do not need MySQL or a separate database server.

Optional

Vault

Only install Vault if another plugin needs it. OBX can register its own economy provider through Vault when enabled.

Optional

PlaceholderAPI

Useful for placeholder text in supported features such as holograms or announcements. Missing PlaceholderAPI is normal.

Optional

ProtocolLib

Not required for a normal OBX install. Keep it only if your server already uses it for other plugins.

Optional

TheNewEconomy / TNE

OBX can detect these for diagnostics, but it does not use or mirror their balances.

Optional

ExcellentEconomy

OBX can detect it, but OBX economy still uses its own SQLite-backed balances.

Good rule: install optional hooks only when your server already needs them. OBX works without them.

Step-by-Step Install

  1. Download OBX.

    Get the latest OBX-<version>.jar from the official download source you use.

  2. Stop the server.

    Do not add the JAR while the server is still running.

  3. Place the JAR.

    Move the file into your server's plugins/ folder.

  4. Start the server.

    Watch the console while OBX loads. It should detect your platform and create its files.

  5. Join and check commands.

    As an operator or staff account, run /obx version, /obx diagnostics, /health, or /pl to confirm the plugin is loaded.

  6. Review generated files.

    Open plugins/OBX/ and check the main config, systems, language files, shop files, and Arcanum enchant files before opening the server to players.

Files Created on First Start

Main settings

plugins/OBX/config.yml stores core options, module behavior, economy settings, updates, and shared server settings.

System files

plugins/OBX/systems/ includes settings for announcements, chat games, chat management, holograms, hub, permissions, roles, scoreboard, and tablist.

Language files

plugins/OBX/lang/ stores English, German, and Spanish messages with per-player language support.

Economy and shops

shop.yml, worth.yml, and shops/*.yml control shop categories, item prices, and selling values.

Kits and jails

kits.yml and jails.yml store starter kits, cooldowns, kit editor data, and jail anchors.

Arcanum files

plugins/OBX/enchants/ stores custom enchant settings, scroll rates, loot settings, and enchantment categories.

Database

plugins/OBX/data/obx.db stores playtime, economy, kits, backpacks, moderation data, and other persistent records.

Resource pack

OBX bundles a GUI resource pack file used by supported visual interfaces.

Recommended First Checks

  • Keep yourself opped or give yourself the needed staff permissions before testing.
  • Run /obx diagnostics and fix any missing file or storage warning before launch.
  • Check /health after startup to confirm SQLite is available and the server has enough disk space.
  • Review economy, shop, kit, moderation, and teleport settings before players use them.
  • Disable modules you do not want yet instead of deleting their files.
  • Restart after major config changes. Use reload commands only for small, supported file changes.

Updating Later

  1. Read the release notes.

    Check for changed settings, new files, or migration notes.

  2. Back up plugins/OBX/.

    This protects your configs, language edits, shop prices, enchant settings, and SQLite data.

  3. Stop the server.

    Replace the old OBX JAR only while the server is offline.

  4. Start and watch console.

    OBX will open the database and run any needed schema updates.

  5. Run checks again.

    Use /obx version, /obx diagnostics, and /health before sending players back in.

Common Install Problems

OBX does not load

Make sure the JAR is in plugins/, your server is Paper, Spigot, PurPur, or Folia, and your Java version matches what your Minecraft server needs.

SQLite driver warning

Modern Paper and Folia builds load the SQLite library from plugin.yml. On some older Spigot or PurPur builds, place sqlite-jdbc-*.jar in the server's libraries/ folder if the console asks for it.

Optional plugin missing

Warnings about Vault, PlaceholderAPI, ProtocolLib, TNE, or ExcellentEconomy usually mean the hook is not installed. That is okay unless you enabled a feature that needs it.

Commands are blocked

Check operator status, permission nodes, command aliases, and whether another plugin is taking the same command first.

Getting startedConfigurationCommandsArcanum