Spaces:
Running
Running
Create LuckPerms/config.yml
Browse files- plugins/LuckPerms/config.yml +721 -0
plugins/LuckPerms/config.yml
ADDED
@@ -0,0 +1,721 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
####################################################################################################
|
2 |
+
# +----------------------------------------------------------------------------------------------+ #
|
3 |
+
# | __ __ ___ __ __ | #
|
4 |
+
# | | | | / ` |__/ |__) |__ |__) |\/| /__` | #
|
5 |
+
# | |___ \__/ \__, | \ | |___ | \ | | .__/ | #
|
6 |
+
# | | #
|
7 |
+
# | https://luckperms.net | #
|
8 |
+
# | | #
|
9 |
+
# | WIKI: https://luckperms.net/wiki | #
|
10 |
+
# | DISCORD: https://discord.gg/luckperms | #
|
11 |
+
# | BUG REPORTS: https://github.com/LuckPerms/LuckPerms/issues | #
|
12 |
+
# | | #
|
13 |
+
# | Each option in this file is documented and explained here: | #
|
14 |
+
# | ==> https://luckperms.net/wiki/Configuration | #
|
15 |
+
# | | #
|
16 |
+
# | New options are not added to this file automatically. Default values are used if an | #
|
17 |
+
# | option cannot be found. The latest config versions can be obtained at the link above. | #
|
18 |
+
# +----------------------------------------------------------------------------------------------+ #
|
19 |
+
####################################################################################################
|
20 |
+
|
21 |
+
# +----------------------------------------------------------------------------------------------+ #
|
22 |
+
# | | #
|
23 |
+
# | ESSENTIAL SETTINGS | #
|
24 |
+
# | | #
|
25 |
+
# | Important settings that control how LuckPerms functions. | #
|
26 |
+
# | | #
|
27 |
+
# +----------------------------------------------------------------------------------------------+ #
|
28 |
+
|
29 |
+
# The name of the server, used for server specific permissions.
|
30 |
+
#
|
31 |
+
# - When set to "global" this setting is effectively ignored.
|
32 |
+
# - In all other cases, the value here is added to all players in a "server" context.
|
33 |
+
# - See: https://luckperms.net/wiki/Context
|
34 |
+
server: global
|
35 |
+
|
36 |
+
# If the servers own UUID cache/lookup facility should be used when there is no record for a player
|
37 |
+
# already in LuckPerms.
|
38 |
+
#
|
39 |
+
# - When this is set to 'false', commands using a player's username will not work unless the player
|
40 |
+
# has joined since LuckPerms was first installed.
|
41 |
+
# - To get around this, you can use a player's uuid directly in the command, or enable this option.
|
42 |
+
# - When this is set to 'true', the server facility is used. This may use a number of methods,
|
43 |
+
# including checking the servers local cache, or making a request to the Mojang API.
|
44 |
+
use-server-uuid-cache: false
|
45 |
+
|
46 |
+
|
47 |
+
|
48 |
+
|
49 |
+
# +----------------------------------------------------------------------------------------------+ #
|
50 |
+
# | | #
|
51 |
+
# | STORAGE SETTINGS | #
|
52 |
+
# | | #
|
53 |
+
# | Controls which storage method LuckPerms will use to store data. | #
|
54 |
+
# | | #
|
55 |
+
# +----------------------------------------------------------------------------------------------+ #
|
56 |
+
|
57 |
+
# How the plugin should store data
|
58 |
+
#
|
59 |
+
# - The various options are explained in more detail on the wiki:
|
60 |
+
# https://luckperms.net/wiki/Storage-types
|
61 |
+
#
|
62 |
+
# - Possible options:
|
63 |
+
#
|
64 |
+
# | Remote databases - require connection information to be configured below
|
65 |
+
# |=> MySQL
|
66 |
+
# |=> MariaDB (preferred over MySQL)
|
67 |
+
# |=> PostgreSQL
|
68 |
+
# |=> MongoDB
|
69 |
+
#
|
70 |
+
# | Flatfile/local database - don't require any extra configuration
|
71 |
+
# |=> H2 (preferred over SQLite)
|
72 |
+
# |=> SQLite
|
73 |
+
#
|
74 |
+
# | Readable & editable text files - don't require any extra configuration
|
75 |
+
# |=> YAML (.yml files)
|
76 |
+
# |=> JSON (.json files)
|
77 |
+
# |=> HOCON (.conf files)
|
78 |
+
# |=> TOML (.toml files)
|
79 |
+
# |
|
80 |
+
# | By default, user, group and track data is separated into different files. Data can be combined
|
81 |
+
# | and all stored in the same file by switching to a combined storage variant.
|
82 |
+
# | Just add '-combined' to the end of the storage-method, e.g. 'yaml-combined'
|
83 |
+
#
|
84 |
+
# - A H2 database is the default option.
|
85 |
+
# - If you want to edit data manually in "traditional" storage files, we suggest using YAML.
|
86 |
+
storage-method: yaml
|
87 |
+
|
88 |
+
# The following block defines the settings for remote database storage methods.
|
89 |
+
#
|
90 |
+
# - You don't need to touch any of the settings here if you're using a local storage method!
|
91 |
+
# - The connection detail options are shared between all remote storage types.
|
92 |
+
data:
|
93 |
+
|
94 |
+
# Define the address and port for the database.
|
95 |
+
# - The standard DB engine port is used by default
|
96 |
+
# (MySQL: 3306, PostgreSQL: 5432, MongoDB: 27017)
|
97 |
+
# - Specify as "host:port" if differs
|
98 |
+
address: localhost
|
99 |
+
|
100 |
+
# The name of the database to store LuckPerms data in.
|
101 |
+
# - This must be created already. Don't worry about this setting if you're using MongoDB.
|
102 |
+
database: minecraft
|
103 |
+
|
104 |
+
# Credentials for the database.
|
105 |
+
username: root
|
106 |
+
password: ''
|
107 |
+
|
108 |
+
# These settings apply to the MySQL connection pool.
|
109 |
+
# - The default values will be suitable for the majority of users.
|
110 |
+
# - Do not change these settings unless you know what you're doing!
|
111 |
+
pool-settings:
|
112 |
+
|
113 |
+
# Sets the maximum size of the MySQL connection pool.
|
114 |
+
# - Basically this value will determine the maximum number of actual
|
115 |
+
# connections to the database backend.
|
116 |
+
# - More information about determining the size of connection pools can be found here:
|
117 |
+
# https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
|
118 |
+
maximum-pool-size: 10
|
119 |
+
|
120 |
+
# Sets the minimum number of idle connections that the pool will try to maintain.
|
121 |
+
# - For maximum performance and responsiveness to spike demands, it is recommended to not set
|
122 |
+
# this value and instead allow the pool to act as a fixed size connection pool.
|
123 |
+
# (set this value to the same as 'maximum-pool-size')
|
124 |
+
minimum-idle: 10
|
125 |
+
|
126 |
+
# This setting controls the maximum lifetime of a connection in the pool in milliseconds.
|
127 |
+
# - The value should be at least 30 seconds less than any database or infrastructure imposed
|
128 |
+
# connection time limit.
|
129 |
+
maximum-lifetime: 1800000 # 30 minutes
|
130 |
+
|
131 |
+
# This setting controls how frequently the pool will 'ping' a connection in order to prevent it
|
132 |
+
# from being timed out by the database or network infrastructure, measured in milliseconds.
|
133 |
+
# - The value should be less than maximum-lifetime and greater than 30000 (30 seconds).
|
134 |
+
# - Setting the value to zero will disable the keepalive functionality.
|
135 |
+
keepalive-time: 0
|
136 |
+
|
137 |
+
# This setting controls the maximum number of milliseconds that the plugin will wait for a
|
138 |
+
# connection from the pool, before timing out.
|
139 |
+
connection-timeout: 5000 # 5 seconds
|
140 |
+
|
141 |
+
# This setting allows you to define extra properties for connections.
|
142 |
+
#
|
143 |
+
# By default, the following options are set to enable utf8 encoding. (you may need to remove
|
144 |
+
# these if you are using PostgreSQL)
|
145 |
+
# useUnicode: true
|
146 |
+
# characterEncoding: utf8
|
147 |
+
#
|
148 |
+
# You can also use this section to disable SSL connections, by uncommenting the 'useSSL' and
|
149 |
+
# 'verifyServerCertificate' options below.
|
150 |
+
properties:
|
151 |
+
useUnicode: true
|
152 |
+
characterEncoding: utf8
|
153 |
+
#useSSL: false
|
154 |
+
#verifyServerCertificate: false
|
155 |
+
|
156 |
+
# The prefix for all LuckPerms SQL tables.
|
157 |
+
#
|
158 |
+
# - This only applies for remote SQL storage types (MySQL, MariaDB, etc).
|
159 |
+
# - Change this if you want to use different tables for different servers.
|
160 |
+
table-prefix: 'luckperms_'
|
161 |
+
|
162 |
+
# The prefix to use for all LuckPerms MongoDB collections.
|
163 |
+
#
|
164 |
+
# - This only applies for the MongoDB storage type.
|
165 |
+
# - Change this if you want to use different collections for different servers. The default is no
|
166 |
+
# prefix.
|
167 |
+
mongodb-collection-prefix: ''
|
168 |
+
|
169 |
+
# The connection string URI to use to connect to the MongoDB instance.
|
170 |
+
#
|
171 |
+
# - When configured, this setting will override anything defined in the address, database,
|
172 |
+
# username or password fields above.
|
173 |
+
# - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it
|
174 |
+
# below.
|
175 |
+
# - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/
|
176 |
+
mongodb-connection-uri: ''
|
177 |
+
|
178 |
+
# Define settings for a "split" storage setup.
|
179 |
+
#
|
180 |
+
# - This allows you to define a storage method for each type of data.
|
181 |
+
# - The connection options above still have to be correct for each type here.
|
182 |
+
split-storage:
|
183 |
+
# Don't touch this if you don't want to use split storage!
|
184 |
+
enabled: false
|
185 |
+
methods:
|
186 |
+
# These options don't need to be modified if split storage isn't enabled.
|
187 |
+
user: h2
|
188 |
+
group: h2
|
189 |
+
track: h2
|
190 |
+
uuid: h2
|
191 |
+
log: h2
|
192 |
+
|
193 |
+
|
194 |
+
|
195 |
+
|
196 |
+
# +----------------------------------------------------------------------------------------------+ #
|
197 |
+
# | | #
|
198 |
+
# | UPDATE PROPAGATION & MESSAGING SERVICE | #
|
199 |
+
# | | #
|
200 |
+
# | Controls the ways in which LuckPerms will sync data & notify other servers of changes. | #
|
201 |
+
# | These options are documented on greater detail on the wiki under "Instant Updates". | #
|
202 |
+
# | | #
|
203 |
+
# +----------------------------------------------------------------------------------------------+ #
|
204 |
+
|
205 |
+
# This option controls how frequently LuckPerms will perform a sync task.
|
206 |
+
#
|
207 |
+
# - A sync task will refresh all data from the storage, and ensure that the most up-to-date data is
|
208 |
+
# being used by the plugin.
|
209 |
+
# - This is disabled by default, as most users will not need it. However, if you're using a remote
|
210 |
+
# storage type without a messaging service setup, you may wish to set this to something like 3.
|
211 |
+
# - Set to -1 to disable the task completely.
|
212 |
+
sync-minutes: -1
|
213 |
+
|
214 |
+
# If the file watcher should be enabled.
|
215 |
+
#
|
216 |
+
# - When using a file-based storage type, LuckPerms can monitor the data files for changes, and
|
217 |
+
# automatically update when changes are detected.
|
218 |
+
# - If you don't want this feature to be active, set this option to false.
|
219 |
+
watch-files: true
|
220 |
+
|
221 |
+
# Define which messaging service should be used by the plugin.
|
222 |
+
#
|
223 |
+
# - If enabled and configured, LuckPerms will use the messaging service to inform other connected
|
224 |
+
# servers of changes.
|
225 |
+
# - Use the command "/lp networksync" to manually push changes.
|
226 |
+
# - Data is NOT stored using this service. It is only used as a messaging platform.
|
227 |
+
#
|
228 |
+
# - If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need
|
229 |
+
# for LuckPerms to poll the database for changes.
|
230 |
+
#
|
231 |
+
# - Possible options:
|
232 |
+
# => sql Uses the SQL database to form a queue system for communication. Will only work when
|
233 |
+
# 'storage-method' is set to MySQL or MariaDB. This is chosen by default if the
|
234 |
+
# option is set to 'auto' and SQL storage is in use. Set to 'notsql' to disable this.
|
235 |
+
# => pluginmsg Uses the plugin messaging channels to communicate with the proxy.
|
236 |
+
# LuckPerms must be installed on your proxy & all connected servers backend servers.
|
237 |
+
# Won't work if you have more than one proxy.
|
238 |
+
# => lilypad Uses LilyPad pub-sub to push changes. You need to have the LilyPad-Connect plugin
|
239 |
+
# installed.
|
240 |
+
# => redis Uses Redis pub-sub to push changes. Your server connection info must be configured
|
241 |
+
# below.
|
242 |
+
# => rabbitmq Uses RabbitMQ pub-sub to push changes. Your server connection info must be
|
243 |
+
# configured below.
|
244 |
+
# => nats Uses Nats pub-sub to push changes. Your server connection info must be
|
245 |
+
# configured below.
|
246 |
+
# => custom Uses a messaging service provided using the LuckPerms API.
|
247 |
+
# => auto Attempts to automatically setup a messaging service using redis or sql.
|
248 |
+
messaging-service: auto
|
249 |
+
|
250 |
+
# If LuckPerms should automatically push updates after a change has been made with a command.
|
251 |
+
auto-push-updates: true
|
252 |
+
|
253 |
+
# If LuckPerms should push logging entries to connected servers via the messaging service.
|
254 |
+
push-log-entries: true
|
255 |
+
|
256 |
+
# If LuckPerms should broadcast received logging entries to players on this platform.
|
257 |
+
#
|
258 |
+
# - If you have LuckPerms installed on your backend servers as well as a BungeeCord proxy, you
|
259 |
+
# should set this option to false on either your backends or your proxies, to avoid players being
|
260 |
+
# messaged twice about log entries.
|
261 |
+
broadcast-received-log-entries: true
|
262 |
+
|
263 |
+
# Settings for Redis.
|
264 |
+
# Port 6379 is used by default; set address to "host:port" if differs
|
265 |
+
# Multiple Redis nodes can be specified in the same format as a string list under the name "addresses".
|
266 |
+
redis:
|
267 |
+
enabled: false
|
268 |
+
address: localhost
|
269 |
+
username: ''
|
270 |
+
password: ''
|
271 |
+
|
272 |
+
# Settings for Nats.
|
273 |
+
# Port 4222 is used by default; set address to "host:port" if differs
|
274 |
+
nats:
|
275 |
+
enabled: false
|
276 |
+
address: localhost
|
277 |
+
username: ''
|
278 |
+
password: ''
|
279 |
+
|
280 |
+
# Settings for RabbitMQ.
|
281 |
+
# Port 5672 is used by default; set address to "host:port" if differs
|
282 |
+
rabbitmq:
|
283 |
+
enabled: false
|
284 |
+
address: localhost
|
285 |
+
vhost: '/'
|
286 |
+
username: 'guest'
|
287 |
+
password: 'guest'
|
288 |
+
|
289 |
+
|
290 |
+
|
291 |
+
|
292 |
+
# +----------------------------------------------------------------------------------------------+ #
|
293 |
+
# | | #
|
294 |
+
# | CUSTOMIZATION SETTINGS | #
|
295 |
+
# | | #
|
296 |
+
# | Settings that allow admins to customize the way LuckPerms operates. | #
|
297 |
+
# | | #
|
298 |
+
# +----------------------------------------------------------------------------------------------+ #
|
299 |
+
|
300 |
+
# Controls how temporary permissions/parents/meta should be accumulated.
|
301 |
+
#
|
302 |
+
# - The default behaviour is "deny".
|
303 |
+
# - This behaviour can also be specified when the command is executed. See the command usage
|
304 |
+
# documentation for more info.
|
305 |
+
#
|
306 |
+
# - Possible options:
|
307 |
+
# => accumulate durations will be added to the existing expiry time
|
308 |
+
# => replace durations will be replaced if the new duration is later than the current
|
309 |
+
# expiration
|
310 |
+
# => deny the command will just fail if you try to add another node with the same expiry
|
311 |
+
temporary-add-behaviour: deny
|
312 |
+
|
313 |
+
# Controls how LuckPerms will determine a users "primary" group.
|
314 |
+
#
|
315 |
+
# - The meaning and influence of "primary groups" are explained in detail on the wiki.
|
316 |
+
# - The preferred approach is to let LuckPerms automatically determine a users primary group
|
317 |
+
# based on the relative weight of their parent groups.
|
318 |
+
#
|
319 |
+
# - Possible options:
|
320 |
+
# => stored use the value stored against the users record in the file/database
|
321 |
+
# => parents-by-weight just use the users most highly weighted parent
|
322 |
+
# => all-parents-by-weight same as above, but calculates based upon all parents inherited from
|
323 |
+
# both directly and indirectly
|
324 |
+
primary-group-calculation: parents-by-weight
|
325 |
+
|
326 |
+
# If the plugin should check for "extra" permissions with users run LP commands.
|
327 |
+
#
|
328 |
+
# - These extra permissions allow finer control over what users can do with each command, and who
|
329 |
+
# they have access to edit.
|
330 |
+
# - The nature of the checks are documented on the wiki under "Argument based command permissions".
|
331 |
+
# - Argument based permissions are *not* static, unlike the 'base' permissions, and will depend upon
|
332 |
+
# the arguments given within the command.
|
333 |
+
argument-based-command-permissions: false
|
334 |
+
|
335 |
+
# If the plugin should check whether senders are a member of a given group before they're able to
|
336 |
+
# edit the groups data or add/remove other users to/from it.
|
337 |
+
# Note: these limitations do not apply to the web editor!
|
338 |
+
require-sender-group-membership-to-modify: false
|
339 |
+
|
340 |
+
# If the plugin should send log notifications to users whenever permissions are modified.
|
341 |
+
#
|
342 |
+
# - Notifications are only sent to those with the appropriate permission to receive them
|
343 |
+
# - They can also be temporarily enabled/disabled on a per-user basis using
|
344 |
+
# '/lp log notify <on|off>'
|
345 |
+
log-notify: true
|
346 |
+
|
347 |
+
# Defines a list of log entries which should not be sent as notifications to users.
|
348 |
+
#
|
349 |
+
# - Each entry in the list is a RegEx expression which is matched against the log entry description.
|
350 |
+
log-notify-filtered-descriptions:
|
351 |
+
# - "parent add example"
|
352 |
+
|
353 |
+
# If LuckPerms should automatically install translation bundles and periodically update them.
|
354 |
+
auto-install-translations: true
|
355 |
+
|
356 |
+
# Defines the options for prefix and suffix stacking.
|
357 |
+
#
|
358 |
+
# - The feature allows you to display multiple prefixes or suffixes alongside a players username in
|
359 |
+
# chat.
|
360 |
+
# - It is explained and documented in more detail on the wiki under "Prefix & Suffix Stacking".
|
361 |
+
#
|
362 |
+
# - The options are divided into separate sections for prefixes and suffixes.
|
363 |
+
# - The 'duplicates' setting refers to how duplicate elements are handled. Can be 'retain-all',
|
364 |
+
# 'first-only' or 'last-only'.
|
365 |
+
# - The value of 'start-spacer' is included at the start of the resultant prefix/suffix.
|
366 |
+
# - The value of 'end-spacer' is included at the end of the resultant prefix/suffix.
|
367 |
+
# - The value of 'middle-spacer' is included between each element in the resultant prefix/suffix.
|
368 |
+
#
|
369 |
+
# - Possible format options:
|
370 |
+
# => highest Selects the value with the highest weight, from all values
|
371 |
+
# held by or inherited by the player.
|
372 |
+
#
|
373 |
+
# => lowest Same as above, except takes the one with the lowest weight.
|
374 |
+
#
|
375 |
+
# => highest_own Selects the value with the highest weight, but will not
|
376 |
+
# accept any inherited values.
|
377 |
+
#
|
378 |
+
# => lowest_own Same as above, except takes the value with the lowest weight.
|
379 |
+
#
|
380 |
+
# => highest_inherited Selects the value with the highest weight, but will only
|
381 |
+
# accept inherited values.
|
382 |
+
#
|
383 |
+
# => lowest_inherited Same as above, except takes the value with the lowest weight.
|
384 |
+
#
|
385 |
+
# => highest_on_track_<track> Selects the value with the highest weight, but only if the
|
386 |
+
# value was inherited from a group on the given track.
|
387 |
+
#
|
388 |
+
# => lowest_on_track_<track> Same as above, except takes the value with the lowest weight.
|
389 |
+
#
|
390 |
+
# => highest_not_on_track_<track> Selects the value with the highest weight, but only if the
|
391 |
+
# value was inherited from a group not on the given track.
|
392 |
+
#
|
393 |
+
# => lowest_not_on_track_<track> Same as above, except takes the value with the lowest weight.
|
394 |
+
#
|
395 |
+
# => highest_from_group_<group> Selects the value with the highest weight, but only if the
|
396 |
+
# value was inherited from the given group.
|
397 |
+
#
|
398 |
+
# => lowest_from_group_<group> Same as above, except takes the value with the lowest weight.
|
399 |
+
#
|
400 |
+
# => highest_not_from_group_<group> Selects the value with the highest weight, but only if the
|
401 |
+
# value was not inherited from the given group.
|
402 |
+
#
|
403 |
+
# => lowest_not_from_group_<group> Same as above, except takes the value with the lowest weight.
|
404 |
+
meta-formatting:
|
405 |
+
prefix:
|
406 |
+
format:
|
407 |
+
- "highest"
|
408 |
+
duplicates: first-only
|
409 |
+
start-spacer: ""
|
410 |
+
middle-spacer: " "
|
411 |
+
end-spacer: ""
|
412 |
+
suffix:
|
413 |
+
format:
|
414 |
+
- "highest"
|
415 |
+
duplicates: first-only
|
416 |
+
start-spacer: ""
|
417 |
+
middle-spacer: " "
|
418 |
+
end-spacer: ""
|
419 |
+
|
420 |
+
|
421 |
+
|
422 |
+
|
423 |
+
# +----------------------------------------------------------------------------------------------+ #
|
424 |
+
# | | #
|
425 |
+
# | PERMISSION CALCULATION AND INHERITANCE | #
|
426 |
+
# | | #
|
427 |
+
# | Modify the way permission checks, meta lookups and inheritance resolutions are handled. | #
|
428 |
+
# | | #
|
429 |
+
# +----------------------------------------------------------------------------------------------+ #
|
430 |
+
|
431 |
+
# The algorithm LuckPerms should use when traversing the "inheritance tree".
|
432 |
+
#
|
433 |
+
# - Possible options:
|
434 |
+
# => breadth-first See: https://en.wikipedia.org/wiki/Breadth-first_search
|
435 |
+
# => depth-first-pre-order See: https://en.wikipedia.org/wiki/Depth-first_search
|
436 |
+
# => depth-first-post-order See: https://en.wikipedia.org/wiki/Depth-first_search
|
437 |
+
inheritance-traversal-algorithm: depth-first-pre-order
|
438 |
+
|
439 |
+
# If a final sort according to "inheritance rules" should be performed after the traversal algorithm
|
440 |
+
# has resolved the inheritance tree.
|
441 |
+
#
|
442 |
+
# "Inheritance rules" refers to things such as group weightings, primary group status, and the
|
443 |
+
# natural contextual ordering of the group nodes.
|
444 |
+
#
|
445 |
+
# Setting this to 'true' will allow for the inheritance rules to take priority over the structure of
|
446 |
+
# the inheritance tree.
|
447 |
+
#
|
448 |
+
# Effectively when this setting is 'true': the tree is flattened, and rules applied afterwards,
|
449 |
+
# and when this setting is 'false':, the rules are just applied during each step of the traversal.
|
450 |
+
post-traversal-inheritance-sort: false
|
451 |
+
|
452 |
+
# Defines the mode used to determine whether a set of contexts are satisfied.
|
453 |
+
#
|
454 |
+
# - Possible options:
|
455 |
+
# => at-least-one-value-per-key Set A will be satisfied by another set B, if at least one of the
|
456 |
+
# key-value entries per key in A are also in B.
|
457 |
+
# => all-values-per-key Set A will be satisfied by another set B, if all key-value
|
458 |
+
# entries in A are also in B.
|
459 |
+
context-satisfy-mode: at-least-one-value-per-key
|
460 |
+
|
461 |
+
# LuckPerms has a number of built-in contexts. These can be disabled by adding the context key to
|
462 |
+
# the list below.
|
463 |
+
disabled-contexts:
|
464 |
+
# - "world"
|
465 |
+
|
466 |
+
# +----------------------------------------------------------------------------------------------+ #
|
467 |
+
# | Permission resolution settings | #
|
468 |
+
# +----------------------------------------------------------------------------------------------+ #
|
469 |
+
|
470 |
+
# If users on this server should have their global permissions applied.
|
471 |
+
# When set to false, only server specific permissions will apply for users on this server
|
472 |
+
include-global: true
|
473 |
+
|
474 |
+
# If users on this server should have their global world permissions applied.
|
475 |
+
# When set to false, only world specific permissions will apply for users on this server
|
476 |
+
include-global-world: true
|
477 |
+
|
478 |
+
# If users on this server should have global (non-server specific) groups applied
|
479 |
+
apply-global-groups: true
|
480 |
+
|
481 |
+
# If users on this server should have global (non-world specific) groups applied
|
482 |
+
apply-global-world-groups: true
|
483 |
+
|
484 |
+
# +----------------------------------------------------------------------------------------------+ #
|
485 |
+
# | Meta lookup settings | #
|
486 |
+
# +----------------------------------------------------------------------------------------------+ #
|
487 |
+
|
488 |
+
# Defines how meta values should be selected.
|
489 |
+
#
|
490 |
+
# - Possible options:
|
491 |
+
# => inheritance Selects the meta value that was inherited first
|
492 |
+
# => highest-number Selects the highest numerical meta value
|
493 |
+
# => lowest-number Selects the lowest numerical meta value
|
494 |
+
meta-value-selection-default: inheritance
|
495 |
+
|
496 |
+
# Defines how meta values should be selected per key.
|
497 |
+
meta-value-selection:
|
498 |
+
# max-homes: highest-number
|
499 |
+
|
500 |
+
# +----------------------------------------------------------------------------------------------+ #
|
501 |
+
# | Inheritance settings | #
|
502 |
+
# +----------------------------------------------------------------------------------------------+ #
|
503 |
+
|
504 |
+
# If the plugin should apply wildcard permissions.
|
505 |
+
#
|
506 |
+
# - If set to true, LuckPerms will detect wildcard permissions, and resolve & apply all registered
|
507 |
+
# permissions matching the wildcard.
|
508 |
+
apply-wildcards: true
|
509 |
+
|
510 |
+
# If LuckPerms should resolve and apply permissions according to the Sponge style implicit wildcard
|
511 |
+
# inheritance system.
|
512 |
+
#
|
513 |
+
# - That being: If a user has been granted "example", then the player should have also be
|
514 |
+
# automatically granted "example.function", "example.another", "example.deeper.nesting",
|
515 |
+
# and so on.
|
516 |
+
apply-sponge-implicit-wildcards: false
|
517 |
+
|
518 |
+
# If the plugin should apply negated Bukkit default permissions before it considers wildcard
|
519 |
+
# assignments.
|
520 |
+
#
|
521 |
+
# - Plugin authors can define permissions which explicitly should not be given automatically to OPs.
|
522 |
+
# This is usually used for so called "anti-permissions" - permissions which, when granted, apply
|
523 |
+
# something negative.
|
524 |
+
# - If this option is set to true, LuckPerms will consider any negated declarations made by
|
525 |
+
# plugins before it considers wildcards. (similar to the way the OP system works)
|
526 |
+
# - If this option is set to false, LuckPerms will consider any wildcard assignments first.
|
527 |
+
apply-default-negated-permissions-before-wildcards: false
|
528 |
+
|
529 |
+
# If the plugin should parse regex permissions.
|
530 |
+
#
|
531 |
+
# - If set to true, LuckPerms will detect regex permissions, marked with "r=" at the start of the
|
532 |
+
# node, and resolve & apply all registered permissions matching the regex.
|
533 |
+
apply-regex: true
|
534 |
+
|
535 |
+
# If the plugin should complete and apply shorthand permissions.
|
536 |
+
#
|
537 |
+
# - If set to true, LuckPerms will detect and expand shorthand node patterns.
|
538 |
+
apply-shorthand: true
|
539 |
+
|
540 |
+
# If the plugin should apply Bukkit child permissions.
|
541 |
+
#
|
542 |
+
# - Plugin authors can define custom permissions structures for their plugin, which will be resolved
|
543 |
+
# and used by LuckPerms if this setting is enabled.
|
544 |
+
apply-bukkit-child-permissions: true
|
545 |
+
|
546 |
+
# If the plugin should apply Bukkit default permissions.
|
547 |
+
#
|
548 |
+
# - Plugin authors can define permissions which should be given to all users by default, or setup
|
549 |
+
# permissions which should/shouldn't be given to opped players.
|
550 |
+
# - If this option is set to false, LuckPerms will ignore these defaults.
|
551 |
+
apply-bukkit-default-permissions: true
|
552 |
+
|
553 |
+
# If the plugin should apply attachment permissions.
|
554 |
+
#
|
555 |
+
# - Other plugins on the server are able to add their own "permission attachments" to players.
|
556 |
+
# - This allows them to grant players additional permissions which last until the end of the
|
557 |
+
# session, or until they're removed.
|
558 |
+
# - If this option is set to false, LuckPerms will not include these attachment permissions when
|
559 |
+
# considering if a player should have access to a certain permission.
|
560 |
+
apply-bukkit-attachment-permissions: true
|
561 |
+
|
562 |
+
# +----------------------------------------------------------------------------------------------+ #
|
563 |
+
# | Extra settings | #
|
564 |
+
# +----------------------------------------------------------------------------------------------+ #
|
565 |
+
|
566 |
+
# A list of context calculators which will be skipped when calculating contexts.
|
567 |
+
#
|
568 |
+
# - You can disable context calculators by either:
|
569 |
+
# => specifying the Java class name used by the calculator (e.g. com.example.ExampleCalculator)
|
570 |
+
# => specifying a sub-section of the Java package used by the calculator (e.g. com.example)
|
571 |
+
disabled-context-calculators: []
|
572 |
+
|
573 |
+
# Allows you to set "aliases" for the worlds sent forward for context calculation.
|
574 |
+
#
|
575 |
+
# - These aliases are provided in addition to the real world name. Applied recursively.
|
576 |
+
# - Remove the comment characters for the default aliases to apply.
|
577 |
+
world-rewrite:
|
578 |
+
# world_nether: world
|
579 |
+
# world_the_end: world
|
580 |
+
|
581 |
+
# Define special group weights for this server.
|
582 |
+
#
|
583 |
+
# - Group weights can also be applied directly to group data, using the setweight command.
|
584 |
+
# - This section allows weights to be set on a per-server basis.
|
585 |
+
group-weight:
|
586 |
+
# admin: 10
|
587 |
+
|
588 |
+
|
589 |
+
|
590 |
+
|
591 |
+
# +----------------------------------------------------------------------------------------------+ #
|
592 |
+
# | | #
|
593 |
+
# | FINE TUNING OPTIONS | #
|
594 |
+
# | | #
|
595 |
+
# | A number of more niche settings for tweaking and changing behaviour. The section also | #
|
596 |
+
# | contains toggles for some more specialised features. It is only necessary to make changes to | #
|
597 |
+
# | these options if you want to fine-tune LuckPerms behaviour. | #
|
598 |
+
# | | #
|
599 |
+
# +----------------------------------------------------------------------------------------------+ #
|
600 |
+
|
601 |
+
# +----------------------------------------------------------------------------------------------+ #
|
602 |
+
# | Server Operator (OP) settings | #
|
603 |
+
# +----------------------------------------------------------------------------------------------+ #
|
604 |
+
|
605 |
+
# Controls whether server operators should exist at all.
|
606 |
+
#
|
607 |
+
# - When set to 'false', all players will be de-opped, and the /op and /deop commands will be
|
608 |
+
# disabled. Note that vanilla features like the spawn-protection require an operator on the
|
609 |
+
# server to work.
|
610 |
+
enable-ops: true
|
611 |
+
|
612 |
+
# Enables or disables a special permission based system in LuckPerms for controlling OP status.
|
613 |
+
#
|
614 |
+
# - If set to true, any user with the permission "luckperms.autoop" will automatically be granted
|
615 |
+
# server operator status. This permission can be inherited, or set on specific servers/worlds,
|
616 |
+
# temporarily, etc.
|
617 |
+
# - Additionally, setting this to true will force the "enable-ops" option above to false. All users
|
618 |
+
# will be de-opped unless they have the permission node, and the op/deop commands will be
|
619 |
+
# disabled.
|
620 |
+
# - It is recommended that you use this option instead of assigning a single '*' permission.
|
621 |
+
auto-op: false
|
622 |
+
|
623 |
+
# Defines if "opped" players should be able to use all LuckPerms commands by default.
|
624 |
+
#
|
625 |
+
# - Set to false to only allow users who have the permissions access to the commands
|
626 |
+
commands-allow-op: true
|
627 |
+
|
628 |
+
# +----------------------------------------------------------------------------------------------+ #
|
629 |
+
# | Vault integration settings | #
|
630 |
+
# +----------------------------------------------------------------------------------------------+ #
|
631 |
+
|
632 |
+
# If Vault lookups for offline players on the main server thread should be enabled.
|
633 |
+
#
|
634 |
+
# LuckPerms has a "catch" for plugins attempting to perform unsafe offline player data lookups
|
635 |
+
# from the main server thread. This catch raises an exception (causes an error to occur) when unsafe
|
636 |
+
# lookups are made, instead of allowing the lookup to happen, which would likely cause the server
|
637 |
+
# to lag.
|
638 |
+
#
|
639 |
+
# However, if you're willing to accept the consequences, the catch can be disabled by setting this
|
640 |
+
# option to 'true.
|
641 |
+
vault-unsafe-lookups: false
|
642 |
+
|
643 |
+
# If LuckPerms should use the 'display name' of a group when returning groups in Vault API calls.
|
644 |
+
#
|
645 |
+
# - When this option is set to true, the display name of the group is returned.
|
646 |
+
# - When this option is set to false, the standard name/id of the group is returned.
|
647 |
+
vault-group-use-displaynames: true
|
648 |
+
|
649 |
+
# Controls which group LuckPerms should use for NPC players when handling Vault requests.
|
650 |
+
#
|
651 |
+
# - As NPCs aren't actually real players, LuckPerms does not load any user data for them. This
|
652 |
+
# becomes an issue when plugins want to check for their permissions using Vault.
|
653 |
+
# - As a solution, Vault checks for NPCs fallback to a group, which is defined below.
|
654 |
+
vault-npc-group: default
|
655 |
+
|
656 |
+
# Controls how LuckPerms should consider the OP status of NPC players when handing Vault requests.
|
657 |
+
#
|
658 |
+
# - If you want NPCs to have the same permissions as "normal" players, set this option to false.
|
659 |
+
# - If you want NPCs to have OP status, set this option to true.
|
660 |
+
vault-npc-op-status: false
|
661 |
+
|
662 |
+
# If the vault-server option below should be used.
|
663 |
+
#
|
664 |
+
# - When this option is set to false, the server value defined above under "server" is used.
|
665 |
+
use-vault-server: false
|
666 |
+
|
667 |
+
# The name of the server used within Vault operations.
|
668 |
+
#
|
669 |
+
# - If you don't want Vault operations to be server specific, set this to "global".
|
670 |
+
# - Will only take effect if use-vault-server is set to true above.
|
671 |
+
vault-server: global
|
672 |
+
|
673 |
+
# If global permissions should be considered when retrieving meta or player groups
|
674 |
+
vault-include-global: true
|
675 |
+
|
676 |
+
# If Vault operations should ignore any world arguments if supplied.
|
677 |
+
vault-ignore-world: false
|
678 |
+
|
679 |
+
# +----------------------------------------------------------------------------------------------+ #
|
680 |
+
# | Miscellaneous (and rarely used) settings | #
|
681 |
+
# +----------------------------------------------------------------------------------------------+ #
|
682 |
+
|
683 |
+
# If LuckPerms should produce extra logging output when it handles logins.
|
684 |
+
#
|
685 |
+
# - Useful if you're having issues with UUID forwarding or data not being loaded.
|
686 |
+
debug-logins: false
|
687 |
+
|
688 |
+
# If LuckPerms should allow usernames with non alphanumeric characters.
|
689 |
+
#
|
690 |
+
# - Note that due to the design of the storage implementation, usernames must still be 16 characters
|
691 |
+
# or less.
|
692 |
+
allow-invalid-usernames: false
|
693 |
+
|
694 |
+
# If LuckPerms should not require users to confirm bulkupdate operations.
|
695 |
+
#
|
696 |
+
# - When set to true, operations will be executed immediately.
|
697 |
+
# - This is not recommended, as bulkupdate has the potential to irreversibly delete large amounts of
|
698 |
+
# data, and is not designed to be executed automatically.
|
699 |
+
# - If automation is needed, users should prefer using the LuckPerms API.
|
700 |
+
skip-bulkupdate-confirmation: false
|
701 |
+
|
702 |
+
# If LuckPerms should prevent bulkupdate operations.
|
703 |
+
#
|
704 |
+
# - When set to true, bulkupdate operations (the /lp bulkupdate command) will not work.
|
705 |
+
# - When set to false, bulkupdate operations will be allowed via the console.
|
706 |
+
disable-bulkupdate: false
|
707 |
+
|
708 |
+
# If LuckPerms should allow a users primary group to be removed with the 'parent remove' command.
|
709 |
+
#
|
710 |
+
# - When this happens, the plugin will set their primary group back to default.
|
711 |
+
prevent-primary-group-removal: false
|
712 |
+
|
713 |
+
# If LuckPerms should update the list of commands sent to the client when permissions are changed.
|
714 |
+
update-client-command-list: true
|
715 |
+
|
716 |
+
# If LuckPerms should attempt to register "Brigadier" command list data for its commands.
|
717 |
+
register-command-list-data: true
|
718 |
+
|
719 |
+
# If LuckPerms should attempt to resolve Vanilla command target selectors for LP commands.
|
720 |
+
# See here for more info: https://minecraft.wiki/w/Target_selectors
|
721 |
+
resolve-command-selectors: false
|