Skip to main content

​
Download

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

​
Source Code

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

​
Requirements

Unturned server with RocketMod installed

​
Installation

  1. Download LeaderosConnect.dll
  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 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

FieldDescription
WebsiteUrlThe URL of your LeaderOS website (e.g., https://yourwebsite.com).
ApiKeyYour LeaderOS API key. Find it on Dashboard > Settings > API
ServerTokenYour server token. Find it on Dashboard > Store > Servers > Your Server > Server Token
DebugModeSet to true to enable debug logging, or false to disable it.
CheckPlayerOnlineSet to true to check if players are online before sending commands, or false to skip this check.

​
Commands

CommandDescription
/leaderos.statusDisplays the status of the LeaderOS connection.
/leaderos.reconnectReconnects to the LeaderOS socket server
/leaderos.debugToggles debug mode on/off
All commands require admin privileges.