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

# Getting Started

<span id="getting-started" />

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

<h2 id="prerequisites">
  Prerequisites
</h2>

Before starting, ensure your server meets these requirements:

| Requirement | Minimum Version |
| - | - |
| Minecraft Server | Paper 1.18+ / Spigot 1.18+ / Folia 1.20+ |
| Java | 17 or higher |
| License | Valid ArcPass license key |

<h3 id="optional-dependencies">
  Optional Dependencies
</h3>

| Plugin | Purpose |
| - | - |
| Vault | Economy system support |
| PlaceholderAPI | Placeholder variables |
| LuckPerms | Permission rewards |

<h2 id="step-1-install-the-plugin">
  Step 1: Install the Plugin
</h2>

1. Download the latest `ArcPass-x.x.x.jar` from the [download page](/en/arcpass/download)
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
```

<h2 id="step-2-activate-license">
  Step 2: Activate License
</h2>

Edit `plugins/ArcPass/license.yml`:

```yaml theme={null}
# 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.

<Tip>
  **How to get a license?**

  Visit [KiteMC License Center](https://license.kitemc.com/products/arcpass) to purchase a license. After purchase, you can view your key on the [License Management Page](https://license.kitemc.com/dashboard/licenses).
</Tip>

<h2 id="step-3-basic-configuration">
  Step 3: Basic Configuration
</h2>

<h3 id="_3-1-language-setting">
  3.1 Language Setting
</h3>

Edit `config.yml` to set the default language:

```yaml theme={null}
locale:
  # Default language for new players
  default: zh_CN
  # Allow players to change their language
  allow-change: true
```

<h3 id="_3-2-database-configuration">
  3.2 Database Configuration
</h3>

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

```yaml theme={null}
# database.yml
type: mysql
mysql:
  host: localhost
  port: 3306
  database: arcpass
  username: root
  password: your_password
```

<h2 id="step-4-start-a-season">
  Step 4: Start a Season
</h2>

ArcPass requires an active season to function properly.

<h3 id="option-1-using-commands">
  Option 1: Using Commands
</h3>

```
/arcpass admin season start Season1
```

<h3 id="option-2-using-admin-gui">
  Option 2: Using Admin GUI
</h3>

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

<Frame caption="Admin Panel Interface">
  <img src="https://mintcdn.com/kitemc/dVZyPCaRRbVaalqm/images/arcpass/screenshot-admin-panel.png?fit=max&auto=format&n=dVZyPCaRRbVaalqm&q=85&s=12285f8d831a7d7736b862d83cd28b86" alt="Admin Panel" width="2560" height="1440" data-path="images/arcpass/screenshot-admin-panel.png" />
</Frame>

<h2 id="step-5-test-features">
  Step 5: Test Features
</h2>

Now you can test ArcPass basic features:

| Command | Description |
| - | - |
| `/arcpass` | Open main pass interface |
| `/arcpass quests` | View current quests |
| `/arcpass level` | View level and experience |
| `/arcpass admin` | Open admin panel (requires permission) |

<Frame caption="ArcPass Main Menu (/arcpass)">
  <img src="https://mintcdn.com/kitemc/dVZyPCaRRbVaalqm/images/arcpass/screenshot-main-menu.png?fit=max&auto=format&n=dVZyPCaRRbVaalqm&q=85&s=a78feaa2bcd90543371afa340aae4310" alt="Main Menu" width="2560" height="1440" data-path="images/arcpass/screenshot-main-menu.png" />
</Frame>

<h2 id="next-steps">
  Next Steps
</h2>

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

<Columns cols={2}>
  <Card title="Configure Pass Tiers and Rewards" icon="ticket" href="/en/arcpass/config/passes">
    Customize pass tiers and level rewards
  </Card>

  <Card title="Set Up Quest System" icon="clipboard-list" href="/en/arcpass/config/quests">
    Configure daily, weekly, and seasonal quests
  </Card>

  <Card title="Customize GUI Interface" icon="palette" href="/en/arcpass/config/gui">
    Beautify your pass interface
  </Card>

  <Card title="Integrate Third-Party Plugins" icon="puzzle" href="/en/arcpass/integrations">
    Connect Vault, LuckPerms, and more
  </Card>
</Columns>

<h2 id="need-help">
  Need Help?
</h2>

<Columns cols={2}>
  <Card title="FAQ" icon="circle-help" href="/en/arcpass/faq">
    Check FAQ for common issues
  </Card>

  <Card title="Discord Community" icon="messages-square" href="https://discord.gg/dcsBw5Z5ZT">
    Join our community for support
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.