· 5 years ago · Oct 22, 2020, 03:28 PM
1
2#################################################################
3# #
4# ReefNPC - Configuration #
5# By Intriguing #
6# #
7#################################################################
8#
9# NOTE: Throughout this comment, I will refer to null as ~. Note
10# that you can use both in any plugin configuration.
11#
12# Configuration:
13# The system is really simple. There are different modules.
14# If you do not want to use that module, then just set it to ~.
15#
16# To reload your configuration, there is a command to reload
17# command: /reefnpc reload. You can also restart, which is
18# actually recommended for all plugins.
19#
20# What does @~ and @N~ mean? These are just comment annotations
21# I made to show you which options and maps can be nulified and what options can't.
22# To set a key ~, just do "key: ~"
23#
24# What is @T_<> mean? These mean the type. Also, things like @T_MAP -> @T_LIST, means list in map.
25# Or @T_LIST -> @T_LIST means List in an array of list.
26#
27# PAIR - Key/Value Pair
28# MAP - Map
29# LIST - Array/List
30#
31# The ID of the NPC. The npcID determines whether to execute for that NPC. This
32# is not ~ because why would you have a ~ npcID?
33
34npcID: @N~ @T_MAP
35
36 # The message is for sending messages to player. You can add sound,
37 # make message random, etc! Making this ~ will block message
38 # module from doing anything
39 message: @~ @T_MAP
40 # The sound will be played after each message. This can
41 # be ~, it will not play a sound, if so.
42 sound: @~ @T_MAP
43 # This is the sound option, you can enter any sound as
44 # long as it supports the 1.16.3 SPIGOT API. This can not
45 # be ~, disable the sound map.
46 #
47 # Sound: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
48 sound: @N~ @T_PAIR
49 # Tt must be between 0.0 and 2.0 (inclusive). Specifies the
50 # pitch of the sound. If not specified, defaults to 1.
51 # Values less than 0.5 are equivalent to 0.5. Values lower than 1
52 # lower the pitch and increase the duration; values greater than
53 # 1 raise the pitch and reduce the duration. The pitch value is a
54 # multiplier applied to the frequency, so if a value from 0.5 to 1 is
55 # doubled, the pitch goes an octave higher. This can not be ~, just
56 # set it to the default (read above).
57 pitch: @N~ @T_PAIR
58 # This must be greater than or equal to 0.0. Specifies the distance
59 # that the sound can be heard. If not specified, defaults to 1.
60 # For values less than 1, the volume diminishes and the sound has a
61 # smaller sphere in which it may be heard. For values greater than
62 # 1, the sound does not actually grow louder, but its audible range
63 # (a 16-block radius at 1) is multiplied by volume. There is always a
64 # gradual falloff to silence based on distance from the center of the
65 # sphere. For values equal to or less than 0, no one can hear the sound.
66 # This can not be ~, just set it to the default (read above).
67 volume: @N~ @T_PAIR
68 # Random is a cool feature which allows the server
69 # to randomly pick a message. You must have this key if you want random.
70 # If you want random, but not always/end (explained below), just set
71 # always and end to ~, as it's ~able. Random message will not be used
72 # if this is ~, meaning messages key will use Type 2 instead of Type 1.
73 random: @~ @T_MAP
74 # Always is a list of messages that will
75 # play before the the random messages. No always
76 # message will be sent if this is ~.
77 always: @~ @T_LIST
78 # Always is a list of messages that will
79 # play after the the random messages. No end
80 # message will be sent if this is ~.
81 end: @~ @T_LIST
82 # There are two different types:
83 # Type One - List In A List - USE CASE: RANDOM
84 # Type Two - List - USE CASE: NON RANDOM
85 #
86 # This can be ~, but what's the point?
87 messages: TYPE ONE - @~ @T_LIST -> @T_LIST
88 messages: TYPE TWO - @~ @T_LIST
89 # Prefix is the message that will show
90 # up before each message.
91 #
92 # Format:
93 # <prefix><message> (there is no default space between the two,
94 # you must add your own!) If you make this ~, then
95 # no prefix will be added
96 prefix: @~ - @T_PAIR
97 # The command system will execute a command
98 # ONLY after the message has been played, and
99 # the user has right-clicked the NPC again. If
100 # you make this null, then commands won't be enabled
101 command: @~ - @T_MAP
102 # The type of command is whether the
103 # server or player is running it. There
104 # are only two options, "player" and "console". This can
105 # not be null, disable command map.
106 type: @N~ - @T_PAIR
107 # The sound will be played when executing the command. This can
108 # be ~, it will not play a sound, if so.
109 sound: @~ @T_MAP
110 # This is the sound option, you can enter any sound as
111 # long as it supports the 1.16.3 SPIGOT API. This can not
112 # be ~, disable the sound map.
113 #
114 # Sound: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
115 sound: @N~ @T_PAIR
116 # Tt must be between 0.0 and 2.0 (inclusive). Specifies the
117 # pitch of the sound. If not specified, defaults to 1.
118 # Values less than 0.5 are equivalent to 0.5. Values lower than 1
119 # lower the pitch and increase the duration; values greater than
120 # 1 raise the pitch and reduce the duration. The pitch value is a
121 # multiplier applied to the frequency, so if a value from 0.5 to 1 is
122 # doubled, the pitch goes an octave higher. This can not be ~, just
123 # set it to the default (read above).
124 pitch: @N~ @T_PAIR
125 # This must be greater than or equal to 0.0. Specifies the distance
126 # that the sound can be heard. If not specified, defaults to 1.
127 # For values less than 1, the volume diminishes and the sound has a
128 # smaller sphere in which it may be heard. For values greater than
129 # 1, the sound does not actually grow louder, but its audible range
130 # (a 16-block radius at 1) is multiplied by volume. There is always a
131 # gradual falloff to silence based on distance from the center of the
132 # sphere. For values equal to or less than 0, no one can hear the sound.
133 # This can not be ~, just set it to the default (read above).
134 volume: @N~ @T_PAIR
135 # The command is the actual
136 # command that the player of console will be
137 # executing. Do not include slash. This can
138 # not be null, disable command map.
139 command: @N~ @T_PAIR
140
141