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

# LeaderOS Connect

> Connect your Unturned server to LeaderOS, enabling you to execute commands on your server directly from the website.

## Download

[https://www.leaderos.net/plugin/unturned](https://www.leaderos.net/plugin/unturned)

## Source Code

[https://github.com/leaderos-net/unturned-leaderos-connect](https://github.com/leaderos-net/unturned-leaderos-connect)

## Requirements

Unturned server with [RocketMod](https://github.com/RocketMod/Rocket) installed

## Installation

1. [Download `LeaderosConnect.dll`](https://www.leaderos.net/plugin/unturned)
2. Upload it to your server:
   ```
   /Rocket/Plugins/LeaderosConnect.dll
   ```
3. Start the server once to generate the config file, then stop it
4. Edit the config file at:
   ```
   /Rocket/Plugins/LeaderosConnect/LeaderosConnect.configuration.xml
   ```
   ```xml theme={null}
   <?xml version="1.0" encoding="utf-8"?>
   <LeaderosConnectConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <WebsiteUrl>https://yourdomain.com</WebsiteUrl>
     <ApiKey>YOUR_API_KEY</ApiKey>
     <ServerToken>YOUR_SERVER_TOKEN</ServerToken>
     <DebugMode>false</DebugMode>
     <CheckPlayerOnline>true</CheckPlayerOnline>
   </LeaderosConnectConfiguration>
   ```
5. Start the server

## Configuration

| Field               | Description                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `WebsiteUrl`        | The URL of your LeaderOS website (e.g., `https://yourwebsite.com`).                                  |
| `ApiKey`            | Your LeaderOS API key. Find it on `Dashboard > Settings > API`                                       |
| `ServerToken`       | Your server token. Find it on `Dashboard > Store > Servers > Your Server > Server Token`             |
| `DebugMode`         | Set to `true` to enable debug logging, or `false` to disable it.                                     |
| `CheckPlayerOnline` | Set to `true` to check if players are online before sending commands, or `false` to skip this check. |

## Commands

| Command               | Description                                     |
| --------------------- | ----------------------------------------------- |
| `/leaderos.status`    | Displays the status of the LeaderOS connection. |
| `/leaderos.reconnect` | Reconnects to the LeaderOS socket server        |
| `/leaderos.debug`     | Toggles debug mode on/off                       |

All commands require admin privileges.