Skip to content

Commit a9434de

Browse files
authored
Update README.md
1 parent 6ab171e commit a9434de

File tree

1 file changed

+51
-29
lines changed

1 file changed

+51
-29
lines changed

README.md

Lines changed: 51 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,60 @@ If you find errors, you can contact me in any way convenient for you, but if you
1010
Also, if you have ideas for adding something new, write there
1111
# Configs
1212
```yaml
13+
effect_display:
1314
# will the plugin be active?
14-
is_enabled: false
15-
# will information be displayed for the developer, will help when errors are detected
16-
debug: false
17-
# will a database be used
18-
is_database_use: true
19-
# these lines will be displayed for each effect type separately, allowing you to customize them
20-
effect_line:
21-
Mixed: <size=12>%effect% is <color=\"purple\">Mixed</color> end after %time%|%duration%
22-
Positive: <size=12>%effect% is <color=\"green\">Positive</color> end after %time%|%duration%
23-
Negative: <size=12>%effect% is <color=\"red\">Negative</color> end after %time%|%duration%
24-
# decomposes the text on the screen to change only to what is processed by align
25-
hint_location: '<align=left>'
26-
# defines a list of effects that the player will not see (the effects of the technical process are automatically hidden)
27-
black_list:
28-
- CardiacArrest
29-
- InsufficientLighting
30-
# https://discord.com/channels/656673194693885975/1172647045237067788/1172647045237067788 determines the name of the effect from the existing list to the one you specify
31-
effect_translation:
32-
Bleeding: Blinded
33-
# defines the database name in the path (required at the end of .db)
34-
database_name: 'data.db'
35-
# locates the database
36-
path_to_data_base: 'C:\Users\User\AppData\Roaming\EXILED\Configs\EffectDisplay'
37-
# List of roles for which the effects display will not be displayed (the roles of the dead are ignored)
38-
ignored_roles:
39-
- Spectator
15+
is_enabled: true
16+
# will information be displayed for the developer, will help when errors are detected
17+
debug: false
18+
# will merge with other Hint service providers (for example HintServiceMeow) - if they are installed, it will switch itself
19+
third_party: true
20+
# will a database be used
21+
is_database_use: true
22+
# the time period for which information is updated
23+
update_time: 0.90000000000000002
24+
# these lines will be displayed for each effect type separately, allowing you to customize them
25+
effect_line:
26+
Mixed: '<color="purple">%effect%</color> -> %time%/%duration% LVL: %intensity%'
27+
Positive: '<color="green">%effect%</color> -> %time%/%duration% LVL: %intensity%'
28+
Negative: '<color="red">%effect%</color> -> %time%/%duration% LVL: %intensity%'
29+
# defines a list of effects that the player will not see (the effects of the technical process are hidden)
30+
black_list:
31+
- InsufficientLighting
32+
- SoundtrackMute
33+
# https://discord.com/channels/656673194693885975/1172647045237067788/1172647045237067788 determines the name of the effect from the existing list to the one you specify
34+
effect_translation:
35+
None: UnkownEffect
36+
# defines the database name in the path (required at the end of .db)
37+
database_name: 'data.db'
38+
# folder location current database
39+
path_to_data_base: 'C:\Users\ScpBulBulBul\AppData\Roaming\EXILED\Configs\EffectDisplay'
40+
# List of roles for which the effects display will not be displayed (the roles of the dead are ignored without configs sets)
41+
ignored_roles:
4042
- None
43+
- Spectator
44+
# Standard settings for displaying information, used in the absence of any supported Hint providers
45+
native_hint_settings:
46+
# Text size
47+
font_size: 12
48+
# Text aligment
49+
aligment: 'Left'
50+
# If you use MeowHintService for Exiled then these settings will be useful for customizing the display
51+
meow_hint_settings:
52+
# Text size
53+
font_size: 16
54+
# Position Y Horizontal coordinate 0 -> 1080
55+
y_coordinate: 900
56+
# Position X Vertical coordinate -1200 -> 1200
57+
x_coordinate: -1200
58+
# Hint aligment (Left, Right, Center)
59+
aligment: 'Left'
60+
# Hint vertical aligment (Top, Bottom, Middle)
61+
vertical_aligment: 'Bottom'
4162
```
4263
## How edit
4364
| effect_line | description |
4465
| ------------ | ----- |
45-
| %duration% | when specified in the line, it is replaced by the duration of the effect issued |
46-
| %time% | when specified in the line, it is replaced by the time after which the effect will end |
47-
| %effect% | when specified in a line, it is replaced with the name of the effect that is specified in `effect_translation` or its standard value |
66+
| %duration% | Replaces the line with the maximum duration of the effect (I personally noticed a problem when using an item that gives effects more than 2 times, the duration is summed up and the effect time remains the same) |
67+
| %time% | Replaces the string with the remaining time until the end of the effect |
68+
| %effect% | Replaces with the effect name specified in the configuration or its standard form |
69+
| %intensity% | Replaces the effect strength which is calculated in game `byte`, that is from 0 to 255 |

0 commit comments

Comments
 (0)