-
Notifications
You must be signed in to change notification settings - Fork 59
/
Copy pathconfig.yml
1554 lines (1305 loc) · 61.5 KB
/
config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
#|+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#| |#
#| ██ ██ ██ ███ ██ ██████ ██████ ██████ ███ ███ ███████ |#
#| ██ ██ ██ ████ ██ ██ ██ ██ ██ ██ ████ ████ ██ |#
#| █████ ██ ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ ████ ██ ███████ |#
#| ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ |#
#| ██ ██ ██ ██ ████ ██████ ██████ ██████ ██ ██ ███████ |#
#| |#
#|+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
# All the configuration files will be automatically reloaded after
# they're reloaded without using /k reload
# There are other configuration files other than this file.
# This is the main configuration relating to most basic features.
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
#| |#
#| SpigotMC: https://www.spigotmc.org/resources/77670/ |#
#| Wiki: https://www.github.com/CryptoMorin/KingdomsX/wiki |#
#| Discord: https://www.discord.gg/cKsSwtt |#
#| |#
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
#|++++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#| Essentials |#
#|++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
# Should the plugin use a prefix for every message (except chats of course)?
# A prefix like "[Kingdoms]" is added so players know that the message came from Kingdoms plugin.
# The prefix is configurable in the language file of each language.
# If this is set to false, you can use "PREFIX|" at the beginning of the messages to include the prefix regardless.
# If this is set to true, you can use "NOPREFIX|" at the beginning of the messages to exclude the prefix regardless.
# Prefixes are not shown for Complex Messages by default even if this option is enabled.
prefix: false
# For error profiling reasons. Is extremely spammy and shows messages
# that are usually not needed. It also shows some errors relating
# to server connection issues. Can possibly expose leaks in external databases.
# Requires a restart to apply.
debug: false
updates:
# Check for plugin updates from Spigot when server starts
# and when players with kingdoms.updates permission join the server.
# This will not report anything to players if no new versions are found.
# This will also cache the results from when the server started.
# If you set this to false, you can still check for updates using /k updates command.
check: true
# Should the plugin automatically download updates to the specified path?
# Please also read the path option if you want to change this option.
# This is not recommended for servers in production
# if you set the option below to automatically replace the
# JAR for you, as some builds contain massive changes
# which can lead to some unexpected behaviours.
download: false
# The starting directory is the plugin's folder.
# Any folders that are not found in the specified path will be created.
# Placeholders that can be used are %version% and %latest_version%
# Now you might be asking why would you need to use the current version?
# The "update" folder in "plugins" folder (the folder name can be changed in bukkit.yml) is used to
# automatically replace any JARs in that folder with the JARs in "plugins" folder that have the same name.
# Now, because the plugin JAR name format is "name-version", this name must be
# the same as the plugin name in the "plugins" folder.
# So if you want your server to automatically update the plugin for you after downloading it,
# you have to use the current version. The only bad thing is, you'll confuse the versions of course.
path: '../update/Kingdoms-%latest_version%.jar'
# Automatically updates configs.
# READ BEFORE ENABLING: https://github.com/CryptoMorin/KingdomsX/wiki/Features#auto-config-updater
# THIS IS AN EXPERIMENTAL FEATURE. ENABLE WITH CARE. ANYTHING CAN GO WRONG SILENTLY WITH THIS, MAKE SURE YOU HAVE BACKUPS ENABLED.
configs: false
# This is an experimental feature.
# When using Kingdoms as an international plugin, updating GUI files will get troublesome
# as they have other non-translatable properties such as slots, material etc.
# When you decide to change the GUI layout for any GUI, you'd have to go to the
# GUI config of all languages to update the layout as well. To make this simpler,
# enabling this will allow you to synchronize non-translatable options across all
# GUIs in other languages when they're changed.
# You can also write "-NOSYNC" at the beginning of a comment of a YAML option to
# exclude that option from being synchronized. This is used for advanced translatable
# properties (such as commands or yaml functions)
synchronize-guis:
# This only works when you edit the GUIs while the server is running,
# and you have automatic config reloads enabled (unless you want to use the option below).
# The reference language used for automatic config reloads isn't the language specified below,
# but the language that the admin is currently editing.
automatic: false
# This only works if the option above is enabled.
# Setting this option to a language name will make the plugin synchronize
# GUIs automatically when starting the server and using /k reload
reference-language: ~
# Automatically reload configs which is more efficient than /k reload.
# The only reason you might not want this, is because this feature might not work properly for your environment setup.
# For more information read: https://github.com/CryptoMorin/KingdomsX/wiki/Installation#reloading
# Requires a restart to work.
automatic-config-reloads: true
# The default language. Since the plugin is international, this is only used if the plugin doens't
# support the detected language on the player's client. It's also used for console commands.
# Place your translated file in the plugin's folder.
# The file's name should be the same as the option below without the .yml file extension.
# Some of these language files are outdated.
# GUIs also have their own language file which can be found in the "guis" folder.
# Standard way of naming this is to follow IETF language tags.
# from IETF (https://en.wikipedia.org/wiki/IETF_language_tag)
# All the language files are made by the community, they're not guaranteed to be 100% accurate and complete.
# For technical info see: https://www.w3.org/International/articles/language-tags/ and https://www.rfc-editor.org/rfc/rfc5646.html#page-5
# Please refer to https://github.com/CryptoMorin/KingdomsX/wiki/Config#language-file if you want to translate the plugin.
# If you translated the plugin you can contact me, and I'll add it to the plugin.
# If you translated a language that wasn't supported in the plugin before, In order for the international
# function of the plugin to work, you actually need to submit your translation for
# it to be directly added to the plugin, otherwise players wouldn't be able to use your translation.
# Available Languages: https://github.com/CryptoMorin/KingdomsX/tree/master/resources/languages
lang: en
# Disables language detection for new players and uses the language specified above.
force-lang: false
# Most of the options require a restart to be changed.
# Kingdom backups are taken with the best possible compression method available in the system. (speed < file size)
# The files are saved with the name as the current date in a "zip" extension
# (the extension has nothing to do with the compression method used)
# To restore a backup, simply stop the server, unarchive the files that you need to restore and start the files again.
backups:
# By default, backups are taken every day. Specifically every time when the server
# starts it checks if backups are taken for that day and waits another 24 hours.
# It supports time suffixes for the file names.
interval: 24hrs
enabled:
# Should backups be taken at all?
enabled: true
# Data files include kingdoms, players, lands, nations and mails.
data: true
# Chunk snapshots are only taken when restoration is enabled in claims.yml
# It's not recommended to backup these files as they can take a lot of space on big servers.
chunk-snapshots: false
# Includes the main configs, language files, and guis.
# Doesn't include the repository, since they shouldn't be changed.
configs: true
# The path relative to the Kingdoms plugin folder. Either separated with slashes / or backspaces \
folder: 'Backups'
# If this is enabled then every time the server is restarted
# it'll take a backup without considering if there's already
# a backup taken for today (without overwriting the previous one.)
ignore-todays-backup: false
# Deletes backups automatically that are older than this amount of days.
# Set to 0 to disable.
delete-backups-older-than: 30
database:
# How the plugin should store data.
#
# - Possible options:
#
# | Remote databases - require connection information to be configured below
# |=> PostgreSQL (best for large servers)
# |=> MariaDB (preferred over MySQL)
# |=> MySQL
# |=> MongoDB
#
# | Flatfile/local database - don't require any extra configuration
# |=> H2 (preferred over SQLite)
# |=> SQLite
#
# | Readable & editable text files - don't require any extra configuration
# | These databases are not recommended for live servers.
# |=> YAML (.yml files)
# |=> JSON (.json files)
#
# For some reason this section of the config looks familiar...
# It's as if it was copied pasted from somewhere. Hmmm...
#
# Troubleshooting: https://github.com/CryptoMorin/KingdomsX/wiki/FAQ#external-databases
method: H2
# The interval in seconds that the auto-saver should
# save data to the database. It's recommneded to keep
# it what it is, but if you have a larger server it'd be
# better to use a higher number.
# Supports time suffix, default is seconds.
# The cache expiration time is calculated by multiplying the auto-save interval by 2
# because if the cache expires faster than it can be saved, data will be lost.
auto-save-interval: 30mins
# DO NOT touch this unless you know what you're doing.
# Smart save uses a compressed data and compares it before saving to the file.
# If this compressed data indicates tha the data doesn't need to be saved, it'll
# save the server some IO operation which improves the performance.
smart-save: true
# DO NOT CHANGE - because you mostly have no idea how it can break things even after you read below.
# If you're a big network you should turn this off unless you have a lot of RAM as this option will cause all data to NOT expire.
# If you disable this, daily check interval (which includes taxes, top kingdom rewards and ...) and /k top will not work.
# Other functions that require a kingdom name will also not work.
load-all-data-on-startup: true
# Puts all the data in a folder named "data"
# Set to ~ to put everything in the main kingdoms folder.
### !!! WARNING !!! ###
# When you change this option you have to move the folders manually yourself.
# Setting this to "false" explicitly is not supported and this option will be removed in future relases.
### !!! WARNING !!! ###
use-data-folder: true
# The prefix appended to all tables.
# This prefix is automatically followed by an underscore separator.
# This is also used for MongoDB's collection prefix.
table-prefix: "kingdoms"
# Folder names for local databases.
# For external databases, these names aren't used.
tables:
nations: Nations
kingdoms: Kingdoms
players: Players
lands: Lands
mails: Mails
# Define the address and port for the database.
# - The standard DB engine port is used by default (MySQL & MariaDB: 3306, PostgreSQL: 5432, MongoDB: 27017)
# - Specify as "host:port" if differs.
# - Sometimes, depending on your system and the database, using "localhost" can be problematic
# as it maps to ::1 instead of 127.0.0.1, so you might want to specify it precisely.
address: localhost
# The name of the database to store Kingdoms data in, when using external databases.
# WARNING: This database must be already created manually if you're not using MongoDB.
database: minecraft
# Credentials for external databases.
username: root
password: ''
# The full connection string URI to use to connect to the MongoDB instance.
#
# - When configured, this setting will override anything defined in the address, database,
# username or password fields above.
# - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it below.
# - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/
# - For more information about the port and address see the "address" option above.
uri: ''
# These settings apply to SQL databases.
# The default values will be suitable for the majority of users.
# Do not change these settings unless you know what you're doing!
pool-settings:
size:
# Sets the maximum size of the MySQL connection pool.
# - Basically this value will determine the maximum number of actual
# connections to the database backend.
# - More information about determining the size of connection pools can be found here:
# https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
max: 10
# The minimum number of connections. Those connections will be kept in the pool when idle,
# and the pool will ensure that it contains at least this minimum number.
# The distinction between this option and minimum-idle is only supported by MongoDB.
min: 0
# The maximum number of connections a pool may be establishing concurrently.
# This is only supported by MongoDB.
# https://github.com/brettwooldridge/HikariCP/issues/1877
max-concurrent-connections: 2
# Sets the minimum number of idle connections that the pool will try to maintain.
# - For maximum performance and responsiveness to spike demands, it is recommended to not set
# this value and instead allow the pool to act as a fixed size connection pool.
# (set this value to the same as 'size -> max')
minimum-idle: 10
# This setting controls the maximum lifetime of a connection in the pool.
# - The value should be at least 30 seconds less than any database or infrastructure imposed
# connection time limit.
# - Known issues: https://github.com/brettwooldridge/HikariCP/pull/1594
# - MariaDB wait_timeout: https://mariadb.com/docs/server/ref/mdb/system-variables/wait_timeout/
maximum-lifetime: 30 minutes
# This setting controls how frequently the pool will 'ping' a connection in order to prevent it
# from being timed out by the database or network infrastructure.
# - The value should be less than maximum-lifetime and greater than 30000 (30 seconds).
# - Setting the value to zero will disable the keepalive functionality.
keepalive-time: 0
# This setting controls the maximum time that the plugin will wait for a
# connection from the pool, before timing out.
connection-timeout: 5 seconds
ssl:
# Enable SSL connections. It's not recommended to disable it.
enabled: true
# Whether invalid host names should be allowed.
# Take care before setting this to false, as it makes the application susceptible to man-in-the-middle attacks.
verify-server-certificate: true
# Set this value to true if you're getting errors about the plugin not being able to retrieve public keys.
# This only happens for MySQL or MariaDB. Alternatively, you can disable SSL.
allow-public-key-retrieval: false
# This setting allows you to define extra properties for SQL connections.
#
# By default, the following options are set to enable utf8 encoding.
# useUnicode: true
# characterEncoding: utf8
properties:
useUnicode: yes
# MongoDB's BSON can only be encoded with UTF8, so this setting doesn't affect MongoDB.
characterEncoding: UTF-8
# Worlds that this plugin is disabled in.
# This is more about performance. Most components of the plugin
# will stay active such as chat, commands and permissions.
# For disabling claims in certain worlds, refer to claims.yml
disabled-worlds: [ ]
# If false, disables admin mode after admins leave the server.
# This option is for security purposes.
keep-admin-mode: false
# The rate which the plugin updates holograms. These include turrets and structures.
# The update is in ticks and is done asynchrously. This is useful for displaying turret
# ammo, structure fuel, etc. i.e. information that are constantly updating.
# You should consider keeping this value above one second.
# A reasonable value would be 200 which means every 10 seconds.
# Consider applying "dont-update-holograms: true" to turrets/structures that have no variable
# in their holograms that needs updating to optimize this feature.
# Set to 0 to disable.
# Requires a restart to be applied.
hologram-update-ticks: 200
# Disables integration service for one of the following plugins.
# Requires a restart to take effect.
# https://github.com/CryptoMorin/KingdomsX/wiki/Installation#compatibility
integrations:
citizens: true # Unused
placeholderapi: true
mvdwplaceholderapi: true
# Map Viewer Addon
bluemap: true
dynmap: true
squaremap: true
pl3xmap: true
luckperms: true
vault: true
world-guard: true
world-edit: true
essentials: true
cmi: true
mythic-mobs: true
my-pet: true
auth-me: true
discordsrv: true
slimefun: true
project-korra: true
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
#|++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#| Commands |#
#|++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++|#
#|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|#
# The options for the base command.
command:
# These two options require a server restart to update.
# Should the plugin not use colors for command tab completion suggestions?
# It's recommended to keep this off, because right now, if players auto complete
# a tab suggestion that contains colors, it will put the text with the transated §
# codes, and since the client can't normally type that symbol into the chat, it'll
# kick them out of the server if they run the command like that with the message "Illegal characters in chat"
# This option only works for 1.13+ servers.
enable-tab-colorization: false
# You should usually choose the most obvious yet concise name for
# the main name, some plugins might use it.
name: kingdoms
aliases: [ kingdom, xkingdoms, kingdomsx, k ]
commands:
### Properties ###
# disabled: If this command should be completely disabled or not. Disabling command groups will disable all its subcommands.
# cooldown: The cooldown of the command whether the result was successful or not. Refer to the wiki to see time value formats.
# Sometimes there are cooldowns for certain commands that are more suitable based on certain situations in other configs.
# Note that these cooldowns do not persist between server restarts.
# diasbled-worlds: A list of world names that this command is disabled in.
# If any of these properties are not defined, the defaults will be used which are:
# disabled: false
# cooldown: 0
# disabled-worlds: []
# To edit the command names and aliases refer to your language file.
# You cannot move the position of command arguments or change their group/parent
# However you can add shortcut commands for them like "/nexus" for "/k nexus" through the config.yml
# found in your server's root folder (where your spigot.yml is).
# You need to /k reload for the following settings to take effect.
# Examples:
help:
disabled: false
cooldown: 0
disabled-worlds: [ ]
fly:
disabled: false
nation:
disabled: false
resourcepoints:
commands: # Sub-commands require their commands to be defined in a section called "commands"
withdraw:
disabled: false
deposit:
disabled: false
# /k help
help:
# The order of commands which appear in pages. If the player doesn't have the permission for a particular command
# that command is simply skipped and the next command is shown.
# The names specified here must be the command's main node name, not the translated ones. (which can be obtained from /k admin cmd)
# Any commands that are not specified here will be put at the end of the list.
order: [ help, language, create, lore, rename, tag, show, home, unsethome, nexus, king, sethome, chat, challenge, mute,
unmute, bank, top, disband, invite, invites, invitecodes, accept, decline, join, leave, kick, promote, demote,
claim, unclaim, undo, redo,
inventory, vault, book, visualize, pvp, broadcast, fly, sneak, donate, resourcepoints, extractor, tradable, sell,
ally, enemy, truce, revoke, relations,
map, invade, tpa, tpaaccept, tpareject, teleport, surrender, about, gui, updates, reload, nation, admin ]
# Amount of commands displayed in a single page.
commands: 5
# Limit the number of pages shown on the footer.
# This is the limit for both previous and next pages.
# For example if your current page is 7, it'll show:
# 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
footer-pages: 5
# /k fly
kingdom-fly:
# If you disable this, it'll only ignore the checks for performance improvements. If you like to disable the
# command as well, refer to https://github.com/CryptoMorin/KingdomsX/wiki/FAQ#how-to-disable-a-command
enabled: true
# Disable flight after taking damage.
disable-on-damage: true
# Allow flying in unclaimed lands.
allow-unclaimed: false
# If the players fly should be disabled if they're near
# their enemy. Enemies are players who their kingdoms relation
# doesn't have "Ceasefire" attribute.
# Set to 0 to disable.
# Note: Higher numbers mean more lag.
# Players who have admin mode enabled, will bypass this.
# Requires a restart to update.
nearby-unfriendly-range: 30
charges:
# Requires a restart to take effect.
enabled: true
# Amount of seconds these charges are performed.
every-seconds: 1
# Player money if an economy is available
players:
# Set to ~ to disable
amount:
default: 1
activation-cost:
default: 100
# Whether this amount is paid to the kingdom or to the server.
# This is great if you want to charge your members more than the required amount.
pay-kingdom:
enabled: true
# false = kingdoms bank money
resource-points: true
# If the kingdom should also pay for additional charges.
kingdoms:
# Per player, set to ~ to disable.
amount:
default: 1
activation-cost:
default: 100
resource-points: true
# In seconds. If the player avoids the flight disable cause,
# the warning will end and the player will keep their flight.
# - Set to 0 to instantly disable their flight.
warnings:
# Warn the player before disabling their fly if they go in a land that they cannot fly in.
# Players that teleport will have their flight instantly disabled if the land that they teleported to doesn't allow flight.
land: 3
# We can give them more time. After all there's an activation cost for a reason.
charges: 10
# Warn the player before disabling their fly if they're near unfriendly players.
unfriendly-nearby: 5
# The sound used for most of the actions that prevents or prohibits
# a player from doing that certain action.
error-sound: BLOCK_NOTE_BLOCK_BASS
guis:
creative-sound: BLOCK_NOTE_BLOCK_BASS
# Close the GUI if the player is damaged.
close-on-damage: true
# Allow interacting with items within the
# player's inventory.
# This will prevent items from being placed
# in the GUI (if the GUI is doesn't allow item drag)
# but it'll allow players to arrange or throw away
# items in their own inventory.
# Note that some GUIs such as resource points converter
# Allow this by default.
allow-own-inventory-interact: true
# Default sound for clicking on options.
# You have to use "sound: default" for
# GUI options for this to work.
# Can be set to "none" for no sound.
default-click-sound: BLOCK_TRIPWIRE_CLICK_ON
# Allows refreshing of GUI (e.g. Extractor GUI) values when the GUI is open for better experience.
# As for why this isn't enabled by default, some people are experiencing plugin conflicts because of
# this feature that can cause the server to lag or even crash. No one has been able to reproduce this
# issue effectively. For more info, visit this bug report:
# https://discord.com/channels/429132410748141579/1130601058876534794/1132881328426197104
enable-refresh-feature: false
# Custom join and leave messages. One benefit is that the message shown to kingdom members are
# different from those who are not in the same kingdom.
# Permissions: kingdoms.silent.join and kingdoms.silent.leave
# Check the "join-leave-messages" section of your language file.
join-leave-messages: true
placeholders:
# https://github.com/CryptoMorin/KingdomsX/wiki/Placeholders#placeholder-formats
# You cannot use another placeholder in these options "%" has a special meaning
# the translated placeholder. The "normal" option is used when the default value
# is not needed to be used (depending on the situation) or "default" otherwise.
# You can also use "%" for default options to retrieve their default values from
# the option below.
formats:
brackets:
normal: '[%]'
default: ''
parens:
normal: "(%)"
default: ''
# This means both normal and default options use the same format.
hex: '{#%}'
# Variables are internal kingdoms placeholders that help you
# to reuse a certain text multiple times without rewriting it.
# The format is %var_<name>% e.g. {$enabled} and {$disabled}
# You can use these pretty much everywhere. They also support colorization
# and placeholders too. They're case-insensitive.
# These are technically known as "macros"
variables:
green: '&2'
white: '&f'
black: '&0'
gray: '&7'
pink: '&d'
purple: '&5'
orange: '&6'
gold: '&6'
blue: '&9'
red: '&c'
# These should not be deleted. In very rare cases the plugin uses
# some of these macros to colorize certain parts of the plugin
# that can't be translated from the language file because there's
# no translation needed, it's just a matter of style preference.
# Most commonly used for separating enteries in a list.
p: '&2' # primary
sp: '&9' # Secondary primary
desc: '&7' # Used in GUIs
s: '&6' # secondary
e: '&c' # error
es: '&e' # error secondary
sep: '&8' # separator
ssep: '&7' # secondary separator
LightSalmon: '{#F97}'
Maroon: '{#900}'
Olive: '{#990}'
Teal: '{#008080}'
Fuchsia: '{#F0F}'
Navy: '{#000080}'
### Conditional Variables ###
groupColor:
perm_color_admin: '&6'
else: '&r'
# Please just be care not to use recursive variables or your servers console will blow up.
channel: '&8[&9%kingdoms_chat_channel_color%%kingdoms_chat_channel_short%&8]'
kingdomPrefix:
kingdoms_has_kingdom: '&8[%kingdoms_rank_color%%kingdoms_rank_symbol% %kingdoms_kingdom_color@hex%%kingdoms_kingdom_name%&8]&r '
else: ''
nationPrefix:
kingdoms_has_nation: '&8[%kingdoms_nation_rank_color%%kingdoms_nation_rank_symbol%&8 %kingdoms_nation_color@hex%%kingdoms_nation_name%&8]&7|'
else: ''
spy:
kingdoms_other_is_spy: '{$channel}&7|'
else: ''
# Default placeholders used when a player is not a kingdom or nation.
# Requires /k reload to be reloaded.
# You can add any placeholder to this list. Instead of _ use - and don't include "kingdoms_" prefix.
# There are also default placeholders for when placeholders here are not defined.
# All the text placeholders default to an empty text and all the number placeholders default to 0
defaults:
distance-from-core-other-world: 'value * 100'
kingdom_name: ''
lore: ''
nation_name: '&cNo Nation'
members: 0
# Green
kingdom_color: '00ff00'
nation_color: '00ff00'
# https://github.com/CryptoMorin/KingdomsX/wiki/Introduction#might
# Used in /k top
top-kingdoms:
# Equation used for calculating a kingdoms might.
# A kingdoms "might" determines a kingdom's rank in /k top
# Higher "might" means higher rank.
might: "kingdoms_resource_points + kingdoms_members"
# Updates top leaderboard
update-interval: 30min
# The limit of kingdom entries shown on each /k top page
amount: 10
# Show kingdoms that are pacifist in the list.
show-pacifists: false
rewards:
# Set it to 0 to disable.
top: 10
resource-points: "10000 / rank"
bank: "1000 / rank"
# https://github.com/CryptoMorin/KingdomsX/wiki/Introduction#might
# Used in /k nation top
top-nations:
# Equation used for calculating a kingdoms might.
# A kingdoms "might" determines a kingdom's rank in /k top
# Higher "might" means higher rank.
might: "kingdoms_nation_resource_points + kingdoms_nation_kingdoms"
# The limit of nation entries shown on each /k nation top page
amount: 10
rewards:
# Set it to 0 to disable.
top: 10
resource-points: "10000 / rank"
bank: "1000 / rank"
# Default number of max members.
# You can increase this by upgrading your max-members misc upgrade
# in the Nexus Misc Upgrades section.
max-members:
kingdoms: 10
nations: 30
# Kingdoms can change their flag URL for web maps via kingdoms settings.
flag:
# Cooldown for changing the kingdom image.
# The option can be used to lag the server if used excessively since it passes multiple checks.
cooldown: 10sec
# The image's size limit. Resizing the image from the <img> HTML tag will not help.
# Set to 0 for no limit.
# Although most of the image services out there don't allow a certain link to be used for an image,
# players that have their own website can still set the URL that links to a small image then reupload
# a bigger image under the same link. That's up to you to handle.
# This option does not downlaod the image, so don't worry about your server's connection.
size-limit:
width: 1000
height: 1000
# SVG files aren't acceptable at all. They can cause vulnerabilities.
links:
blacklist: true
# If the URL contains one of these strings.
# It's possible to detect links wrongly, but it happens rarely.
contains: [ 'jar://', 'ftp://', 'file://', 'porn', 'sex', '.onion' ]
# Only use if you know how RegEx works. You can use this site: https://regexr.com/
# If the URL contains any RegEx below then it'll not be allowed.
regex: [ ]
# Settings for /k create and /k rename
# Players who have admin mode enabled, will bypass all the following checks.
kingdom-name:
# To allow renaming you need kingdoms.command.rename permission.
# Use 0 for no cooldown.
# This cooldown does not persist between server restarts.
renaming-cooldown: 1day
# Maximum kingdom name length.
max-length: 16
# Minimum kingdom name length.
min-length: 3
# Ignore colors when comparing the kingdom name length.
ignore-colors: true
# Allow numbers in kingdom names. This also works for number
# characters of other languages.
allow-numbers: true
# Allow kingdom name to have spaces
# --- THIS IS NOT RECOMMENDED ---
# This can cause issues with command tab completions and arguments. There isn't really a proper fix for that.
# Even if the command system was rewritten to support quotes, Minecraft command inputs can't
# handle multiple spaces, so you'll be only able to put a single space between each word.
# The only way to fix it would be to set a specific character to represent a space like "_" which ruins
# the purpose and causes conflicts. Or more rare unicode characters (The ones that Minecraft support)
# something like ♀ or characters like that. Which still defeats the purpose.
# With that being said, you pretty much can't use commands properly for kingdoms with spaces in their names.
allow-spaces: false
# If you're using another language like Chinese or Japanese you might want to enable this.
# Allow characters that are not English. Underline, space, numbers and alphabets are considered English characters.
allow-non-english: false
# allow-non-english needs to be enabled if you want to set this to true.
# If set to false, This will only allow other langauge numbers and letters, not symbols.
# Note that you shouldn't allow colors for kingdom names. It causes a lot of issues. For example other plugins can't use the
# kingdom name from %kingdoms_kingdom_name% placeholder if it's used somewhere that translates color codes (for example a command list)
# NOT RECOMMENDED as it'll make it harder to use commands that need a kingdom name.
allow-symbols: false
# Allow kingdoms to have the same name?
# Requires a restart to work correctly.
allow-duplicate-names: false
# This option makes kingdom names case-sensitive. Which means if allow-duplicate-names is enabled, and this is disabled,
# A kingdom is named "MykiNgdoM" is the same as "mykingdom" so you can't make a kingdom with that name anymore.
# If you keep this disabled, it'll be useful for command tab completions as the input it receives will ignore the case.
# This option needs a restart in order to fetch old kingdom names.
case-sensitive: false
# Only use if you know how RegEx works. You can use this site: https://regexr.com/
# If the name matches any RegEx below then it'll not be allowed.
# To only allow a certain language, use "[^A-z]" where A is the first alphabet in that language and z is the last (lowercase if available)
# alphabet in that language. The "[^A-z]" expression itself indicates that only English alphabets are allowed.
blacklisted-names: [ "nigg(?:a|er)", "tit(?:s|z|ies)?", "boob(?:s|z|ies)?", "butt|ass(?:hole)?",
cunt, motherfuck, motherfucker, whore, anus, anal, cock, dick, suck, twat, shit, labbe, faggot, clit, bitch ]
# Settings for /k tag
# All the option explanations are the same as "kingdom-name" option. Please refer to the section above.
tags:
# Plugin will attempt to automatically make a tag for this kingdom based on its name.
# For example "TheGreatPheonix" will be tagged as "TGP"
# and "Apothicas" will be tagged as "Apoth"
attempt-automatic-setting: true
max-length: 16
min-length: 3
ignore-colors: true
allow-numbers: true
allow-spaces: false
allow-non-english: false
allow-symbols: false
blacklisted-names: [ black, white, cunt, motherfuck, motherfucker, whore, anus, anal, cock, dick, suck, twat, shit, labbe, faggot, clit, bitch, "nigg(?:a|er)", "tit(?:s|z|ies)?", "boob(?:s|z|ies)?", "butt|ass(?:hole)?", "^fag$" ]
# Settings for /k nation create and /k nation rename
# All the option explanations are the same as "kingdom-name" option. Please refer to the section above.
# Players who have admin mode enabled, will bypass all the following checks.
# For each item's description, refer to the previous "kingdom-name" section with the same options.
nation-name:
renaming-cooldown: 1day
max-length: 16
min-length: 3
ignore-colors: true
allow-numbers: true
allow-spaces: false
allow-non-english: false
allow-symbols: false
allow-duplicate-names: false
case-sensitive: false
blacklisted-names: [ black, white, cunt, motherfuck, motherfucker, whore, anus, anal, cock, dick, suck, twat, shit, labbe, faggot, clit, bitch, "nigg(?:a|er)", "tit(?:s|z|ies)?", "boob(?:s|z|ies)?", "butt|ass(?:hole)?", "^fag$" ]
# All the option explanations are the same as "kingdom-name" option. Please refer to the section above.
kingdom-lore: # /k lore
title:
fade-in: 10
stay: 20
fade-out: 10
allow-colors: true
max-length: 30
ignore-colors: true
renaming-cooldown: 0
allow-non-english: true
allow-symbols: false
remove-keywords: [ "remove", "none", "delete", "unset", "off" ]
blacklisted-names: [ black, white, cunt, motherfuck, motherfucker, whore, anus, anal, cock, dick, suck, twat, shit, labbe, faggot, clit, bitch, "nigg(?:a|er)", "tit(?:s|z|ies)?", "boob(?:s|z|ies)?", "butt|ass(?:hole)?", "^fag$" ]
# Should kingdom homes be public by default?
default-public-homes: false
audit-logs:
# Disabled logs
disabled: [ ]
# How long do log datas are kept?
# You can either specify their exact name to
# have their own expiration time or change the
# "default" option for any other logs not specified here.
# Of course, the lower the time, the better the
# storage, memory and performance.
# For performance purposes, the expiration value
# cannot be lower than one hour.
expiration:
default: 30 days
kingdom-join: 10 days
kingdom-leave: 10 days
extractor-collect: 5 days
warppad-teleport: 3 days
kingdom-invite: 7 days
kingdom-resource-points-convert: 20seconds
rank-change-name: 7 days
rank-change-color: 7 days
rank-change-symbol: 7 days
rank-change-priority: 10 days
rank-change-material: 7 days
# Remind people that never had a kingdom before to join one.
# The message entry for this option is "no-kingdom-reminder"
no-kingdom-reminder: false
# If the elements below should be announced to everyone in the server.
# After changing this, you might want to consider using %kingdoms_kingdom_name% in the
# message of the element.
# If set to false, it'll only announce it to the kingdom members.
announcements:
# /k king
king: false
# /k rename
rename: false
create:
# /k create
kingdom: false
# /k nation create
nation: false
# For /k disband please refer to "disband" section.
# Outposts addon
outpost-events:
# If kingdom members participating in the event die,
# their kingdom will lose rp.
# Set to 0 to disable.
death-resource-points-penalty: 100
scoreboard:
title: "&8-=[ &2Outpost Event &8]=-"
# /k resourcepoints <deposit/withdraw/transfer>
# /k bank <deposit/withdraw>
economy:
# If the player needs to confirm before creating a kingdom/nation.
# This is the time which the player needs to do the command again before it ends.
# Set to 0 to disable.
create-confirmation: 10s
bank:
# Allow depositing money to kingdoms/nations bank.
deposit:
enabled: true
min: 1
# Allow withdrawing from kingdoms/nations bank.
withdraw:
enabled: true
min: 1
# The bank limit for the following elements.
# Will be considered for "/k bank deposit" and taxes.
limit:
kingdoms: 1000000
nations: 100000000
resource-points:
# Means that each resource point is worth $0.5
# So in order to get $2 you have to deposit 4 rp
worth: 0.5
# Minimum amount of resource points that can be withdrawn.
# This helps if your economy plugin doesn't support decimal currencies.
# By default, you need to withdraw at least 2 rp (2 * 0.5 = $1)
min-withdraw: 2
# Basic costs. For claims refer to claims.yml
# These use the bank money, not resource points.
costs:
# How much does creating the following elements cost?
create:
kingdom: 0
nation: 0
# How much does renaming the following elements cost?
rename:
kingdom: 100
nation: 1000
# How much does changing the kingdom's tag cost?
tag:
kingdom: 100
# Daily checks are for checking kingdom inactivities, handling taxes and top kingdom and nation rewards.
# After changing any of the options below, you need to restart the server for changes to apply.
daily-checks:
# The time that daily checks are performed every day. It uses the 24-hours format and optionally supports seconds.
# If the server is started after this time, the daily checks will not be performed for that day, and it'll
# simply wait until the next day.
time: '12:00'
# Amount of days between each check.
interval: 1
# For information check: https://github.com/CryptoMorin/KingdomsX/wiki/Introduction#elections
elections:
# Requires a restart.
enabled: true
# The interval in days for election events.
interval: 7
# The total voting percentage to consider election results.
# Meaning that more than 50% of kingdom members need to vote (for anyone)
# in order for a new king to be chosen.
vote-percentage: 50
# The duration of election events before the results are evaluated.
duration: 24hrs
# This is to prevent abusing the voting system.
disallow:
joins: true
kicks: true
# The time zone ID.
# You can find yours here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
# You should copy and paste one of the names under the "TZ database name" column.
# By default this is "local". A special keyword that will automatically use your server's timezone.
# To get the current UTC time just Google "UTC time"
# This is purely for convenience, otherwise you could adjust the time option above
# with a correct offset to get the time you want, but this also considers holidays and all the other exceptions.
# This is also used for other things such as backups.
timezone: 'local'
# The countdowns to notify players before daily checks are performed.
# NOTE: This will only be used if either kingdoms or nations taxes are enabled.
# The order of this list should be in descending order.
countdowns: