Skip to main content
Professional License RequiredThe Developer API is only available with the Professional plan. If you are using the Standard plan, ArcPassProvider.isLoaded() will return false. You can upgrade your license at any time on the License Center.
ArcPass provides a complete API for third-party plugin integration.

API Overview

The ArcPass API module (arcpass-api) is open source under the MIT License.

Features

  • Get and modify player data
  • Query passes, quests, rewards
  • Manage season system
  • Listen to events
  • Trigger custom quest progress

Documentation

Getting Started

Add dependency and basic usage

Event System

Listen to ArcPass events

Code Examples

Common scenario examples

Quick Start

Add Dependency

Maven
Gradle (Kotlin DSL)

Get API Instance

Basic Example

API Interface

ArcPassAPI

Main API interface:

Data Models

PlayerData

Pass

Quest

Season

Async Operations

ArcPass API uses CompletableFuture for async operations:

Thread Safety

  • API methods can be called from any thread
  • Returned data objects are immutable or thread-safe
  • CompletableFuture callbacks may execute on any thread

Next Steps

Detailed Getting Started

Complete tutorial

Event System

Event handling

Code Examples

Practical code samples