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