Skip to content

Getting Started

This guide will help you install and configure ArcPass in under 5 minutes.

Prerequisites

Before starting, ensure your server meets these requirements:

RequirementMinimum Version
Minecraft ServerPaper 1.18+ / Spigot 1.18+ / Folia 1.19+
Java17 or higher
LicenseValid ArcPass license key

Optional Dependencies

PluginPurpose
VaultEconomy system support
PlaceholderAPIPlaceholder variables
LuckPermsPermission rewards

Step 1: Install the Plugin

  1. Download the latest ArcPass-x.x.x.jar from the download page
  2. Place the JAR file in your server's plugins folder
  3. Restart the server

On first startup, the plugin generates default configuration files:

plugins/ArcPass/
├── config.yml          # Main configuration
├── database.yml        # Database settings
├── license.yml         # License configuration
├── lang/               # Language files
├── passes/             # Pass configurations
├── quests/             # Quest configurations
├── rewards/            # Reward definitions
└── gui/                # GUI configurations

Step 2: Activate License

Edit plugins/ArcPass/license.yml:

yaml
# License key (obtained from KiteMC after purchase)
license-key: "YOUR-LICENSE-KEY-HERE"

# Show license status messages
show-status: true

Save the file and run /arcpass admin reload or restart the server.

How to get a license?

Visit KiteMC License Center to purchase a license. After purchase, you can view your key on the License Management Page.

Step 3: Basic Configuration

3.1 Language Setting

Edit config.yml to set the default language:

yaml
# Default language
default-locale: "en_US"

# Use player's client language
use-client-locale: true

3.2 Database Configuration

Default uses SQLite, no additional setup needed. For MySQL:

yaml
# database.yml
type: mysql
mysql:
  host: localhost
  port: 3306
  database: arcpass
  username: root
  password: your_password

Step 4: Start a Season

ArcPass requires an active season to function properly.

Option 1: Using Commands

/arcpass admin season start Season1

Option 2: Using Admin GUI

  1. Run /arcpass admin to open admin panel
  2. Click "Start Season" button
  3. Enter season name in chat
  4. Confirm to start

Step 5: Test Features

Now you can test ArcPass basic features:

CommandDescription
/arcpassOpen main pass interface
/arcpass questsView current quests
/arcpass levelView level and experience
/arcpass adminOpen admin panel (requires permission)

Next Steps

Congratulations! You've completed the basic ArcPass setup. Next you can:

Need Help?