Skip to content

Commit 6da13a8

Browse files
authored
Update README.md
1 parent 6ea7c1d commit 6da13a8

File tree

1 file changed

+24
-61
lines changed

1 file changed

+24
-61
lines changed

README.md

+24-61
Original file line numberDiff line numberDiff line change
@@ -4,75 +4,38 @@
44

55
This plugin for the game SCP:SL it allows the player to know its active effects
66
# how to use
7-
If you want to hide the display for yourself, you can write the command `turn off` and then you will no longer see the display, but if you, on the contrary, want to see it, then write `turn on`
7+
If you want to hide the display for yourself, you can write the command `display`
88
# What to do when eating bugs
99
If you find errors, you can contact me in any way convenient for you, but if you need my discord, then it is `notifapi`
1010
Also, if you have ideas for adding something new, write there
1111
# Configs
1212
```yaml
1313
effect_display:
14-
# will the plugin be enabled
14+
# will the plugin be active?
1515
is_enabled: true
16-
# Whether the message from the plugin will be visible (Helps if you find a bug)
16+
# will information be displayed for the developer, will help when errors are detected
1717
debug: false
18-
# time during which the text is displayed (0.9 seconds is suitable if the average ping is 80 ms)
19-
text_update_time: 0.9
20-
# What form will the message about what effect the player has enabled
21-
effect_message: '<align=left><size=13>Effect: {effect} is {type} will end {duration} with {intensivity} intensivity</size></align>'
22-
# If you think about it, it's clear that these lines are inserted into {type}
23-
bad_type_writing: '<color=red>Negative</color>'
24-
# If you think about it, it's clear that these lines are inserted into {type}
25-
good_type_writing: '<color=green>Positive</color>'
26-
# If you think about it, it's clear that these lines are inserted into {type}
27-
mixed_type_writing: '<color=#FB00FF>Mixed</color>'
28-
# list of effects that will not be displayed (automatic here are the effects that are issued by the game as technical https://en.scpslgame.com/index.php?title=Status_Effects)
29-
black_list_effect:
30-
- SoundtrackMute
18+
# will a database be used
19+
is_database_use: true
20+
# This message will be displayed on each line
21+
effect_line_message: '<size=12>%effect% is %type% end after %time% second''s</size>'
22+
# effects combining harm and benefit and nothing (207 and its anti)
23+
mixed_effect: '<color=ff00cc>Mixed</color>'
24+
# Only good effect
25+
good_effect: '<color=green>Positive</color>'
26+
# Only bad effect
27+
bad_effect: '<color=red>Negative</color>'
28+
# decomposes the text on the screen to change only to what is processed by align
29+
hint_location: '<align=left>'
30+
# defines a list of effects that the player will not see (the effects of the technical process are automatically hidden)
31+
black_list:
3132
- InsufficientLighting
32-
# how any effect will be displayed on the screen
33-
effect_name_display:
34-
AmnesiaItems: AmnesiaItems
35-
AmnesiaVision: AmnesiaVision
36-
Asphyxiated: Asphyxiated
37-
Bleeding: Bleeding
33+
- SoundtrackMute
34+
# https://discord.com/channels/656673194693885975/1172647045237067788/1172647045237067788 determines the name of the effect from the existing list to the one you specify
35+
effect_translation:
3836
Blinded: Blinded
39-
Burned: Burned
40-
Concussed: Concussed
41-
Corroding: Corroding
42-
Deafened: Deafened
43-
Decontaminating: Decontaminating
44-
Disabled: Disabled
45-
Ensnared: Ensnared
46-
Exhausted: Exhausted
47-
Flashed: Flashed
48-
Hemorrhage: Hemorrhage
49-
Invigorated: Invigorated
50-
BodyshotReduction: BodyshotReduction
51-
Poisoned: Poisoned
52-
Scp207: Scp207
53-
Invisible: Invisible
54-
SinkHole: SinkHole
55-
DamageReduction: DamageReduction
56-
MovementBoost: MovementBoost
57-
RainbowTaste: RainbowTaste
58-
SeveredHands: SeveredHands
59-
Stained: Stained
60-
Vitality: Vitality
61-
Hypothermia: Hypothermia
62-
Scp1853: Scp1853
63-
CardiacArrest: CardiacArrest
64-
InsufficientLighting: InsufficientLighting
65-
SoundtrackMute: SoundtrackMute
66-
SpawnProtected: SpawnProtected
67-
Traumatized: Traumatized
68-
AntiScp207: AntiScp207
69-
Scanned: Scanned
70-
PocketCorroding: PocketCorroding
71-
SilentWalk: SilentWalk
72-
Strangled: Strangled
73-
Ghostly: Ghostly
74-
# defines the path to the database (do not change unless necessary
75-
path_to_database: '{ExiledConfigPath}/EffectDisplay/Player.db'
76-
# use database for save user chose
77-
db_using: true
37+
# defines the database name in the path (required at the end of .db)
38+
database_name: 'data.db'
39+
# locates the database
40+
path_to_data_base: 'C:\Users\NOTIF-ZTA23\AppData\Roaming\EXILED\Configs\EffectDisplay'
7841
```

0 commit comments

Comments
 (0)