un-hid 2 GitHub-related settings in config

This commit is contained in:
Florian CUNY 2019-04-19 18:49:47 +02:00
parent 0108d254ee
commit d1732e4f20
2 changed files with 23 additions and 10 deletions

View File

@ -1,10 +1,5 @@
package world.bentobox.bentobox;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import world.bentobox.bentobox.api.configuration.ConfigComment;
import world.bentobox.bentobox.api.configuration.ConfigEntry;
import world.bentobox.bentobox.api.configuration.StoreAt;
@ -12,6 +7,11 @@ import world.bentobox.bentobox.database.DatabaseSetup.DatabaseType;
import world.bentobox.bentobox.database.objects.DataObject;
import world.bentobox.bentobox.managers.RanksManager;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
/**
* All the plugin settings are here
* @author tastybento
@ -173,8 +173,8 @@ public class Settings implements DataObject {
@ConfigComment("Disabling this will result in the deactivation of the update checker and of some other")
@ConfigComment("features that rely on the data downloaded from the GitHub API.")
@ConfigComment("It does not send any data.")
@ConfigEntry(path = "web.github.download-data", since = "1.3.0", hidden = true)
private boolean githubDownloadData = false; // Set as false for now so it disables the whole GitHub thing.
@ConfigEntry(path = "web.github.download-data", since = "1.5.0")
private boolean githubDownloadData = true;
@ConfigComment("Time in minutes between each connection to the GitHub API.")
@ConfigComment("This allows for up-to-the-minute information gathering.")
@ -188,7 +188,7 @@ public class Settings implements DataObject {
@ConfigComment("It helps to prevent previously downloaded data being lost due to a more recent connection that failed")
@ConfigComment("to connect to the GitHub API.")
@ConfigComment("Such files are stored in JSON format and do not usually take up more than a few kilobytes of disk space each.")
@ConfigEntry(path = "web.github.flush-data-to-files", since = "1.3.0", hidden = true)
@ConfigEntry(path = "web.github.flush-data-to-files", since = "1.5.0")
private boolean githubFlushDataToFiles = true;
@ConfigEntry(path = "web.updater.check-updates.bentobox", since = "1.3.0", hidden = true)

View File

@ -1,4 +1,4 @@
# BentoBox Configuration 1.4.0
# BentoBox Configuration 1.5.0-SNAPSHOT
# This config file is dynamic and is updated right after BentoBox loaded its settings from it.
# You can edit it while the server is online and you can do '/bbox reload' to take the changes into account.
# However, it is a better practice to edit this file while the server is offline.
@ -32,7 +32,7 @@ general:
# Add other fake player names here if required
# /!\ This feature is experimental and might not work as expected or might not work at all.
fakeplayers:
- '[CoFH]'
- '[CoFH]'
# Rank required to use a command. e.g., use the invite command. Default is owner rank is required.
# /!\ This feature is experimental and might not work as expected or might not work at all.
rank-command: {}
@ -84,4 +84,17 @@ web:
# bStats has nearly no effect on your server's performance and the sent data is completely
# anonymous so please consider twice if you really want to disable it.
metrics: true
github:
# Toggle whether BentoBox can connect to GitHub to get data about updates and addons.
# Disabling this will result in the deactivation of the update checker and of some other
# features that rely on the data downloaded from the GitHub API.
# It does not send any data.
# Added since 1.5.0.
download-data: true
# Toggle whether the downloaded data should be flushed to files.
# It helps to prevent previously downloaded data being lost due to a more recent connection that failed
# to connect to the GitHub API.
# Such files are stored in JSON format and do not usually take up more than a few kilobytes of disk space each.
# Added since 1.5.0.
flush-data-to-files: true
uniqueId: config