Installing plugins on an SCP: Secret Laboratory server
Install a LabAPI or EXILED plugin: where to upload the .dll file and its dependencies, how to check it loaded and where to change its settings.
Plugins add new features to an SCP: Secret Laboratory server, such as custom items, roles or a Discord integration. A plugin is a .dll file you upload to the right folder in the Pliki (Files) tab.
The client panel is available in Polish only, so this article gives its labels in Polish with a translation the first time they appear.
LabAPI or EXILED
Every plugin is written for one of two frameworks. Check its description before you download it.
- LabAPI: Northwood's official framework, built into the game. A LabAPI plugin works on every server, including ones with the EXILED engine.
- EXILED: a community framework. An EXILED plugin works only on a server with the EXILED engine. First-time setup shows how to turn it on.
Some plugins have a separate file for each framework, such as UncomplicatedCustomItems-LabApi.dll and UncomplicatedCustomItems-Exiled.dll. Download the one that matches your server's engine.
You'll find LabAPI plugins in the SCP: SL plugin directory (opens in a new tab), and EXILED plugins usually on GitHub, under Releases in the plugin's repository.
LabAPI plugin
LabAPI keeps plugins in the .config/SCP Secret Laboratory/LabAPI folder. Each kind of file has two subfolders there:
global: loaded on every port,<port>: loaded only on the server with that port, such as7777. You'll find the port in the Przegląd (Overview) tab.
On a single server, both work the same. Unless the plugin's instructions say otherwise, use the port folder.
Upload the dependencies
If the plugin has dependencies, meaning extra
.dllfiles, often packed asdependencies.zip, open theLabAPI/dependencies/<port>folder and click Wgraj plik (Upload file). You can unpack the archive in the panel: click the three dots next to the file and choose Rozpakuj (Unpack). The.dllfiles appear in the same folder.Upload the plugin
Open the
LabAPI/plugins/<port>folder, click Wgraj plik and choose the plugin's.dllfile.Restart the server
Plugins load at startup. The Konsola (Console) tab shows a
[LabApi] [LOADER] Successfully loadedline with the plugin's name.
After the first start, the plugin's settings appear in the LabAPI/configs/<port>/<plugin name> folder, usually as config.yml.
EXILED plugin
Upload the plugin
Open the
.config/EXILED/Pluginsfolder, click Wgraj plik and choose the plugin's.dllfile. If the plugin needs dependencies, upload them to.config/EXILED/Plugins/dependencies.Restart the server
The console shows a
[Exiled.Loader] Loaded pluginline with the plugin's name and version.
EXILED creates the plugin's settings on the first start in .config/EXILED/Configs/Plugins/<plugin name>/<port>.yml. The console then prints a doesn't have default configs, generating... warning, which isn't an error. You set plugin permissions in .config/EXILED/Configs/permissions.yml, as described in Roles and permissions.
Changing settings and removing a plugin
- Settings: open the plugin's configuration file in the Pliki tab, change the values, click Zapisz plik (Save file) and restart the server.
- Removing: delete the plugin's
.dllfile and restart the server. You can keep the settings folder in case you go back to the plugin, or delete it too.
Common problems
The plugin isn't in the console after a restart
Check that the file is in the right folder. A LabAPI plugin must be in LabAPI/plugins/global or
LabAPI/plugins/<port>, and an EXILED plugin in .config/EXILED/Plugins. An EXILED plugin also
won't load on a server with the LocalAdmin engine.
The plugin loads, but an error follows right after
Usually the plugin needs settings that aren't in the default file, such as a bot token or a channel ID. Read the console lines with the plugin's name in square brackets and fill in the configuration file following the author's instructions.
An error about a missing file or dependency
The plugin couldn't find its dependency. Upload the .dll files from the dependencies archive to
LabAPI/dependencies/<port> (LabAPI) or .config/EXILED/Plugins/dependencies (EXILED).
The plugin stopped working after a game update
A plugin built for an older LabAPI or EXILED version may not work with the new game version. Download the plugin's latest release. If the author hasn't updated it yet, remove the plugin until there's a fix.