Installing Plugins

🧩 Installing Plugins

Install the LabAPI Framework

Good news! The LabAPI should already be installed on your server, as its included with the build distributed on Steam.

Download Plugins

Note

If you already have downloaded a plugin, you can skip to Install the Plugin.

Before we begin, we should warn you that you should still always read the documentation for every plugin, as they may have special steps to follow in order to download & install them.

That said, these are the steps that should help you get started:

1. First, find a plugin you may want to download, and open its Github page (or repository, as we often call it).

   • This usually looks like the following: https://github.com/PluginAuthorGoesHere/PluginNameGoesHere.
   • If you're not sure where to find plugins, we suggest joining the LabAPI Community over at the official SCP:SL Discord.

2. Once you are on the Github repository, you should see something similar to the screenshot below.

   • This page is important as it often contains a README preview at the bottom. Read this, as it is the place where developers typically document everything you will need to know before using their plugin.

3. Navigate over to Releases and click on it. You can find it on the sidebar on the right, underneath the About section.

4. Inside Releases, you will find all of the available releases of a plugin. This may likely include old, new and possibly even beta (Also referred to as "pre-releases") versions of it, these are all uploaded by its author.

   • Because of this, you should pay attention at which version of the game a specific release may be targeting.

5. After you've found your preferred release, simply download its .dll file and any dependencies it may have. Then follow the installation steps.

   • Unless you know what you are doing, do not download the Source Code options in this section.

Note

Additionally, a plugin may create different builds for different plugin frameworks, make sure that what you are using and downloading is made specifically for your preferred framework.

Install Plugins

Important

Make sure you have a compatible version of the plugin with all of its dependencies.

If a plugin is not working or throwing errors (aka exceptions), this would be the first step to verify.

Read "Download Plugins" for more details.

1. Navigate to the LabAPI's main folder.
   • Windows - %appdata%\SCP Secret Laboratory\LabAPI.
   • Linux - ~/.config/SCP Secret Laboratory/LabAPI.

Tip

You should be able to copy-paste these paths in most File Explorers to directly navigate to the folder.

You should see a plugins and dependencies folder.

2. Place the plugin .dll file inside the plugins folder.
   • If the plugin has any dependencies, extract the dependencies inside the depedencies folder.
   • Some plugins may mention other plugins as dependencies. This does NOT mean you should place said plugins in the dependencies folder.
     • Simply repeat the installation process with said plugins by installing them in the plugins folder, as well as any dependencies said plugins may have.

3. That's it! The plugin is now installed. :) You may restart the server in order to load the plugin.
   • We heavily suggest you keep an eye on the Server console while it restarts, as any issues loading your plugin will appear during the initial few steps.
   • Should any issues pop up, we suggest first retrying all the steps listed here.
     • Alternatively, you can join our LabAPI channels on the official SCP:SL Discord and create a support thread so either we or the community can help you.

Once you have confirmed the plugin loads without any issues, you can start to Configure Your Plugin.