· 5 years ago · Sep 25, 2020, 01:38 AM
1####################################################################################################
2# +----------------------------------------------------------------------------------------------+ #
3# | __ __ ___ __ __ | #
4# | | | | / ` |__/ |__) |__ |__) |\/| /__` | #
5# | |___ \__/ \__, | \ | |___ | \ | | .__/ | #
6# | | #
7# | https://luckperms.net | #
8# | | #
9# | SOURCE CODE: https://github.com/lucko/LuckPerms | #
10# | WIKI: https://github.com/lucko/LuckPerms/wiki | #
11# | BUG REPORTS: https://github.com/lucko/LuckPerms/issues | #
12# | | #
13# | Each option in this file is documented and explained here: | #
14# | ==> https://github.com/lucko/LuckPerms/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://github.com/lucko/LuckPerms/wiki/Context
34server: 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.
44use-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://github.com/lucko/LuckPerms/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.
86storage-method: MySQL
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.
92data:
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:
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
106
107 # These settings apply to the MySQL connection pool.
108 # - The default values will be suitable for the majority of users.
109 # - Do not change these settings unless you know what you're doing!
110 pool-settings:
111
112 # Sets the maximum size of the MySQL connection pool.
113 # - Basically this value will determine the maximum number of actual
114 # connections to the database backend.
115 # - More information about determining the size of connection pools can be found here:
116 # https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
117 maximum-pool-size: 10
118
119 # Sets the minimum number of idle connections that the pool will try to maintain.
120 # - For maximum performance and responsiveness to spike demands, it is recommended to not set
121 # this value and instead allow the pool to act as a fixed size connection pool.
122 # (set this value to the same as 'maximum-pool-size')
123 minimum-idle: 10
124
125 # This setting controls the maximum lifetime of a connection in the pool in milliseconds.
126 # - The value should be at least 30 seconds less than any database or infrastructure imposed
127 # connection time limit.
128 maximum-lifetime: 1800000 # 30 minutes
129
130 # This setting controls the maximum number of milliseconds that the plugin will wait for a
131 # connection from the pool, before timing out.
132 connection-timeout: 5000 # 5 seconds
133
134 # This setting allows you to define extra properties for connections.
135 #
136 # By default, the following options are set to enable utf8 encoding. (you may need to remove
137 # these if you are using PostgreSQL)
138 # useUnicode: true
139 # characterEncoding: utf8
140 #
141 # You can also use this section to disable SSL connections, by uncommenting the 'useSSL' and
142 # 'verifyServerCertificate' options below.
143 properties:
144 useUnicode: true
145 characterEncoding: utf8
146 #useSSL: false
147 #verifyServerCertificate: false
148
149 # The prefix for all LuckPerms SQL tables.
150 # - Change this if you want to use different tables for different servers.
151 table-prefix: 'luckperms_'
152
153 # The prefix to use for all LuckPerms collections. Change this if you want to use different
154 # collections for different servers. The default is no prefix.
155 mongodb-collection-prefix: ''
156
157 # MongoDB ClientConnectionURI for use with replica sets and custom connection options
158 # - See https://docs.mongodb.com/manual/reference/connection-string/
159 mongodb-connection-uri: ''
160
161# Define settings for a "split" storage setup.
162#
163# - This allows you to define a storage method for each type of data.
164# - The connection options above still have to be correct for each type here.
165split-storage:
166 # Don't touch this if you don't want to use split storage!
167 enabled: false
168 methods:
169 # These options don't need to be modified if split storage isn't enabled.
170 user: h2
171 group: h2
172 track: h2
173 uuid: h2
174 log: h2
175
176
177
178
179# +----------------------------------------------------------------------------------------------+ #
180# | | #
181# | UPDATE PROPAGATION & MESSAGING SERVICE | #
182# | | #
183# | Controls the ways in which LuckPerms will sync data & notify other servers of changes. | #
184# | These options are documented on greater detail on the wiki under "Instant Updates". | #
185# | | #
186# +----------------------------------------------------------------------------------------------+ #
187
188# This option controls how frequently LuckPerms will perform a sync task.
189#
190# - A sync task will refresh all data from the storage, and ensure that the most up-to-date data is
191# being used by the plugin.
192# - This is disabled by default, as most users will not need it. However, if you're using a remote
193# storage type without a messaging service setup, you may wish to set this to something like 3.
194# - Set to -1 to disable the task completely.
195sync-minutes: -1
196
197# If the file watcher should be enabled.
198#
199# - When using a file-based storage type, LuckPerms can monitor the data files for changes, and
200# automatically update when changes are detected.
201# - If you don't want this feature to be active, set this option to false.
202watch-files: true
203
204# Define which messaging service should be used by the plugin.
205#
206# - If enabled and configured, LuckPerms will use the messaging service to inform other connected
207# servers of changes.
208# - Use the command "/lp networksync" to manually push changes.
209# - Data is NOT stored using this service. It is only used as a messaging platform.
210#
211# - If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need
212# for LuckPerms to poll the database for changes.
213#
214# - Possible options:
215# => sql Uses the SQL database to form a queue system for communication. Will only work when
216# 'storage-method' is set to MySQL or MariaDB. This is chosen by default if the
217# option is set to 'auto' and SQL storage is in use. Set to 'notsql' to disable this.
218# => pluginmsg Uses the plugin messaging channels to communicate with the proxy.
219# LuckPerms must be installed on your proxy & all connected servers backend servers.
220# Won't work if you have more than one proxy.
221# => lilypad Uses LilyPad pub-sub to push changes. You need to have the LilyPad-Connect plugin
222# installed.
223# => redis Uses Redis pub-sub to push changes. Your server connection info must be configured
224# below.
225# => auto Attempts to automatically setup a messaging service using redis or sql.
226messaging-service: sql
227
228# If LuckPerms should automatically push updates after a change has been made with a command.
229auto-push-updates: true
230
231# If LuckPerms should push logging entries to connected servers via the messaging service.
232push-log-entries: true
233
234# If LuckPerms should broadcast received logging entries to players on this platform.
235#
236# - If you have LuckPerms installed on your backend servers as well as a BungeeCord proxy, you
237# should set this option to false on either your backends or your proxies, to avoid players being
238# messaged twice about log entries.
239broadcast-received-log-entries: true
240
241# Settings for Redis.
242# Port 6379 is used by default; set address to "host:port" if differs
243redis:
244 enabled: false
245 address: localhost
246 password: ''
247
248
249
250
251# +----------------------------------------------------------------------------------------------+ #
252# | | #
253# | CUSTOMIZATION SETTINGS | #
254# | | #
255# | Settings that allow admins to customize the way LuckPerms operates. | #
256# | | #
257# +----------------------------------------------------------------------------------------------+ #
258
259# Controls how temporary permissions/parents/meta should be accumulated.
260#
261# - The default behaviour is "deny".
262# - This behaviour can also be specified when the command is executed. See the command usage
263# documentation for more info.
264#
265# - Possible options:
266# => accumulate durations will be added to the existing expiry time
267# => replace durations will be replaced if the new duration is later than the current
268# expiration
269# => deny the command will just fail if you try to add another node with the same expiry
270temporary-add-behaviour: deny
271
272# Controls how LuckPerms will determine a users "primary" group.
273#
274# - The meaning and influence of "primary groups" are explained in detail on the wiki.
275# - The preferred approach is to let LuckPerms automatically determine a users primary group
276# based on the relative weight of their parent groups.
277#
278# - Possible options:
279# => stored use the value stored against the users record in the file/database
280# => parents-by-weight just use the users most highly weighted parent
281# => all-parents-by-weight same as above, but calculates based upon all parents inherited from
282# both directly and indirectly
283primary-group-calculation: parents-by-weight
284
285# If the plugin should check for "extra" permissions with users run LP commands.
286#
287# - These extra permissions allow finer control over what users can do with each command, and who
288# they have access to edit.
289# - The nature of the checks are documented on the wiki under "Argument based command permissions".
290# - Argument based permissions are *not* static, unlike the 'base' permissions, and will depend upon
291# the arguments given within the command.
292argument-based-command-permissions: false
293
294# If the plugin should check whether senders are a member of a given group before they're able to
295# edit the groups data or add/remove other users to/from it.
296# Note: these limitations do not apply to the web editor!
297require-sender-group-membership-to-modify: false
298
299# If the plugin should send log notifications to users whenever permissions are modified.
300#
301# - Notifications are only sent to those with the appropriate permission to receive them
302# - They can also be temporarily enabled/disabled on a per-user basis using
303# '/lp log notify <on|off>'
304log-notify: true
305
306# Defines a list of log entries which should not be sent as notifications to users.
307#
308# - Each entry in the list is a RegEx expression which is matched against the log entry description.
309log-notify-filtered-descriptions:
310# - "parent add example"
311
312# Defines the options for prefix and suffix stacking.
313#
314# - The feature allows you to display multiple prefixes or suffixes alongside a players username in
315# chat.
316# - It is explained and documented in more detail on the wiki under "Prefix & Suffix Stacking".
317#
318# - The options are divided into separate sections for prefixes and suffixes.
319# - The 'duplicates' setting refers to how duplicate elements are handled. Can be 'retain-all',
320# 'first-only' or 'last-only'.
321# - The value of 'start-spacer' is included at the start of the resultant prefix/suffix.
322# - The value of 'end-spacer' is included at the end of the resultant prefix/suffix.
323# - The value of 'middle-spacer' is included between each element in the resultant prefix/suffix.
324#
325# - Possible format options:
326# => highest Selects the value with the highest weight, from all values
327# held by or inherited by the player.
328#
329# => lowest Same as above, except takes the one with the lowest weight.
330#
331# => highest_own Selects the value with the highest weight, but will not
332# accept any inherited values.
333#
334# => lowest_own Same as above, except takes the value with the lowest weight.
335#
336# => highest_inherited Selects the value with the highest weight, but will only
337# accept inherited values.
338#
339# => lowest_inherited Same as above, except takes the value with the lowest weight.
340#
341# => highest_on_track_<track> Selects the value with the highest weight, but only if the
342# value was inherited from a group on the given track.
343#
344# => lowest_on_track_<track> Same as above, except takes the value with the lowest weight.
345#
346# => highest_not_on_track_<track> Selects the value with the highest weight, but only if the
347# value was inherited from a group not on the given track.
348#
349# => lowest_not_on_track_<track> Same as above, except takes the value with the lowest weight.
350#
351# => highest_from_group_<group> Selects the value with the highest weight, but only if the
352# value was inherited from the given group.
353#
354# => lowest_from_group_<group> Same as above, except takes the value with the lowest weight.
355#
356# => highest_not_from_group_<group> Selects the value with the highest weight, but only if the
357# value was not inherited from the given group.
358#
359# => lowest_not_from_group_<group> Same as above, except takes the value with the lowest weight.
360meta-formatting:
361 prefix:
362 format:
363 - "highest_from_group_owner"
364 - "highest_on_track_rankup"
365
366
367
368 duplicates: first-only
369 start-spacer: ""
370 middle-spacer: " "
371 end-spacer: ""
372 suffix:
373 format:
374 duplicates: first-only
375 start-spacer: ""
376 middle-spacer: " "
377 end-spacer: ""
378
379
380
381
382# +----------------------------------------------------------------------------------------------+ #
383# | | #
384# | PERMISSION CALCULATION AND INHERITANCE | #
385# | | #
386# | Modify the way permission checks, meta lookups and inheritance resolutions are handled. | #
387# | | #
388# +----------------------------------------------------------------------------------------------+ #
389
390# The algorithm LuckPerms should use when traversing the "inheritance tree".
391#
392# - Possible options:
393# => breadth-first See: https://en.wikipedia.org/wiki/Breadth-first_search
394# => depth-first-pre-order See: https://en.wikipedia.org/wiki/Depth-first_search
395# => depth-first-post-order See: https://en.wikipedia.org/wiki/Depth-first_search
396inheritance-traversal-algorithm: depth-first-pre-order
397
398# If a final sort according to "inheritance rules" should be performed after the traversal algorithm
399# has resolved the inheritance tree.
400#
401# "Inheritance rules" refers to things such as group weightings, primary group status, and the
402# natural contextual ordering of the group nodes.
403#
404# Setting this to 'true' will allow for the inheritance rules to take priority over the structure of
405# the inheritance tree.
406#
407# Effectively when this setting is 'true': the tree is flattened, and rules applied afterwards,
408# and when this setting is 'false':, the rules are just applied during each step of the traversal.
409post-traversal-inheritance-sort: false
410
411# Defines the mode used to determine whether a set of contexts are satisfied.
412#
413# - Possible options:
414# => at-least-one-value-per-key Set A will be satisfied by another set B, if at least one of the
415# key-value entries per key in A are also in B.
416# => all-values-per-key Set A will be satisfied by another set B, if all key-value
417# entries in A are also in B.
418context-satisfy-mode: at-least-one-value-per-key
419
420# +----------------------------------------------------------------------------------------------+ #
421# | Permission resolution settings | #
422# +----------------------------------------------------------------------------------------------+ #
423
424# If users on this server should have their global permissions applied.
425# When set to false, only server specific permissions will apply for users on this server
426include-global: true
427
428# If users on this server should have their global world permissions applied.
429# When set to false, only world specific permissions will apply for users on this server
430include-global-world: true
431
432# If users on this server should have global (non-server specific) groups applied
433apply-global-groups: true
434
435# If users on this server should have global (non-world specific) groups applied
436apply-global-world-groups: true
437
438# +----------------------------------------------------------------------------------------------+ #
439# | Meta lookup settings | #
440# +----------------------------------------------------------------------------------------------+ #
441
442# Defines how meta values should be selected.
443#
444# - Possible options:
445# => inheritance Selects the meta value that was inherited first
446# => highest-number Selects the highest numerical meta value
447# => lowest-number Selects the lowest numerical meta value
448meta-value-selection-default: inheritance
449
450# Defines how meta values should be selected per key.
451meta-value-selection:
452# max-homes: highest-number
453
454# +----------------------------------------------------------------------------------------------+ #
455# | Inheritance settings | #
456# +----------------------------------------------------------------------------------------------+ #
457
458# If the plugin should apply wildcard permissions.
459#
460# - If set to true, LuckPerms will detect wildcard permissions, and resolve & apply all registered
461# permissions matching the wildcard.
462apply-wildcards: true
463
464# If LuckPerms should resolve and apply permissions according to the Sponge style implicit wildcard
465# inheritance system.
466#
467# - That being: If a user has been granted "example", then the player should have also be
468# automatically granted "example.function", "example.another", "example.deeper.nesting",
469# and so on.
470apply-sponge-implicit-wildcards: false
471
472# If the plugin should parse regex permissions.
473#
474# - If set to true, LuckPerms will detect regex permissions, marked with "r=" at the start of the
475# node, and resolve & apply all registered permissions matching the regex.
476apply-regex: true
477
478# If the plugin should complete and apply shorthand permissions.
479#
480# - If set to true, LuckPerms will detect and expand shorthand node patterns.
481apply-shorthand: true
482
483# If the plugin should apply Bukkit child permissions.
484#
485# - Plugin authors can define custom permissions structures for their plugin, which will be resolved
486# and used by LuckPerms if this setting is enabled.
487apply-bukkit-child-permissions: true
488
489# If the plugin should apply Bukkit default permissions.
490#
491# - Plugin authors can define permissions which should be given to all users by default, or setup
492# permissions which should/shouldn't be given to opped players.
493# - If this option is set to false, LuckPerms will ignore these defaults.
494apply-bukkit-default-permissions: true
495
496# If the plugin should apply attachment permissions.
497#
498# - Other plugins on the server are able to add their own "permission attachments" to players.
499# - This allows them to grant players additional permissions which last until the end of the
500# session, or until they're removed.
501# - If this option is set to false, LuckPerms will not include these attachment permissions when
502# considering if a player should have access to a certain permission.
503apply-bukkit-attachment-permissions: true
504
505# +----------------------------------------------------------------------------------------------+ #
506# | Extra settings | #
507# +----------------------------------------------------------------------------------------------+ #
508
509# Allows you to set "aliases" for the worlds sent forward for context calculation.
510#
511# - These aliases are provided in addition to the real world name. Applied recursively.
512# - Remove the comment characters for the default aliases to apply.
513world-rewrite:
514# world_nether: world
515# world_the_end: world
516
517# Define special group weights for this server.
518#
519# - Group weights can also be applied directly to group data, using the setweight command.
520# - This section allows weights to be set on a per-server basis.
521group-weight:
522# admin: 10
523
524
525
526
527# +----------------------------------------------------------------------------------------------+ #
528# | | #
529# | FINE TUNING OPTIONS | #
530# | | #
531# | A number of more niche settings for tweaking and changing behaviour. The section also | #
532# | contains toggles for some more specialised features. It is only necessary to make changes to | #
533# | these options if you want to fine-tune LuckPerms behaviour. | #
534# | | #
535# +----------------------------------------------------------------------------------------------+ #
536
537# +----------------------------------------------------------------------------------------------+ #
538# | Server Operator (OP) settings | #
539# +----------------------------------------------------------------------------------------------+ #
540
541# Controls whether server operators should exist at all.
542#
543# - When set to 'false', all players will be de-opped, and the /op and /deop commands will be
544# disabled.
545enable-ops: true
546
547# Enables or disables a special permission based system in LuckPerms for controlling OP status.
548#
549# - If set to true, any user with the permission "luckperms.autoop" will automatically be granted
550# server operator status. This permission can be inherited, or set on specific servers/worlds,
551# temporarily, etc.
552# - Additionally, setting this to true will force the "enable-ops" option above to false. All users
553# will be de-opped unless they have the permission node, and the op/deop commands will be
554# disabled.
555# - It is recommended that you use this option instead of assigning a single '*' permission.
556auto-op: false
557
558# Defines if "opped" players should be able to use all LuckPerms commands by default.
559#
560# - Set to false to only allow users who have the permissions access to the commands
561commands-allow-op: true
562
563# +----------------------------------------------------------------------------------------------+ #
564# | Vault integration settings | #
565# +----------------------------------------------------------------------------------------------+ #
566
567# If Vault lookups for offline players on the main server thread should be enabled.
568#
569# LuckPerms has a "catch" for plugins attempting to perform unsafe offline player data lookups
570# from the main server thread. This catch raises an exception (causes an error to occur) when unsafe
571# lookups are made, instead of allowing the lookup to happen, which would likely cause the server
572# to lag.
573#
574# However, if you're willing to accept the consequences, the catch can be disabled by setting this
575# option to 'true.
576vault-unsafe-lookups: false
577
578# Controls which group LuckPerms should use for NPC players when handling Vault requests.
579#
580# - As NPCs aren't actually real players, LuckPerms does not load any user data for them. This
581# becomes an issue when plugins want to check for their permissions using Vault.
582# - As a solution, Vault checks for NPCs fallback to a group, which is defined below.
583vault-npc-group: default
584
585# Controls how LuckPerms should consider the OP status of NPC players when handing Vault requests.
586#
587# - If you want NPCs to have the same permissions as "normal" players, set this option to false.
588# - If you want NPCs to have OP status, set this option to true.
589vault-npc-op-status: false
590
591# If the vault-server option below should be used.
592#
593# - When this option is set to false, the server value defined above under "server" is used.
594use-vault-server: false
595
596# The name of the server used within Vault operations.
597#
598# - If you don't want Vault operations to be server specific, set this to "global".
599# - Will only take effect if use-vault-server is set to true above.
600vault-server: global
601
602# If global permissions should be considered when retrieving meta or player groups
603vault-include-global: true
604
605# If Vault operations should ignore any world arguments if supplied.
606vault-ignore-world: false
607
608# +----------------------------------------------------------------------------------------------+ #
609# | Miscellaneous (and rarely used) settings | #
610# +----------------------------------------------------------------------------------------------+ #
611
612# If LuckPerms should produce extra logging output when it handles logins.
613#
614# - Useful if you're having issues with UUID forwarding or data not being loaded.
615debug-logins: false
616
617# If LuckPerms should allow usernames with non alphanumeric characters.
618#
619# - Note that due to the design of the storage implementation, usernames must still be 16 characters
620# or less.
621allow-invalid-usernames: false
622
623# If LuckPerms should allow a users primary group to be removed with the 'parent remove' command.
624#
625# - When this happens, the plugin will set their primary group back to default.
626prevent-primary-group-removal: false
627
628# If LuckPerms should update the list of commands sent to the client when permissions are changed.
629update-client-command-list: true
630
631# If LuckPerms should attempt to resolve Vanilla command target selectors for LP commands.
632# See here for more info: https://minecraft.gamepedia.com/Commands#Target_selectors
633resolve-command-selectors: false