Skip to content
Getting Started

Installation

General installation flow shared by all plugins.

Installation follows the same shape for every plugin: stop the server, place the plugin folder where the loader expects it, adjust configuration, start the server, and confirm it loaded.

General flow

  1. Stop the server. Plugin files are locked while it runs.
  2. Place the plugin folder in the AsaApi plugins directory:
path
ShooterGame/Binaries/Win64/ArkApi/Plugins/<PluginName>/
  1. Edit the configuration file for that plugin.
  2. Start the server.
  3. Check the startup log for the plugin's load line, which reports its version.

Back up before installing

Take a backup of your server files and save data before adding or changing plugins, especially on a server with active players.

Save configuration without a BOM

Configuration files must be plain UTF-8 with no byte order mark. Some editors, and PowerShell's default output encoding, add one invisibly — which breaks parsing in ways that are hard to spot.

If a file appears locked

File locks can linger briefly after shutdown. If a copy is refused immediately after stopping the server, wait about thirty seconds and try again.

Clustered plugins

For ClusterSync and TribeScore, repeat the install on every map, point them all at the same database, and keep cluster-level settings identical between maps. Only genuinely per-server values, such as a map identifier, should differ.