EpicKnarvik97/PlotSquared
EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-25 22:56:45 +01:00
Code Issues Projects Releases Wiki Activity

Add more documentation to the settings.yml

Browse Source 
Apparently gradle wants to update the poms so here we go
This commit is contained in:
N0tMyFaultOG 2020-05-27 22:20:13 +02:00
parent 6442922d86
commit f1b79a3b0d
3 changed files with 41 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Bukkit/pom.xml
View File

@ -9,7 +9,7 @@
<dependency> <dependency>
<groupId>org.json</groupId> <groupId>org.json</groupId>
<artifactId>json</artifactId> <artifactId>json</artifactId>
<version>20190722</version> <version>20200518</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>
@ -21,7 +21,7 @@
<dependency> <dependency>
<groupId>com.plotsquared</groupId> <groupId>com.plotsquared</groupId>
<artifactId>PlotSquared-Core</artifactId> <artifactId>PlotSquared-Core</artifactId>
<version>5.11.2</version> <version>5.12.0</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>

2
Core/pom.xml
View File

@ -9,7 +9,7 @@
<dependency> <dependency>
<groupId>org.json</groupId> <groupId>org.json</groupId>
<artifactId>json</artifactId> <artifactId>json</artifactId>
<version>20190722</version> <version>20200518</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>

57
Core/src/main/java/com/plotsquared/core/configuration/Settings.java
View File

@ -40,13 +40,14 @@ public class Settings extends Config {
NOTE: Fields are saved in declaration order, classes in reverse order NOTE: Fields are saved in declaration order, classes in reverse order
*/ */
@Comment("The first value is not configurable") // This is a comment @Comment("This value is not configurable. It shows the platform you are using.") // This is a comment
@Final public static String PLATFORM; // These values are set from P2 before loading @Final public static String PLATFORM; // These values are set from P2 before loading
@Comment("Show additional information in console") public static boolean DEBUG = false; @Comment({"Show additional information in console. It helps us at IntellectualSites to find out more about an issue.",
@Comment({"The big annoying text that appears when you enter a plot", "Leave it off if you don't need it, it can spam your console."}) public static boolean DEBUG = false;
"For a single plot: `/plot flag set titles false`", "For just you: `/plot toggle titles`", @Comment({"The big text that appears when you enter a plot.",
"For all plots: Add `titles: false` in the worlds.yml flags block"}) public static boolean "For a single plot set `/plot flag set titles false` to disable it.", "For just you run `/plot toggle titles` to disable it.",
"For all plots: Add `titles: false` in the worlds.yml flags block to disable it."}) public static boolean
TITLES = true; TITLES = true;
@Create // This value will be generated automatically @Create // This value will be generated automatically
@ -207,7 +208,7 @@ public class Settings extends Config {
public List<String> WORLDS = new ArrayList<>(Collections.singletonList("*")); public List<String> WORLDS = new ArrayList<>(Collections.singletonList("*"));
@Comment("See: https://wiki.intellectualsites.com/en/plotsquared/optimization/plot-analysis") @Comment("See: https://wiki.intellectualsites.com/en/plotsquared/optimization/plot-analysis for a description of each value.")
public static final class CALIBRATION { public static final class CALIBRATION {
public int VARIETY = 0; public int VARIETY = 0;
public int VARIETY_SD = 0; public int VARIETY_SD = 0;
@ -223,6 +224,8 @@ public class Settings extends Config {
} }
@Comment({"Chunk processor related settings",
"See https://wiki.intellectualsites.com/en/plotsquared/optimization/chunk-processor for more information."})
public static class Chunk_Processor { public static class Chunk_Processor {
@Comment("Auto trim will not save chunks which aren't claimed") public static boolean @Comment("Auto trim will not save chunks which aren't claimed") public static boolean
AUTO_TRIM = false; AUTO_TRIM = false;
@ -232,6 +235,8 @@ public class Settings extends Config {
} }
@Comment({"UUID settings",
"DO NOT EDIT them unless you know what you are doing."})
public static class UUID { public static class UUID {
@Comment("Force using offline UUIDs (it usually detects the right mode)") @Comment("Force using offline UUIDs (it usually detects the right mode)")
public static boolean OFFLINE = false; public static boolean OFFLINE = false;
@ -259,7 +264,8 @@ public class Settings extends Config {
public static final class General { public static final class General {
@Comment("Display scientific numbers (4.2E8)") public static boolean SCIENTIFIC = false; @Comment("Display scientific numbers (4.2E8)") public static boolean SCIENTIFIC = false;
@Comment("Replace wall when merging") public static boolean MERGE_REPLACE_WALL = true; @Comment("Replace wall when merging") public static boolean MERGE_REPLACE_WALL = true;
@Comment("Blocks that may not be used in plot components") public static List<String> @Comment({"Blocks that may not be used in plot components",
"Checkout the wiki article regarding plot components before modifying: https://wiki.intellectualsites.com/en/plotsquared/installation/plot-components"}) public static List<String>
INVALID_BLOCKS = Arrays.asList( INVALID_BLOCKS = Arrays.asList(
// Acacia Stuff // Acacia Stuff
"acacia_button", "acacia_fence_gate", "acacia_door", "acacia_pressure_plate", "acacia_button", "acacia_fence_gate", "acacia_door", "acacia_pressure_plate",
@ -373,7 +379,8 @@ public class Settings extends Config {
} }
@Comment("Schematic Settings") @Comment({"Schematic Settings",
"See https://wiki.intellectualsites.com/en/plotsquared/schematics/on-claim for more information."})
public static final class Schematics { public static final class Schematics {
@Comment( @Comment(
"Whether schematic based generation should paste schematic on top of plots, or from Y=1") "Whether schematic based generation should paste schematic on top of plots, or from Y=1")
@ -390,6 +397,7 @@ public class Settings extends Config {
} }
@Comment("Schematic and Asset interface related settings")
public static class Web { public static class Web {
@Comment({"The web interface for schematics", " - All schematics are anonymous and private", @Comment({"The web interface for schematics", " - All schematics are anonymous and private",
" - Downloads can be deleted by the user", " - Downloads can be deleted by the user",
@ -402,8 +410,9 @@ public class Settings extends Config {
} }
@Comment("Misc settings")
public static final class Done { public static final class Done {
@Comment("Require a plot marked as done to download") public static boolean @Comment("Require a plot marked as done to download (/plot download)") public static boolean
REQUIRED_FOR_DOWNLOAD = false; REQUIRED_FOR_DOWNLOAD = false;
@Comment("Only plots marked as done can be rated") public static boolean @Comment("Only plots marked as done can be rated") public static boolean
REQUIRED_FOR_RATINGS = false; REQUIRED_FOR_RATINGS = false;
@ -414,6 +423,7 @@ public class Settings extends Config {
} }
@Comment("Chat related settings")
public static final class Chat { public static final class Chat {
@Comment("Sometimes console color doesn't work, you can disable it here") @Comment("Sometimes console color doesn't work, you can disable it here")
public static boolean CONSOLE_COLOR = true; public static boolean CONSOLE_COLOR = true;
@ -432,9 +442,10 @@ public class Settings extends Config {
} }
@Comment("Backup related settings") @Comment({"Backup related settings",
"See https://wiki.intellectualsites.com/en/plotsquared/backups for more information."})
public static final class Backup { public static final class Backup {
@Comment("Automatically backup plots when destructive commands are performed") @Comment("Automatically backup plots when destructive commands are performed, e.g. /plot clear")
public static boolean AUTOMATIC_BACKUPS = true; public static boolean AUTOMATIC_BACKUPS = true;
@Comment("Maximum amount of backups associated with a plot") public static int @Comment("Maximum amount of backups associated with a plot") public static int
BACKUP_LIMIT = 3; BACKUP_LIMIT = 3;
@ -443,12 +454,14 @@ public class Settings extends Config {
} }
@Comment("Confirmation timeout related settings")
public static final class Confirmation { public static final class Confirmation {
@Comment("Timeout before a confirmation prompt expires") public static int @Comment("Timeout before a confirmation prompt expires") public static int
CONFIRMATION_TIMEOUT_SECONDS = 20; CONFIRMATION_TIMEOUT_SECONDS = 20;
} }
@Comment("Teleportation related settings")
public static final class Teleport { public static final class Teleport {
@Comment("Teleport to your plot on death") public static boolean ON_DEATH = false; @Comment("Teleport to your plot on death") public static boolean ON_DEATH = false;
@Comment("Teleport to your plot on login") public static boolean ON_LOGIN = false; @Comment("Teleport to your plot on login") public static boolean ON_LOGIN = false;
@ -461,6 +474,7 @@ public class Settings extends Config {
} }
@Comment("Redstone related settings")
public static final class Redstone { public static final class Redstone {
@Comment("Disable redstone in unoccupied plots") public static boolean DISABLE_UNOCCUPIED = @Comment("Disable redstone in unoccupied plots") public static boolean DISABLE_UNOCCUPIED =
false; false;
@ -472,12 +486,14 @@ public class Settings extends Config {
} }
@Comment("Claim related settings")
public static final class Claim { public static final class Claim {
@Comment("The max plots claimed in a single `/plot auto <size>` command") public static int @Comment("The max plots claimed in a single `/plot auto <size>` command") public static int
MAX_AUTO_AREA = 4; MAX_AUTO_AREA = 4;
} }
@Comment("Rating related settings")
public static final class Ratings { public static final class Ratings {
@Comment("Replace the rating system with a like system. Will add /plot like/dislike," @Comment("Replace the rating system with a like system. Will add /plot like/dislike,"
+ " and remove the rating command") public static boolean USE_LIKES = false; + " and remove the rating command") public static boolean USE_LIKES = false;
@ -528,27 +544,28 @@ public class Settings extends Config {
true; true;
@Comment("Allow WorldEdit to be restricted to plots") public static boolean @Comment("Allow WorldEdit to be restricted to plots") public static boolean
WORLDEDIT_RESTRICTIONS = true; WORLDEDIT_RESTRICTIONS = true;
@Comment("Allow economy to be used") public static boolean ECONOMY = true; @Comment("Allow economy to be used to sell, claim or buy plots.") public static boolean ECONOMY = true;
@Comment("Expiry will clear old or simplistic plots") public static boolean PLOT_EXPIRY = @Comment("Expiry will clear old or simplistic plots") public static boolean PLOT_EXPIRY =
false; false;
@Comment("Processes chunks (trimming, or entity/tile limits) ") public static boolean @Comment("Processes chunks (trimming, or entity/tile limits) ") public static boolean
CHUNK_PROCESSOR = false; CHUNK_PROCESSOR = false;
@Comment("Kill mobs on roads") public static boolean KILL_ROAD_MOBS = false; @Comment("Kill mobs on roads (Chicken, Cow, etc.)") public static boolean KILL_ROAD_MOBS = false;
@Comment("Kill items on roads") public static boolean KILL_ROAD_ITEMS = false; @Comment("Kill items on roads (Stick, Paper, etc.)") public static boolean KILL_ROAD_ITEMS = false;
@Comment("Kill vehicles on roads") public static boolean KILL_ROAD_VEHICLES = false; @Comment("Kill vehicles on roads (Boat, Minecart, etc.)") public static boolean KILL_ROAD_VEHICLES = false;
@Comment("Notify a player of any missed comments upon plot entry") public static boolean @Comment("Notify a player of any missed plot comments upon plot entry") public static boolean
COMMENT_NOTIFIER = false; COMMENT_NOTIFIER = false;
@Comment("Let players claim entire worlds with PlotSquared") public static boolean WORLDS = @Comment("Let players claim entire worlds with PlotSquared") public static boolean WORLDS =
false; false;
@Comment("Actively purge invalid database entries") public static boolean DATABASE_PURGER = @Comment("Actively purge invalid database entries") public static boolean DATABASE_PURGER =
false; false;
@Comment("Delete plots when a player is banned") public static boolean BAN_DELETER = false; @Comment({"Delete plots when a player is banned.",
@Comment("Allows PlaceholderAPI placeholders to be used in captions, flags, etc") "Note: This only works with the /minecraft:ban command. Any punishment plugin like LiteBans is not supported."}) public static boolean BAN_DELETER = false;
@Comment("Allows PlaceholderAPI placeholders to be used in captions, flags, etc.")
public static boolean EXTERNAL_PLACEHOLDERS = true; public static boolean EXTERNAL_PLACEHOLDERS = true;
@Comment("Make road regeneration persistent across restarts") public static boolean @Comment("Make road regeneration persistent across restarts") public static boolean
PERSISTENT_ROAD_REGEN = false; PERSISTENT_ROAD_REGEN = false;
@Comment("Plot component preset GUI") @Comment({"Enable the `/plot component` preset GUI",
public static boolean COMPONENT_PRESETS = true; "Read more about components here: https://wiki.intellectualsites.com/en/plotsquared/installation/plot-components"}) public static boolean COMPONENT_PRESETS = true;
@Comment("Use UUID cache to complete usernames") @Comment("Use UUID cache to complete usernames")
public static boolean EXTENDED_USERNAME_COMPLETION = true; public static boolean EXTENDED_USERNAME_COMPLETION = true;
} }