Skip to content

Commit aaa7e71

Browse files
Updated README
Made SCP team always prohibited
1 parent e6b75d8 commit aaa7e71

File tree

3 files changed

+27
-28
lines changed

3 files changed

+27
-28
lines changed

CameraSystem/Configs/Config.cs

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,7 @@ public class Config
3030
};
3131

3232
[Description("Roles that are prohibited from interacting with camera workstations")]
33-
public RoleTypeId[] ProhibitedRoles { get; set; } =
34-
{
35-
RoleTypeId.Scp096,
36-
RoleTypeId.Scp106,
37-
RoleTypeId.Scp173,
38-
RoleTypeId.Scp0492,
39-
RoleTypeId.Scp3114
40-
};
33+
public RoleTypeId[] ProhibitedRoles { get; set; } = [];
4134

4235
[Description("The translations used")] public Translation Translations { get; set; } = new();
4336
}

CameraSystem/EventHandlers.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ internal static bool OnActivatingWorkstation(Player player, WorkstationControlle
131131
return true;
132132
}
133133

134-
if (CameraSystem.Instance.Config.ProhibitedRoles.Contains(player.Role))
134+
if (player.Team == Team.SCPs || CameraSystem.Instance.Config.ProhibitedRoles.Contains(player.Role))
135135
{
136136
player.SendHint(CameraSystem.Instance.Config.Translations.ProhibitedRoleMessage, 7);
137137
return false;

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ A plugin that allows players to connect to the facility's security camera system
1515

1616
# Installation
1717

18-
Place the [latest release](https://github.com/gamendegamer321/CameraSystem-LabAPI/releases/latest) in the LabAPI plugin folder.
18+
Place the [latest release](https://github.com/gamendegamer321/CameraSystem-LabAPI/releases/latest) in the LabAPI plugin
19+
folder.
1920

2021
# Usage
2122

@@ -24,27 +25,29 @@ Place the [latest release](https://github.com/gamendegamer321/CameraSystem-LabAP
2425
3. You'll enter camera view while your physical body remains at the workstation
2526
4. Press the interact button (E) again to exit camera view
2627

27-
# Config
28+
## Commands
2829

29-
```yaml
30-
camera_system:
31-
is_camera_system_enabled_by_default: true
32-
preset_configs:
33-
- room_type: EzIntercom
34-
local_position: {x: -6.9, y: -5.8, z: 1.2}
35-
local_rotation: {x: 0, y: 90, z: 0}
36-
scale: {x: 1, y: 1, z: 0.7}
37-
workstations:
38-
- position: {x: 0, y: 0, z: 0}
39-
rotation: {x: 0, y: 0, z: 0}
40-
scale: {x: 1, y: 1, z: 1}
41-
```
30+
The parent command `camerasystem` (aliases: `cs`, `camera`) contains the following sub-commands.
31+
32+
| Sub-command | Aliases | Usage | Required permission | Description |
33+
|--------------------------|-----------|------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
34+
| `disconnect` | `d`, `dc` | `cs dc <player>` | `camsys.disconnect` | Forces the given player to disconnect from the camera. |
35+
| `toggle` | `t` | `cs toggle` | `camsys.toggle` | Toggles the CameraSystem on/off. |
36+
| `toggleworkstationusage` | `twu` | `cs twu` | `camsys.toggleworkstationusage` | When looking at a workstation, this will add/remove that workstation from the CamerySystem. Adding will cause the workstation to behave as a camera workstation. |
4237

43-
## Preset Configuration Guide
38+
# Config
39+
40+
| Config | Default | Meaning |
41+
|---------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------|
42+
| `is_camera_system_enabled_by_default` | `true` | When set to false, the CameraSystem is not enabled when the plugin starts. Instead the system is only enabled once the `toggle` command is run. |
43+
| `preset_configs` | ... | Presets to spawn workstations based on an offset within a room (see [room presets](#Room-based-Presets)). |
44+
| `workstations` | ... | Presets to spawn workstations based on absolute positions in the map (see [absolute presets](#Absolute-Position-Presets)). |
45+
| `prohibited_roles` | nothing | Roles that are not allowed to use the CameraSystem. SCPs are prohibited by default, so they do not need to be included in this list. |
46+
| `translations` | ... | The different messages that can be displayed by the CameraSystem. |
4447

45-
The plugin offers two ways to place workstations:
48+
## Room-based Presets
4649

47-
### 1. Room-based Presets
50+
Each room preset needs to follow the following structure:
4851

4952
```yaml
5053
preset_configs:
@@ -55,6 +58,7 @@ preset_configs:
5558
```
5659
5760
Benefits:
61+
5862
- Automatically adapts to room position changes
5963
- Easier to configure (positions are relative to room)
6064
- More intuitive placement
@@ -70,7 +74,9 @@ Previous presets are now available as room-based configurations:
7074
| Scp914 | Lcz914 | (-1.9, 0, 5.5) | (0, 90, 0) | (1, 1, 1) |
7175
| Scp9142 | Lcz914 | (-6.2, 0, 3.1) | (0, 180, 0) | (1, 1, 1) |
7276
73-
### 2. Absolute Position Workstations
77+
## Absolute Position Presets
78+
79+
Each absolute position preset needs to follow the following structure:
7480
7581
```yaml
7682
workstations:

0 commit comments

Comments
 (0)