JustDuel Documentation

Welcome to the official documentation for JustDuel! This guide will walk you through everything you need to know, from initial setup and licensing to advanced configuration and feature usage.

1. Getting Started & Licensing

To get started with JustDuel, you first need to verify your purchase and obtain your license key. We use the official BuiltByBit verification system for a seamless and secure process.

1.1. Verifying Your Purchase

  1. Join our Discord Server: Click the button below to join our official support community.

    Join the Discord Server

  2. Find the Verification Channel: Once you've joined, locate the #verify or #bot-commands channel.

  3. Use the Verify Command: Type /verify in the channel. The BuiltByBit bot will guide you through the process of linking your Discord account to your BuiltByBit account. This is a one-time process.

1.2. Obtaining Your License Key

After successful verification, you can retrieve your license key at any time.

  1. Use the Licenses Command: In the same #verify or #bot-commands channel, type /my-licenses.

  2. Select JustDuel: The bot will present you with a dropdown menu listing all your purchased resources. Select JustDuel from the list.

  3. Copy Your Key: The bot will send you a private message (DM) containing your unique license key. This key is crucial for activating the plugin.

    Important: Never share your license key with anyone. It is tied to your account and server IPs.

1.3. Installing the Plugin

  1. Download the JustDuel.jar file from the BuiltByBit resource page.

  2. Place the JustDuel.jar file into your server's /plugins directory.

  3. Ensure you have Vault installed if you plan to use economy rewards.

  4. Start or restart your server.

  5. The server will shut down safely on the first run, prompting you to enter your license key. Open the plugins/JustDuel/config.yml file.

  6. Paste your license key into the license-key field:

    Generated yaml

    license-key: 'PASTE_YOUR_LICENSE_KEY_HERE'

  7. Save the config.yml file and start your server again. The plugin will now load correctly.

2. Core Concepts: Duel Modes

JustDuel is designed to fit any server type by offering two distinct core modes, which you can set in your config.yml.

Generated yaml

# KITS: Players choose from pre-made kits. The Kit Editor is enabled.
# SMP: Players fight with their current survival inventory. The Kit Editor is disabled.
duel-mode: KITS

KITS Mode

This mode is designed for competitive PvP servers, Practice servers, or any environment where standardized gear is essential.

  • Functionality: Players fight using pre-defined kits. Their survival inventory is saved and restored after the duel.

  • Features Enabled: The in-game Kit Editor, Kit Browser, and kit rating systems are fully available.

  • Use Case: Ideal for 1v1 servers, KitPvP servers, or events where fair, balanced fights are the priority.

SMP Mode

This mode is perfect for Survival (SMP), Factions, and Economy servers where players want to fight with the gear they've earned.

  • Functionality: Players enter the duel with their current inventory and armor. The plugin saves their entire state (items, health, EXP, etc.) and restores it perfectly after the duel, preventing any item loss.

  • Features Disabled: The Kit Editor and Kit Browser are disabled, as players use their live gear.

  • Use Case: Let your community settle disputes or prove their strength using the items they've gathered in your survival world.

3. Creating Your First Arena

Arenas are the designated areas where duels take place. You can create an unlimited number of them. The setup process is done entirely in-game.

Step 1: Create the Arena Entry

First, you need to create a database entry for your new arena. This reserves the name.

/da createarena <ArenaName>

  • Example: /da createarena Desert

Step 2: Set the Spawnpoints

Every arena needs two spawn points. Stand where you want the first player to spawn and type:

/da setarenaspawn <ArenaName> 1

Then, move to the location for the second player and type:

/da setarenaspawn <ArenaName> 2

  • The plugin automatically sets the player's direction to face their opponent upon spawning.

Step 3: Define the Arena Boundaries

The arena boundary (or zone) is the cuboid area where players can fight. If a player leaves this area during a duel, they will forfeit.

  1. Get the Selection Wand:

    /da setarenazone <ArenaName> This gives you a selection wand (Blaze Rod).

  2. Select Position 1: Left-click a block to set the first corner of the zone.

  3. Select Position 2: Right-click a block to set the opposite corner of the zone.

    The plugin will automatically create a 3D bounding box from these two points.

Step 4: Set the Display Icon (KITS Mode Only)

In KITS mode, players can choose a specific arena. This icon represents the arena in the selection GUI.

/da seticon <ArenaName> <Material>

  • Example: /da seticon Desert SANDSTONE

  • You can use tab-completion to see all available materials.

Step 5: Save and Enable the Arena

Once all the previous steps are complete, you must save the arena to make it available for duels.

/da savearena <ArenaName>

If successful, the arena is now in the rotation and ready for duels!

4. Setting Up the Hub Zone

The Hub Zone is a protected area where players can challenge each other, manage kits, and queue for duels without taking damage.

Step 1: Define the Hub Zone

Similar to creating an arena zone, you'll use the selection wand.

  1. Start the Creation Process:

    /da createzone hub <ZoneName>

    • <ZoneName> is a unique name for your hub, e.g., MainHub. This will give you the wand.

  2. Select Positions: Left-click and Right-click two opposite corners to define the boundaries of your hub area.

Once defined, any player entering this zone will automatically switch to "Hub Mode."

Step 2: Set the Global Spawn

The global spawn is the default location where players are teleported after a duel ends or when they connect to the server (if force-spawn-on-join is true). It should ideally be inside your hub zone.

Stand at your desired spawn location and type: /da setspawn

5. Commands & Permissions

Player Commands (/duel)

Command

Description

Permission

/duel <player>

Challenges another player to a duel.

(none)

/duel accept

Accepts the most recent duel request.

(none)

/duel deny

Denies the most recent duel request.

(none)

/duel spectate <player>

Spectates an ongoing duel.

justduel.spectate

/duel leave

Leaves spectator mode or a queue.

(none)

/duel stats [player]

Views your own or another player's stats.

(none)

/duel top [category]

Views the server leaderboards.

(none)

/duel settings

Opens your personal settings GUI.

(none)

/duel savekit

Saves the kit you are currently creating.

(none)

Admin Commands (/da)

All admin commands require the permission justduel.admin.

Command

Description

/da createarena <name>

Creates a new arena definition.

/da deletearena <name>

Deletes an existing arena.

/da setarenaspawn <name> <1|2>

Sets a spawn point for an arena.

/da setarenazone <name>

Sets the duel boundaries for an arena.

/da savearena <name>

Saves and enables a configured arena.

/da seticon <name> <MATERIAL>

Sets the display icon for an arena (Kits mode).

/da createzone hub <name>

Creates a protected hub zone with a wand.

/da setspawn

Sets the global spawn location.

/da spawn 1v1

Spawns the Random Queue NPC.

/da delete 1v1

Deletes the Random Queue NPC.

/da reload

Reloads all plugin configuration files.

Permissions

Permission

Description

Default

justduel.admin

Access to all /da commands.

OP

justduel.spectate

Allows spectating duels.

true

justduel.icon.default

Allows using default kit icons.

true

justduel.icon.premium

Allows using premium kit icons.

OP

justduel.icon.admin

Allows using admin-tier kit icons.

OP

6. Advanced Features

Random Queue NPC

You can create an interactive NPC that players can click to join a random 1v1 queue.

  1. Stand where you want the NPC to appear.

  2. Type /da spawn 1v1.

  3. To remove it, type /da delete 1v1.

The NPC's appearance (block type, name, animation) can be fully customized in config.yml.

Kit Browser & Sharing

In KITS Mode, players can use the Kit Editor (/duel or hub item) to:

  • Create and save personal kits.

  • Manage kits (rename, delete, change icon).

  • Publish their kits to a server-wide Kit Browser. Other players can then use, copy, and rate these published kits.

PlaceholderAPI Support

JustDuel integrates with PlaceholderAPI to display player stats anywhere on your server.

  • %justduel_wins% - Player's total duel wins.

  • %justduel_losses% - Player's total duel losses.

  • %justduel_wlr% - Player's Win/Loss Ratio.

  • %justduel_kills% - Player's total duel kills.

  • %justduel_deaths% - Player's total duel deaths.

  • %justduel_kdr% - Player's Kill/Death Ratio.

Thank you for choosing JustDuel! If you have any further questions, feel free to ask in our Discord server.

Last updated