Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.67 KB

README.md

File metadata and controls

63 lines (45 loc) · 3.67 KB

EXILED-SCP-SL-egg

wakatime Trigger: Push action

A pterodactyl egg for SCP:SL that has EXILED support plus some extra features.

Features:

  • Beta tag support.
  • EXILED support.
  • Option to choose the pre-release or release of EXILED.
  • Specific EXILED version support.
  • Discord Integration support.
  • SCPDiscord support.
  • Automiatically checks if the egg is up to date and notifies you when there is an update.
  • Automatically install and update any plugin you put in (Including private repositories).
  • Exiled updater auto-removal.
  • FFmpeg support (for use with audio player plugins).

Using the automatic plugin installer

When you enable the "Install Custom Plugins" variable in the startup tab and after installation go to the .egg file in your root directory and you will see a file called customplugins.txt You can put the Github link to any plugin in there, one per line but it must be in the correct format (see below) for it to work.

Note: This will not work for NWApi plugins, though there is a way to automatically install/update plugins using Northwood's built in plugin manager which you can access by using the p command.

Format

https://api.github.com/repos/<PLUGIN-AUTHOR>/<REPO-NAME>/releases/latest

Example for BetterScp939

https://api.github.com/repos/iopietro/BetterScp939/releases/latest

⚠️WARNING⚠️

If you need to make more than 60 GitHub requests in an hour you NEED to use authentication or else the installation could possibly fail leaving you with a failed install state! Each install/reinstall makes at least one request to check the egg version and one request per plugin that you add in so if you add 19 plugins and reinstall a few times within a short time frame it will rate-limit you.

Failed Install State

How to use authentication

You should authenticate because it allows you to make up to 5000 GitHub requests per hour as well as letting you download from private repos.

In order to use authentication all you need to do is fill out your GitHub username and Access Token in the startup configuration. You can find a tutorial on how to get a token here.

It is important to follow the principle of least privilege and only grant the permissions it needs. In this case you don't need to add any scopes because we are just validating we are a user.|

If you would like to dowload from private repositories you need to give private repo scopes to your access token. image

Custom Docker Images

Server Image

Server Image

Script Container

Script Container