> ## 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.

# Configuration Overview

<span id="configuration-overview" />

ArcPass uses a modular configuration design with different features configured in separate files.

<h2 id="file-structure">
  File Structure
</h2>

```
plugins/ArcPass/
├── config.yml          # Main config
├── database.yml        # Database config
├── license.yml         # License config
├── lang/               # Language files
│   ├── en_US.yml
│   └── zh_CN.yml
├── passes/             # Pass configs
│   ├── default.yml
│   └── ...
├── quests/             # Quest configs
│   ├── daily/
│   ├── weekly/
│   └── seasonal/
├── rewards/            # Reward configs
│   └── default.yml
└── gui/                # GUI configs
    ├── main-menu.yml
    ├── quests.yml
    └── rewards.yml
```

<h2 id="main-configuration-files">
  Main Configuration Files
</h2>

<h3 id="config-yml">
  config.yml
</h3>

```yaml theme={null}
# Config version (DO NOT MODIFY)
config-version: 2

# Debug mode - enables verbose logging
debug: false

# Locale settings
locale:
  # Default language for new players
  default: zh_CN
  # Allow players to change their language
  allow-change: true

# Pass settings
pass:
  # Maximum level (1-100 recommended)
  max-level: 100
  # Base experience for level 1
  base-experience: 100
  # Experience multiplier per level (1.1 = 10% increase each level)
  experience-multiplier: 1.1

# Quest settings
quests:
  # Daily quest reset time (24-hour format, server timezone)
  daily-reset-hour: 4
  # Weekly quest reset day (1=Monday, 7=Sunday)
  weekly-reset-day: 1

# Notification settings
notifications:
  # Notify players when they level up
  level-up: true
  # Notify players when they complete a quest
  quest-complete: true
  # Notify players when rewards are available
  rewards-available: true
  # Sound effects
  sounds:
    level-up: ENTITY_PLAYER_LEVELUP
    quest-complete: ENTITY_EXPERIENCE_ORB_PICKUP
    reward-claim: BLOCK_NOTE_BLOCK_PLING

# GUI settings
gui:
  # Update interval for animated elements (ticks)
  update-interval: 20
  # Close GUI when clicking outside
  close-on-outside-click: true

# Performance settings
performance:
  # Data save interval (seconds)
  save-interval: 300
  # Cache expiry time (minutes)
  cache-expiry: 30
```

<h3 id="database-yml">
  database.yml
</h3>

```yaml theme={null}
# Config version (DO NOT MODIFY)
config-version: 2

# Storage type: sqlite or mysql
type: sqlite

# SQLite settings (when type: sqlite)
sqlite:
  # Database file name (in plugin folder)
  file: data.db

# MySQL settings (when type: mysql)
mysql:
  host: localhost
  port: 3306
  database: arcpass
  username: root
  password: ""
  # Connection pool size
  pool-size: 10
  # Additional connection properties
  properties:
    useSSL: false
    autoReconnect: true
    allowPublicKeyRetrieval: true

# Cross-Server (Network) Settings
network:
  # standalone | shared-db | redis
  mode: standalone
  server-id: "server-1"
  redis:
    host: localhost
    port: 6379
    password: ""
    database: 0
    pool-size: 8
    cache-ttl: 10
    migration-lock-timeout: 5000
  sync:
    quit-save-mode: blocking
    join-lock-wait: 3000
```

<Warning>
  **Professional License Required**

  Cross-server support (`shared-db` and `redis` modes) requires a **Professional** license. Standard license users will always run in `standalone` mode. Upgrade at the [License Center](https://license.kitemc.com/products/arcpass).
</Warning>

<h2 id="hot-reload">
  Hot Reload
</h2>

Most configurations support hot reload:

```
/arcpass admin reload
```

<Warning>
  **Note**

  These changes require a server restart:

  * Database type switch
  * License key change
</Warning>

<h2 id="configuration-validation">
  Configuration Validation
</h2>

ArcPass validates config files on load:

* Syntax errors shown in console
* Invalid values use defaults with warnings
* Missing required configs prevent startup

<h2 id="detailed-guides">
  Detailed Guides
</h2>

<Columns cols={2}>
  <Card title="Pass Configuration" icon="ticket" href="/en/arcpass/config/passes">
    Tiers, levels, rewards
  </Card>

  <Card title="Quest Configuration" icon="clipboard-list" href="/en/arcpass/config/quests">
    Quest types, objectives
  </Card>

  <Card title="Reward Configuration" icon="gift" href="/en/arcpass/config/rewards">
    Reward types, values
  </Card>

  <Card title="Season Configuration" icon="trophy" href="/en/arcpass/config/seasons">
    Season timing, rules
  </Card>

  <Card title="GUI Configuration" icon="palette" href="/en/arcpass/config/gui">
    Interface layout, items
  </Card>
</Columns>

<h2 id="example-configurations">
  Example Configurations
</h2>

The `docs/examples-en/` folder in the plugin directory contains complete configuration examples.


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