Skip to content

Commit 7ec58db

Browse files
gamendegamer321gamendegamer321
committed
Removed some logs, updated README
1 parent 72a21d3 commit 7ec58db

File tree

4 files changed

+87
-208
lines changed

4 files changed

+87
-208
lines changed

‎README.md‎

Lines changed: 74 additions & 187 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,78 @@
1-
![Github All Releases](https://img.shields.io/github/downloads/SrLicht/SCP-575/total.svg) <a href="https://github.com/SrLicht/SCP-575/releases"><img src="https://img.shields.io/github/v/release/SrLicht/SCP-575?include_prereleases&label=Last Release" alt="Releases"></a>
2-
3-
# What does this do?
4-
This plugin inserts the SCP-575 in SCP:SL, every round there is a probability that the SCP-575 spawns, if it spawns in LCZ, HCZ and EZ (configurable) there will be blackouts, the players that are in the blackout zones are likely to meet the SCP-575, the SCP-575 will start chasing them, if the 575 touches them the players will be devoured and the SCP-575 will disappear for now. It is possible to make SCP-575 disappear by pointing a flashlight at it or by going to a lighted area.
5-
6-
# Features
7-
* Allows the SCP-575 to play sounds. This is explained in [# Sounds](https://github.com/SrLicht/SCP-575#sounds)
8-
* Spawn an NPC (dummy) that will chase the player, the dummy is fully customizable in terms of mobility, name and killing range.
9-
* If the SCP-575 is in a lighted room for 5 seconds, it will disappear until the next blackout.
10-
* If the player being chased points the SCP-575 with a lighted flashlight or with a weapon that has a lighted flashlight it will add light points, when a certain number of points is reached the SCP-575 will stop chasing the player (this is configurable).
11-
12-
# Requirements
13-
This plugin only works for [NWAPI](https://github.com/northwood-studios/NwPluginAPI) 12.0 or higher.
14-
15-
This plugin uses as dependency [SCPSLAudioApi](https://github.com/CedModV2/SCPSLAudioApi)
16-
17-
# Dependency problem with SCPSLAudioApi
18-
Because of how NWAPI loads the plugin dependencies if more than one plugin installed uses SCPSLAudioApi it will give error and will not start the server, to solve this you will have to put ``NVorbis.dll`` in the dependencies folder.
19-
20-
**NVorbis.dll is included in a separate .zip file in the latest versions.**
21-
22-
# Sounds
23-
This plugin allows you to make the SCP-575 play sounds of your choice, the sound files must be placed in the ``%appdata%/SCP Secret Laboratory/PluginAPI/plugins/Scp575Sounds`` folder.
24-
25-
**Important**
26-
* Sound files must be in .ogg format.
27-
* The sound file must be mono channel
28-
* The sound frequency should be 48000 Hz
29-
* If there are several sound files, one will be chosen at random.
30-
* Only the player being chased hears the sounds.
31-
32-
I recommend using the website https://convertio.co/mp3-ogg/
33-
34-
# Known problems
35-
* AI is dumb and can sometimes get stuck depending on the location.
36-
* SCP-575 appears in RA as a player
37-
* Lazy programmer
1+
[![GitHub release](https://flat.badgen.net/github/release/FrikandelbroodjeCommunity/SCP-575-LabAPI/)](https://github.com/FrikandelbroodjeCommunity/SCP-575-LabAPI/releases/latest)
2+
[![LabAPI Version](https://flat.badgen.net/static/LabAPI%20Version/v1.1.3)](https://github.com/northwood-studios/LabAPI)
3+
[![Original](https://flat.badgen.net/static/Original/SrLicht?icon=github)](https://github.com/SrLicht/SCP-575)
4+
[![License](https://flat.badgen.net/github/license/FrikandelbroodjeCommunity/SCP-575-LabAPI/)](https://github.com/FrikandelbroodjeCommunity/SCP-575-LabAPI/blob/master/LICENSE)
5+
6+
# About SCP-575
7+
8+
This plugin inserts the SCP-575 in SCP:SL, every round there is a probability that the SCP-575 spawns. SCP-575 can spawn
9+
in LCZ, HCZ and EZ, and will do so accompanied by blackouts. The players that are in the blackout zones are likely to
10+
meet the SCP-575, the SCP-575 will start chasing one of them. If 575 touches them, the players will be devoured, and the
11+
SCP-575 will disappear, for now.
12+
13+
> [!TIP]
14+
> It is possible to make SCP-575 disappear by pointing a flashlight at it or by going to a room where the lights are
15+
> still on.
16+
17+
# Installation
18+
19+
> [!IMPORTANT]
20+
> **Required dependencies:**
21+
> - [FrikanUtils](https://github.com/FrikandelbroodjeCommunity/FrikanUtils/blob/master/FrikanUtils/README.md)
22+
> - [FrikanUtils-Audio](https://github.com/FrikandelbroodjeCommunity/FrikanUtils/blob/master/FrikanUtils-Audio/README.md)
23+
24+
Install the dependencies listed above, and place
25+
the [latest release](https://github.com/gamendegamer321/CameraSystem-LabAPI/releases/latest) in the LabAPI plugin
26+
folder.
27+
28+
# Commands
29+
30+
| command | Aliases | Usage | Required permission | Description |
31+
|----------|---------|---------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
32+
| `scp575` | `575` | `575 <player> <duration>` | Remote admin access | Can be used after the round has started to spawn an instance of SCP-575 on a player. This instance will chase the player for the given duration. |
33+
34+
# Config
35+
36+
| Config | Default | Meaning |
37+
|--------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
38+
| `debug_mode` | `false` | When enabled it will show additional debug logs. |
39+
| `audio_files` | ... | The name of the audio files that can be used as chase music. Each time SCP-575 spawns a random file will be chosen _if_ `scp575.play_sounds` is set to `true`. |
40+
| `spawn_chance` | `40` | The chance of SCP-575 being enabled during a round. 0 = never, 100 = always. |
41+
| `disable_for_scp173` | `false` | When enabled, SCP-575 cannot spawn during a round which has SCP-173. |
42+
| `black_out.active_zones` | ... | The zones where blackouts can occur, this determines the zones where SCP-575 can spawn and roam to. |
43+
| `black_out.initial_delay` | `300` | The time in seconds between the round start and the first appearance of SCP-575. Only used when `black_out.random_initial_delay` is set to `false`. |
44+
| `black_out.random_initial_delay` | `false` | Whether the initial delay between the round start and the first appearance should be random or deterministic. `true` = random, `false` = deterministic. |
45+
| `black_out.initial_max_delay` | `250` | The maximum amount of delay in seconds between the round start and the first appearance. Only used when `black_out.random_initial_delay` is set to `true`. |
46+
| `black_out.initial_min_delay` | `190` | The minimum amount of delay in seconds between the round start and the first appearance. Only used when `black_out.random_initial_delay` is set to `true`. |
47+
| `black_out.min_duration` | `30` | The minimum time in seconds SCP-575 will attempt to chase its target before giving up. |
48+
| `black_out.max_duration` | `90` | The maximum time in seconds SCP-575 will attempt to chase its target before giving up. |
49+
| `black_out.min_delay` | `180` | The minimum amount of time in seconds between appearances of SCP-575. |
50+
| `black_out.max_delay` | `400` | The maximum amount of time in seconds between appearances of SCP-575. |
51+
| `black_out.end_blackout_when_disappearing` | `false` | Whether, if SCP-575 disappears, the blackout should also end immediately. |
52+
| `black_out.cassie` | ... | The cassie message that is played before the blackout starts. |
53+
| `black_out.delay_after_cassie` | `8.5` | How long, in seconds, there is between the start of the cassie announcement and the blackout. |
54+
| `black_out.black_list_rooms` | ... | The rooms that will keep their lights on, even if their zone experiences a blackout. |
55+
| `scp575.nickname` | `SCP-575-B` | The nickname that is given to the SCP-575 dummy. |
56+
| `scp575.view_range` | `12` | From how far away the nickname of SCP-575 is visible to the player. The default in the base game is `10`. |
57+
| `scp575.role_type` | `Scp106` | The role SCP-575 is spawned as. |
58+
| `scp575.give_ghostly_effect` | `true` | Whether the ghostly status effect should be given to SCP-575, this makes it possible for 575 to walk through doors if the `scp575.role_type` is not `Scp106`. |
59+
| `scp575.kill_reason` | ... | The kill reason shown to the player when they die. |
60+
| `scp575.play_sounds` | `false` | Whether SCP-575 will play audio while chasing the player. Audio is picked from `audio_files` if enabled. |
61+
| `scp575.audio_is_looped` | `false` | When `play_sounds` is enabled, this determines whether the audio will loop, or only play once. |
62+
| `scp575.sound_volume` | `85` | The volume of the audio played when `play_sounds` is enabled. |
63+
| `scp575.delay_on_chase` | `true` | When enabled, will case SCP-575 to wait for the time given in `scp575.delay_chase` instead of chasing after the player immediately. |
64+
| `scp575.delay_chase` | `3.5` | The time in seconds SCP-575 will wait, if `scp575.delay_on_chase` is enabled. |
65+
| `scp575.max_distance` | `28` | If the distance between SCP-575 and the player they are chasing becomes greater than this, SCP-575 gives up and disappears. |
66+
| `scp575.medium_distance` | `16` | If the distance between SCP-575 and the player they are chasing becomes greater than this, SCP-575 uses the `movement_speed_fast` instead of `movement_speed`. |
67+
| `scp575.kill_distance` | `0.8` | If the distance between SCP-575 and the player they are chasing becomes smaller than this, the player is killed by SCP-575. |
68+
| `scp575.movement_speed_fast` | `5.2` | The movement speed SCP-575 uses if a significant gap has fallen to the player. |
69+
| `scp575.movement_speed` | `4.2` | The normal movement speed of SCP-575. |
70+
| `scp575.light_points` | `30` | Every 0.5 seconds, for each player shining a flashlight on SCP-575 a point is added. If it exceeds this treshold, SCP-575 will disappear. |
71+
| `scp575.use_light_points` | `true` | Whether SCP-575 can be defeated by shining flashlights on it. |
72+
| `command_responses` | ... | Responses used for commands. |
3873

3974
# Gameplay videos
75+
4076
Don't expect high quality, I compressed the videos.
4177

4278
**SCP-575 disappears due to being in a lighted room**
@@ -51,155 +87,6 @@ https://user-images.githubusercontent.com/36207738/213876270-b5333790-a3ed-462a-
5187

5288
https://user-images.githubusercontent.com/36207738/213876508-e25d35c8-0a54-4613-8634-2ecb53d6b7e2.mp4
5389

54-
# Configuration
55-
56-
Default configuration
57-
58-
```yml
59-
# Is the plugin enabled ?
60-
is_enabled: true
61-
# Enable the Logs.Debug of light points and other logs.
62-
debug: false
63-
# Enable the Logs.Debug of SCPSLAudioApi, warning can be very spammy.
64-
audio_debug: false
65-
# Does the blackout affect Entrance Zone ?
66-
active_in_entrance: false
67-
# Does the blackout affect Heavy Contaiment ?
68-
active_in_heavy: false
69-
# Does the blackout affect Light Contaiment ?
70-
active_in_light: true
71-
# The per-round probability of SCP-575 appearing
72-
spawn_chance: 40
73-
# If there is an SCP-173 in the round, SCP-575 will deactivate for that round.
74-
disable_for_scp173: false
75-
# An alternative to the above is this, that when there is an SCP-173 in the Light Containment zone round it will never blackout. YOU CANNOT ACTIVATE BOTH OPTIONS THE PLUGIN WILL BE BROKEN
76-
disable_blackout_for_scp173: false
77-
# All blackout related configuration
78-
black_out:
79-
# After this time, the constant blackouts will begin to be executed.
80-
initial_delay: 300
81-
# If this value is true initial_delay will be ignored and a calculation will be made between initial_max_delay and initial_min_delay which will result in the delay
82-
random_initial_delay: false
83-
# The maximum time that the main delay can have
84-
initial_max_delay: 250
85-
# The minimun time that the main delay can have
86-
initial_min_delay: 190
87-
# The minimum duration of a blackout
88-
min_duration: 30
89-
# The maximum duration of a blackout
90-
max_duration: 90
91-
# The minimum duration of a delay after a blackout
92-
min_delay: 180
93-
# The minimum duration of a delay after a blackout
94-
max_delay: 400
95-
# Before starting the blackout Cassie will say this message
96-
cassie_message: facility power system failure in 3 . pitch_.80 2 . pitch_.60 1 . pitch_.49 . .g1 pitch_.42 .g2 pitch_.31 .g5
97-
# I have no idea what it does
98-
cassie_is_hold: false
99-
# Enable o disable bells in cassie announcement
100-
cassie_is_noise: true
101-
# After making Cassie's announcement the blackout will start after these seconds, perfect to turn off the lights just when the announcement ends.
102-
delay_after_cassie: 8.5
103-
# List of rooms where the light will not turn off, the SCP-575 will disappear if you touch these rooms for 5 seconds. If you want a list of Rooms see the Readme of the plugin repository
104-
black_list_rooms:
105-
- Lcz914
106-
- LczArmory
107-
- LczCheckpointA
108-
- LczCheckpointB
109-
- HczArmory
110-
- HczCheckpointA
111-
- HczCheckpointB
112-
- EzGateA
113-
- EzGateB
114-
# All configuration related to the SCP-575
115-
scp575:
116-
# The name the dummy will have
117-
nickname: SCP-575-B
118-
# The distance at which players can see the name of the SCP-575 | The game default value is 10
119-
view_range: 12
120-
# Set the SCP-575 role, by default is SCP-106
121-
role_type: Scp106
122-
# The death message that will appear when players are killed by SCP-575
123-
kill_feed: Devoured by SCP-575
124-
# The broadcast that will be sent to the player when killed by SCP-575
125-
broadcast_kill: You were eaten by SCP-575, aim with a lit flashlight next time
126-
# The duration of the broadcast, if you want to disable it, set the duration to 0
127-
broadcast_duration: 10
128-
# Should SCP-575 play the sounds files found in its folder? | The sound file must be .ogg need to be mono channel and have a frequency of 48000 Hz
129-
play_sounds: false
130-
# The volume of the sound to be reproduced by the SCP-575, high values violate the VSR.
131-
sound_volume: 85
132-
# Activating this will cause the SCP-575 to spawn with a delay where it will not be able to move or kill.
133-
delay_on_chase: true
134-
# Delay duration where SCP-575 will not be able to do anything
135-
delay_chase: 1.5
136-
# The maximum distance that SCP-575 can be from its victim, remember that it must be greater than 16
137-
max_distance: 28
138-
# If the distance is equal to or greater than this value, the speed that is movement_speed_fast will be applied to the SCP-575.
139-
medium_distance: 16
140-
# If the distance is greater than this value the value of movement_speed will be applied to the SCP-575.
141-
min_distance: 0.800000012
142-
# If the distance between the target and the SCP-575 is less than this value, the target will die. Note that if you modify this value you will have to do it with min_distance as well.
143-
kill_distance: 0.800000012
144-
# If the distance between SCP-575 and its victim is equal to or greater than 16, it will have this movement speed
145-
movement_speed_fast: 29
146-
# If the distance between SCP-575 and its victim is equal to or greater than 5, it will have this movement speed
147-
movement_speed: 22
148-
# This is complicated to explain, so I'll just tell you what I do in the code. If a player has a flashlight on and points it at SCP-575 I fire a ray of light that if it touches SCP-575 adds a point of light, when it reaches a certain point of light SCP-575 disappears. The coroutine that checks these points is executed every 0.1s.
149-
light_points: 85
150-
# When a player makes SCP-575 disappear using the LightPoints, this message will be sent to the player.
151-
light_point_kill_message: SCP-575 disappears for now
152-
153-
```
154-
155-
**Rooms**
156-
157-
```md
158-
- Unnamed
159-
- LczClassDSpawn
160-
- LczComputerRoom
161-
- LczCheckpointA
162-
- LczCheckpointB
163-
- LczToilets
164-
- LczArmory
165-
- Lcz173
166-
- LczGlassroom
167-
- Lcz330
168-
- Lcz914
169-
- LczGreenhouse
170-
- LczAirlock
171-
- HczCheckpointToEntranceZone
172-
- HczCheckpointA
173-
- HczCheckpointB
174-
- HczWarhead
175-
- Hcz049
176-
- Hcz079
177-
- Hcz096
178-
- Hcz106
179-
- Hcz939
180-
- HczMicroHID
181-
- HczArmory
182-
- HczServers
183-
- HczTesla
184-
- EzCollapsedTunnel
185-
- EzGateA
186-
- EzGateB
187-
- EzRedroom
188-
- EzEvacShelter
189-
- EzIntercom
190-
- EzOfficeStoried
191-
- EzOfficeLarge
192-
- EzOfficeSmall
193-
- Outside
194-
- Pocket
195-
- HczTestroom
196-
197-
```
198-
19990
# Credits
20091

201-
The image used belongs to https://lselden.github.io/scp-to-epub/pixel-art-collab/scp-575.xhtml
202-
203-
The transpilers belong to [Jesus-QC](https://github.com/Jesus-QC)
204-
205-
# If you use any part of the code to create your own version of this plugin or pets, please remember to credit the original author :)
92+
If you use any part of the code to create your own version of this plugin or pets, please remember to credit the original author.

0 commit comments

Comments
 (0)