Skip to main content

​
Download

https://www.leaderos.net/plugin/ark

​
Source Code

https://github.com/leaderos-net/ark-leaderos-connect

​
Requirements

This plugin requires the ASE: Server API extension to be installed.

​
Installation

​
1. Download the plugin

Download the latest release as a ZIP file from the link below and extract it: https://www.leaderos.net/plugin/ark

​
2. Upload the plugin

Copy the LeaderosConnect folder from the extracted ZIP into your server’s AseApi plugins directory: 
ShooterGame/Binaries/Win64/ArkApi/Plugins/LeaderosConnect/
The folder should contain: 
LeaderosConnect/
└── config.json
├── LeaderosConnect.dll
└── leaderos_pending.json
└── PluginInfo.json

​
3. Configure the plugin

Open config.json and fill in your credentials: 
{
    "WebsiteURL":   "https://yourwebsite.com",
    "APIKey":       "YOUR_API_KEY_HERE",
    "ConnectToken": "YOUR_SERVER_TOKEN_HERE",
    "DebugMode":    false,
    "CheckOnline":  true,
    "FreqMinutes":  2
}

​
4. Restart your server

Restart your server. The plugin is now active. Run leaderos.status in the server console to confirm everything is working.

​
Configuration

OptionDescription
WebsiteURLThe URL of your LeaderOS website (e.g., https://yourwebsite.com). Must start with https://.
APIKeyYour LeaderOS API key. Find it on Dashboard > Settings > API.
ConnectTokenYour server token. Find it on Dashboard > Store > Servers > Your Server > Server Token.
DebugModeSet to true to enable verbose debug logging, or false to disable it.
CheckOnlineSet to true to queue commands for offline players and deliver them on next login. Set to false to execute commands regardless of whether the target player is online.
FreqMinutesHow often (in minutes) the plugin polls the command queue.
Note on CheckOnline: When set to false, commands targeting offline players will still attempt to execute — but if the server has no players connected at all, the command will be lost permanently since it has already been marked as executed on the LeaderOS side. It is recommended to keep this set to true.

​
Console Commands

All commands are server-console only and cannot be run by in-game players.
CommandDescription
leaderos.statusDisplays the current configuration and plugin state.
leaderos.reloadReloads config.json from disk and triggers an immediate poll.
leaderos.pollTriggers an immediate queue poll without reloading config.
leaderos.debugToggles debug mode on or off at runtime.