Skip to content

Commit

Permalink
Improve config file header
Browse files Browse the repository at this point in the history
It might be a good idea to include a link to the bStats homepage.
  • Loading branch information
Bastian committed Feb 12, 2021
1 parent 84a4c4e commit 2ee15e1
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
10 changes: 5 additions & 5 deletions base/src/main/java/org/bstats/config/MetricsConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ private void setupConfig() throws IOException {
*/
private void writeConfig() throws IOException {
List<String> configContent = new ArrayList<>();
configContent.add("# bStats collects some basic information for plugin authors, like how many people use");
configContent.add("# their plugin and their total player count. It's recommended to keep bStats enabled, but");
configContent.add("# if you're not comfortable with this, you can turn this setting off. There is no");
configContent.add("# performance penalty associated with having metrics enabled, and data sent to bStats");
configContent.add("# can't identify your server.");
configContent.add("# bStats (https://bStats.org) collects some basic information for plugin authors, like");
configContent.add("# how many people use their plugin and their total player count. It's recommended to keep");
configContent.add("# bStats enabled, but if you're not comfortable with this, you can turn this setting off.");
configContent.add("# There is no performance penalty associated with having metrics enabled, and data sent to");
configContent.add("# bStats is fully anonymous.");
configContent.add("enabled=" + defaultEnabled);
configContent.add("server-uuid=" + UUID.randomUUID().toString());
configContent.add("log-errors=false");
Expand Down
10 changes: 5 additions & 5 deletions bukkit/src/main/java/org/bstats/bukkit/Metrics.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ public Metrics(JavaPlugin plugin, int serviceId) {

// Inform the server owners about bStats
config.options().header(
"bStats collects some basic information for plugin authors, like how many people use\n" +
"their plugin and their total player count. It's recommended to keep bStats enabled, but\n" +
"if you're not comfortable with this, you can turn this setting off. There is no\n" +
"performance penalty associated with having metrics enabled, and data sent to bStats\n" +
"can't identify your server."
"bStats (https://bStats.org) collects some basic information for plugin authors, like how\n" +
"many people use their plugin and their total player count. It's recommended to keep bStats\n" +
"enabled, but if you're not comfortable with this, you can turn this setting off. There is no\n" +
"performance penalty associated with having metrics enabled, and data sent to bStats is fully\n" +
"anonymous."
).copyDefaults(true);
try {
config.save(configFile);
Expand Down
10 changes: 5 additions & 5 deletions bungeecord/src/main/java/org/bstats/bungeecord/Metrics.java
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ private void loadConfig() throws IOException {
File configFile = new File(bStatsFolder, "config.yml");
if (!configFile.exists()) {
writeFile(configFile,
"# bStats collects some basic information for plugin authors, like how many people use",
"# their plugin and their total player count. It's recommended to keep bStats enabled, but",
"# if you're not comfortable with this, you can turn this setting off. There is no",
"# performance penalty associated with having metrics enabled, and data sent to bStats",
"# can't identify your server.",
"# bStats (https://bStats.org) collects some basic information for plugin authors, like how",
"# many people use their plugin and their total player count. It's recommended to keep bStats",
"# enabled, but if you're not comfortable with this, you can turn this setting off. There is no",
"# performance penalty associated with having metrics enabled, and data sent to bStats is fully",
"# anonymous.",
"enabled: true",
"serverUuid: \"" + UUID.randomUUID() + "\"",
"logFailedRequests: false",
Expand Down
10 changes: 5 additions & 5 deletions sponge/src/main/java/org/bstats/sponge/Metrics.java
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,11 @@ private void loadConfig() throws IOException {
CommentedConfigurationNode node;

String serverUuidComment =
"bStats collects some basic information for plugin authors, like how many people use\n" +
"their plugin and their total player count. It's recommended to keep bStats enabled, but\n" +
"if you're not comfortable with this, you can disable data collection in the Sponge\n" +
"configuration file. There is no performance penalty associated with having metrics enabled,\n" +
"and data sent to bStats can't identify your server.";
"bStats (https://bStats.org) collects some basic information for plugin authors, like how\n" +
"many people use their plugin and their total player count. It's recommended to keep bStats\n" +
"enabled, but if you're not comfortable with this, you can disable data collection in the\n" +
"Sponge configuration file. There is no performance penalty associated with having metrics\n" +
"enabled, and data sent to bStats is fully anonymous.";

if (!configFile.exists()) {
configFile.createNewFile();
Expand Down

0 comments on commit 2ee15e1

Please sign in to comment.