diff --git a/README.md b/README.md index 07a1bbf..3d29f6b 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,30 @@ Features: - Specific EXILED version support - Discord integration bot and plugin - Localadmin +- Automiatically checks if the egg is up to date and notifys you when there is an update. - Auto Admintools install - Auto Common Utilities install. - Auto SCPStats install. +- Automatically install and update any plugin you put in. - Exiled updater auto-removal - FFmpeg (for use with [CommsHack](https://github.com/VirtualBrightPlayz/CommsHack)) If you send a PR that only updates the [install script](https://github.com/Parkeymon/EXILED-SCP-SL-egg/blob/master/script.sh) don't send the exported egg just send the updated script.sh I will add it unless you need to make variable changes in the egg. +## Using the automatic plugin installer + +Located in the `.egg/` directory if you enabled "AUTO INSTALL CUSTOM PLUGINS?" there should 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 for it to work. + +### Format +``` +https://api.github.com/repos///releases/latest +``` + +### Example for [BetterScp939](https://github.com/iopietro/BetterScp939) +``` +https://api.github.com/repos/iopietro/BetterScp939/releases/latest +``` ## Custom Docker Images