|
2 | 2 | <a href="https://github.com/SebasCapo/Lights/releases"><img src="https://img.shields.io/github/v/release/SebasCapo/Lights?include_prereleases&label=Release" alt="Releases"></a> |
3 | 3 | <a href="https://discord.gg/PyUkWTg"><img src="https://img.shields.io/discord/656673194693885975?color=%23aa0000&label=EXILED" alt="Support"></a> |
4 | 4 |
|
5 | | -# Lights 3.0 |
6 | | -A simple yet EXTREMELY configurable EXILED Plugin that lets you turn the lights off. |
| 5 | +# Lights 4.0 |
| 6 | +An extremely configurable SCP:SL-EXILED Plugin that allows you to control many aspects of it's facility's power systems. |
7 | 7 |
|
8 | 8 | ### What does it do? |
9 | | -This plugin lets you turn off the lights of Light Containment Zone (LCZ) and/or Heavy Containment Zone (HCZ) using a command in the RemoteAdmin console. Overall, pretty simple! (It still needs [EXILED](https://github.com/galaxy119/EXILED "EXILED") to work tho!). |
| 9 | +This plugin lets you change a variety of different settings per room and/or zone, these settings vary from changing a lights color, to turning them off! You can even lock all the doors in a room indefinitely or temporarily. |
| 10 | + |
| 11 | +You can use this to have automatic events using the **preset** system, or affecting a room/zone of your liking using the `lights` RA/Console command. |
| 12 | + |
| 13 | +This plugin also has a **Smart Tesla Gates** mode, which makes tesla gates not trigger when the light settings in their room reach a certain minimum, such as a specific light intensity, color or simply them being turned off. |
10 | 14 |
|
11 | 15 | ### Installation |
12 | 16 | As with any EXILED plugin, you must place the Lights.dll file inside of your "/Exiled/Plugins" folder. |
13 | 17 |
|
| 18 | +([EXILED](https://github.com/galaxy119/EXILED "EXILED") is required for this plugin to work). |
| 19 | + |
14 | 20 | ### Commands |
15 | 21 | Arguments inside <> are required. [] means it's optional. |
16 | | -| Command | Description | Arguments | |
17 | | -| ------------- | ------------------------------ | -------------------- | |
18 | | -| `lights` | Plugin's main command. (Can be modified! Yay!) | **<Seconds>** [Turn off in HCZ only?] | |
19 | 22 |
|
20 | | -**Info on lightsconfig's arguments:** |
21 | | -Set: *Lets you change a variable from in-game. (You still need to type "lightsconfig reload" for it to update)* |
22 | | -Variables: "Gives you a list of all variables available. (I still recommend checking this page as it contains more info)" |
23 | | -Reload: "Reload plugin's variables inside 7777-config.yml. (The other two had parenthesis, this one wants to be part of the cool variables too)" |
| 23 | +- **WARNING:** The main command's name (and it's aliases) can be modified inside the config, so it might be different on the server you are in. |
| 24 | +- **2nd WARNING:** Depending on your system's culture settings, decimal values in-game might need to use commas instead of dots. (You can most likely ignore this warning, but here's an example for those suffering from this: `0.7` > `0,7`) |
| 25 | + |
| 26 | +| Command | Description | |
| 27 | +| ------------------ | ------------------------------ | |
| 28 | +| `lights` | This will print you a help message with examples on how to use this command. | |
| 29 | +| `lights` `<presetId>` | This will run one of the presets from the server's config. | |
| 30 | +| `lights` `<roomType/zoneType>` `<duration>` `<modifierType>` `[parameters]` | This will run a temporary/permanent custom effect on a specific room/entire zone, [click here](https://github.com/SebasCapo/Lights/blob/master/Lights/ModifierType.cs "ModifierType.cs") for a more up-to-date list of all modifier types | |
| 31 | + |
| 32 | +| Modifiers | Description | Arguments | Example | |
| 33 | +| ------------ | -------------------------- | ------------------------------ | --------- | |
| 34 | +| `Color` | Will modify the color of all the lights in a room. | `<r>` `<g>` `<b>` | `255` `100` `255` | |
| 35 | +| `Intensity` | Will modify the light's intensity in a room. | `<intensity>` | `0.5` | |
| 36 | +| `Blackout` | Will turn all lights in a room off. | `N/A` | `N/A` | |
| 37 | +| `Lockdown` | Will lock all doors in a room. (Works weird) | `N/A` | `N/A` | |
24 | 38 |
|
25 | 39 | ### Configuration |
26 | 40 |
|
27 | | -Exiled 2.0 now has auto-generated config files, alongside documentation! So check out your config file for more information on it! |
| 41 | +Exiled 2.0 or above has auto-generated config files, alongside documentation! So check out your config file for more information on it! |
28 | 42 |
|
29 | 43 | ### Permissions |
30 | 44 | These are the permissions that should be added to your permissions.yml inside your "/Exiled/Configs" folder. |
31 | 45 | | Permission | Command | |
32 | 46 | | ------------- | ------------- | |
33 | 47 | | lights.light | `lights` | |
| 48 | +| lights.light | `lights` | |
34 | 49 | | lights.* | `All` | |
35 | 50 |
|
36 | 51 | ### That'd be all |
|
0 commit comments