|
1 | | -# LabExtended. |
| 1 | +# LabExtended |
2 | 2 | [](https://github.com/marchellc/LabExtended/actions/workflows/dotnet.yml) |
| 3 | + |
| 4 | +LabExtended is an unofficial extension for the [LabAPI](https://github.com/northwood-studios/LabAPI) modding framework for [SCP Secret Laboratory](https://scpslgame.com), developed by [Northwood Studios](https://github.com/northwood-studios). |
| 5 | +The sole reason for the existence of this project is the fact that LabAPI lacks a lot of functionality when compared to Exiled *(which is just bloated with random stuff)*, |
| 6 | +so we're trying to fix that by providing developers with clear and simple to use APIs. |
| 7 | + |
| 8 | +These APIs include, but are not limited to: |
| 9 | +- Custom Ammo |
| 10 | +- Custom Items *(including Firearms & Usable Items)* |
| 11 | +- Custom Teams |
| 12 | +- Custom Roles |
| 13 | +- Voice Chat API *(with threaded voice message modifications!)* |
| 14 | +- Hint API *(yes, another Hint API ..)* |
| 15 | +- Settings API *(a simple Server-Specific-Settings wrapper)* |
| 16 | +- Remote Admin API *(adds custom dummy actions and objects)* |
| 17 | +- More events *(also some events which already exist in LabAPI, but lack* ***a lot*** *of properties)* |
| 18 | +- A fully-custom Commands API |
| 19 | +.. and much more! |
| 20 | + |
| 21 | +# Documentation |
| 22 | +Every method in the project *should* be documented, but extended descriptions can be found in the [Wiki](https://github.com/marchellc/LabExtended/wiki)! |
| 23 | +If there's something still unclear, create an issue and I'll try to answer. |
| 24 | + |
| 25 | +# Installation |
| 26 | +Grab the assembly from the [Releases](https://github.com/marchellc/LabExtended/releases) page and put it in the server's plugin directory! |
| 27 | +**Do not remove the zero before the plugin name, it's required to be loaded first!** |
| 28 | + |
| 29 | +## Dependencies |
| 30 | +- [NVorbis](https://github.com/NVorbis/NVorbis) |
| 31 | + - Required only if you intend to use the audio API. |
| 32 | +- [Harmony](https://github.com/pardeike/Harmony) |
| 33 | +- [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) |
| 34 | + - Should be a part of the server's dependencies. |
| 35 | + |
| 36 | +# Contributing |
| 37 | +I do not limit contributions at all, if you see something that may be wrong or needs an improvement, create an issue and explain it. |
| 38 | +Any request is welcome, no matter how stupid it may seem! |
0 commit comments