Installing the Plugin

ProAdd-on

Install the Isle Plugin onto each server from the dashboard, restart once, and the panels come alive. Updates are one click from the same card.

Open Integration Settings →
Happy path

What this is for

Getting the plugin running on one Isle server so the Garage, Skin Studio, Live Map and chat commands work for it.

Before you start

  • ·Your guild is on Pro with the Isle Plugin add-on active.
  • ·The server has an SFTP or FTP connection configured in Arkanis (the same one used for log streaming), with the game root reachable over it. A Linux server needs SFTP, or an FTP server that allows file permission changes.
  • ·You can restart the server: from Server Control, your panel, or the host.

5-minute setup

  1. 1Open The Isle → Integration Settings. The Plugin section lists every server with an SFTP or FTP connection.
  2. 2Click Install on the server. Arkanis discovers the game tree, uploads the plugin (and UE4SS on a Windows server that has none), and on Linux moves the stock binary aside and drops in the launch wrapper.
  3. 3Restart the server. The card offers a restart button that targets that server, whether it is a panel container or a host.
  4. 4Watch the card turn to Running with the plugin version and a heartbeat age of a second or two.

Common failure modes

  • Another loader found (Windows)
    TheIsle/Binaries/Win64 has a dwmapi.dll but no ue4ss folder, so something else loads through it. Arkanis will not overwrite it. Remove dwmapi.dll, or install UE4SS 3 with its ue4ss folder, then click Install again.
  • Your host refused UE4SS.dll
    Some hosts, GPortal among them, do not accept .dll files over FTP, and UE4SS is made of them. Install undoes what it wrote, so the server is unchanged. Ask your host to install UE4SS into TheIsle/Binaries/Win64 or to allow the upload, then click Install again.
  • Restart needed never clears
    The server did not actually restart, or on Linux the panel start command points at the .orig binary rather than the wrapper. Check the uptime in Server Control and the start command in your egg.
  • Could not reach the host
    The SFTP or FTP connection failed. Test it under Settings; on a Windows host running SSH, make sure the service is running and the port is open from the Arkanis bot.
The rest of this page covers what Install writes on each platform, every card state, and the log lines to look for.

What Install does on each platform

1

Linux (Pterodactyl, Pelican, or a plain host)

The agent library is uploaded next to the server binary, the stock binary is renamed aside, and a two-line launch wrapper takes its place. The wrapper preloads the agent only when the library exists, so removing the file degrades the server to stock rather than stopping it from starting. A game update that rewrites the launch binary is recognised: Install refreshes the stock copy instead of overwriting the update.

2

Windows host

The plugin is a mod for UE4SS, the script loader for Unreal games. A server with no UE4SS gets it from Arkanis first: UE4SS v3.0.1, the build the plugin is tested on, uploaded into TheIsle/Binaries/Win64 with only the plugin enabled. dwmapi.dll, the file that makes the game load UE4SS, goes in last, so an install that stops halfway leaves the server starting exactly as before. Then the ArkanisBridge mod is copied into ue4ss/Mods/ArkanisBridge and enabled. No game binary is touched.

A UE4SS you installed yourself is used as it is and never overwritten. If a host deletes the UE4SS files Arkanis added, the card turns to Needs Repair, and Repair puts them back.

3

One restart

The plugin is mapped into the game process at boot, so an install or an update takes effect on the next start. The card reads the running plugin's own version and tells you when the file on disk is newer than the one running.

What the card tells you

  • Not installed. The game tree was found; click Install.
  • Another loader found. Windows only. A dwmapi.dll that is not UE4SS is in the way; see the common failures above.
  • Restart needed. Installed, or a newer version is on disk than the one running. The restart button beside it restarts that server.
  • Running. Heartbeat within the last three minutes, with the platform and version.
  • Needs repair. Files are present but something the plugin needs is missing: on Linux the launch wrapper (a game update leaves this), on Windows a UE4SS file Arkanis installed. Install again.
  • Update available. Arkanis ships a newer plugin than the one installed. Update, then restart.
ℹ️
Note
A server carrying a newer plugin than Arkanis currently ships (a hand-deployed build) is left alone and says so; an update is never a downgrade.

If it does not start running

  • Restart needed for more than a couple of minutes after a restart: check the server actually restarted (Server Control shows the uptime).
  • Windows: open ue4ss/UE4SS.log from the Files tab and look for [ArkanisBridge] loaded; version=. If UE4SS itself did not load, it is usually a UE4SS build mismatch with the game version.
  • Linux: the launch wrapper must be the file the panel starts. If your egg or start command points at the .orig binary directly, the agent never loads.
  • Could not reach the host: the SFTP or FTP connection failed. Test it under Settings first.