Skip to content

Commit d074fa8

Browse files
committed
Add config comments
1 parent 209f035 commit d074fa8

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

Towny/src/main/java/com/palmergames/bukkit/config/ConfigNodes.java

+28-3
Original file line numberDiff line numberDiff line change
@@ -3208,13 +3208,38 @@ public enum ConfigNodes {
32083208
"",
32093209
"# The width of the map shown in /towny map and /res toggle map.",
32103210
"# Minimum 7, maximum 27, only odd numbers are accepted."),
3211-
CUSTOM_LISTS("custom_lists", "", ""), // TODO documentation in this comment
3211+
CUSTOM_LISTS("custom_lists", "", "",
3212+
"# This section of the config allows you to specify custom lists of blocks or entities, that can then be used elsewhere in the config.",
3213+
"# A custom syntax is used to specify whether to include or exclude certain patterns from the resulting set.",
3214+
"#",
3215+
"# Format:",
3216+
"# *string: Includes all elements that end with 'string'",
3217+
"# string*: Includes all elements that start with 'string'",
3218+
"# !*string: Excludes all elements that don't end with 'string'",
3219+
"# !string*: Excludes all elements that don't start with 'string'",
3220+
"# #tag: Includes all elements that are contained in the given tag, valid tags can be found here: https://github.com/misode/mcmeta/tree/data/data/minecraft/tags in the blocks or entity_type folders.",
3221+
"# !#tag: Excludes all elements that are contained in the given tag",
3222+
"# +string: Includes the element with name 'string'",
3223+
"# -string: Excludes the element with name 'string'",
3224+
"# ~string: Includes all elements that contain 'string' in the name",
3225+
"# !~string: Excludes all elements that contain 'string' in the name",
3226+
"# c:class: Includes all elements that are instances of the given class"),
32123227
CUSTOM_LISTS_ITEM_LISTS("custom_lists.item_lists",
32133228
new HashMap<>(),
3214-
""),
3229+
"",
3230+
"# Define your custom item lists here.",
3231+
"# Example:",
3232+
"#",
3233+
"# item_lists:",
3234+
"# chests: '~chest'"),
32153235
CUSTOM_LISTS_ENTITY_LISTS("custom_lists.entity_lists",
32163236
new HashMap<>(),
3217-
"");
3237+
"",
3238+
"# Define your custom entity lists here.",
3239+
"# Example:",
3240+
"#",
3241+
"# entity_lists:",
3242+
"# animals: 'c:Animals'");
32183243

32193244
private final String root;
32203245
private final Object defaultValue;

0 commit comments

Comments
 (0)