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

# Installation Guide

<span id="installation-guide" />

This page provides detailed instructions for installing ArcPass on different server types.

<h2 id="supported-servers">
  Supported Servers
</h2>

| Server | Supported Versions | Notes |
| - | - | - |
| Paper | 1.18 - 1.21+ | Recommended |
| Spigot | 1.18 - 1.21+ | Full support |
| Folia | 1.20 - 1.21+ | Full multi-threaded support |
| Purpur | 1.18 - 1.21+ | Paper-based, full support |
| Bukkit | 1.18 - 1.21+ | Basic features supported |

<Warning>
  **Note**

  CraftBukkit and versions below 1.18 are not supported.
</Warning>

<h2 id="installation-steps">
  Installation Steps
</h2>

<h3 id="_1-download-the-plugin">
  1. Download the Plugin
</h3>

Get the latest version from:

<Columns cols={2}>
  <Card title="GitHub Releases" icon="download" href="https://github.com/KiteMC/ArcPass/releases">
    Download from GitHub
  </Card>

  <Card title="KiteMC Website" icon="shopping-cart" href="https://license.kitemc.com/products/arcpass">
    Purchase and download
  </Card>
</Columns>

<h3 id="_2-place-the-file">
  2. Place the File
</h3>

Put the downloaded `ArcPass-x.x.x.jar` in your server's `plugins` folder:

```
your-server/
├── plugins/
│   ├── ArcPass-1.9.2.jar    ← Place here
│   └── ... other plugins
├── server.jar
└── ...
```

<h3 id="_3-start-the-server">
  3. Start the Server
</h3>

On first startup, the plugin will:

1. Detect server type (Paper/Spigot/Folia)
2. Generate default configuration files
3. Create database (SQLite by default)
4. Wait for license activation

<h3 id="_4-check-startup-logs">
  4) Check Startup Logs
</h3>

On successful startup, you'll see logs like:

```
[ArcPass] Loading ArcPass v1.9.2
[ArcPass] Detected platform: PAPER
[ArcPass] Loading configuration files...
[ArcPass] Initializing database (SQLite)...
[ArcPass] Waiting for license validation...
[ArcPass] License validation required. Please configure license.yml
```

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

```
plugins/ArcPass/
├── config.yml              # Main config
├── database.yml            # Database config
├── license.yml             # License config
├── lang/
│   ├── en_US.yml          # English
│   └── zh_CN.yml          # Chinese
├── passes/
│   └── default.yml        # Default pass
├── quests/
│   ├── daily/             # Daily quests
│   ├── weekly/            # Weekly quests
│   └── seasonal/          # Seasonal quests
├── rewards/
│   └── default.yml        # Default rewards
└── gui/
    ├── main-menu.yml      # Main menu
    ├── quests.yml         # Quests GUI
    └── rewards.yml        # Rewards GUI
```

<h2 id="folia-server-notes">
  Folia Server Notes
</h2>

ArcPass fully supports Folia's regionalized multi-threading:

* All scheduler calls use Folia-compatible APIs
* Database operations run asynchronously
* GUI operations execute on correct region threads

No additional configuration needed - the plugin auto-detects and adapts to Folia.

<h2 id="troubleshooting">
  Troubleshooting
</h2>

<h3 id="plugin-not-loading">
  Plugin Not Loading
</h3>

Check:

1. JAR filename is correct (don't rename it)
2. Java version is 17+
3. Console for error messages

<h3 id="config-files-not-generated">
  Config Files Not Generated
</h3>

1. Ensure plugins folder has write permissions
2. Check disk space
3. Try manually creating `plugins/ArcPass` folder

<h3 id="dependency-plugin-issues">
  Dependency Plugin Issues
</h3>

Ensure compatible versions:

| Plugin | Recommended Version |
| - | - |
| Vault | 1.7.3+ |
| PlaceholderAPI | 2.11.0+ |
| LuckPerms | 5.4+ |

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

After installation:

<Columns cols={2}>
  <Card title="Activate License" icon="key" href="/en/arcpass/setup/license">
    Configure license key
  </Card>

  <Card title="View Requirements" icon="settings" href="/en/arcpass/setup/requirements">
    See full requirements
  </Card>
</Columns>


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