Documentation stuff

Author: Innectic

API/src/main/java/me/ifydev/dimensify/api/backend/BackendType.java

@@ -14,7 +14,7 @@
 @AllArgsConstructor
 @Getter
 public enum BackendType {
-    FLAT_FILE(Optional.empty(), "Flat file"),
+    FLAT_FILE(Optional.empty(), "FlatFile"),
     MYSQL(Optional.of(SQLHandler.class), "MySQL"),
     SQLITE(Optional.of(SQLHandler.class), "SQLite");
 

DimensifySpigot/src/main/java/me/ifydev/dimensifyspigot/DimensifyMain.java

@@ -53,6 +53,9 @@ public class DimensifyMain extends JavaPlugin {
     @Getter private WorldController worldController;
     @Getter private PortalRegistry portalRegistry;
 
+    @Getter private boolean allowEntryByDefault = true;
+    @Getter private boolean permissionRestrictDimensions = false;
+
     @Override
     public void onEnable() {
         createConfig();

DimensifySpigot/src/main/java/me/ifydev/dimensifyspigot/backend/SpigotFlatFileHandler.java

@@ -47,7 +47,7 @@ public void initialize() {
         File data = plugin.getDataFolder();
 
         // Ensure the files exist
-        storageFile = new File(data, "storage.yml");
+        storageFile = new File(data, plugin.getConfig().getString("connection.file", "storage.yml"));
         if (!storageFile.exists()) {
             storageFile.getParentFile().mkdirs();
             plugin.saveResource("storage.yml", false);

DimensifySpigot/src/main/java/me/ifydev/dimensifyspigot/commands/DimensifyCommand.java

@@ -110,9 +110,10 @@ public boolean onCommand(CommandSender sender, Command command, String s, String
 
                 meta.getSeed().ifPresent(seed -> creator.seed(Long.valueOf(seed)));
 
-                Bukkit.getScheduler().runTask(plugin, () -> plugin.getWorldController().loadWorld(creator));
-                plugin.getLogger().info("Finished generating world '" + worldName + "'!");
-                sender.sendMessage(ColorUtil.makeReadable(DimensifyConstants.WORLD_CREATED.replace("<WORLD>", worldName)));
+                Bukkit.getScheduler().runTask(plugin, () -> {
+                    plugin.getWorldController().loadWorld(creator);
+                    sender.sendMessage(ColorUtil.makeReadable(DimensifyConstants.WORLD_CREATED.replace("<WORLD>", worldName)));
+                });
                 return;
             } else if (args[0].equalsIgnoreCase("go")) {
                 if (!(sender instanceof Player)) {

DimensifySpigot/src/main/resources/config.yml

@@ -1,11 +1,31 @@
+# This is the backend that will be used for storing data within Dimensify.
+# The following options are valid: `sqlite`, `flatfile`, and `mysql`.
 storage: sqlite
+# All options except for `file` are only used for MySQL`.
+# When the storage is `sqlite`, the file name for the database will be the name you selected within
+# `file`, with `.db` appended to the end.
+# However, when `storage` is `flatfile`, then it will be `file` with `.yml` appended to the end.
 connection:
   host: localhost
   port: 3306
   database: dimensify
   username: dimensify
   password: magicalpassword
-  file: dimensify.db
+  file: dimensify
+
+# Setting `permission_restrict_dimensions` to `true` will make all dimensions require permissions in
+# the following format: `dimension.<dimension_name>.allow` or `dimension.<dimension_name>.deny`.
+# If the permission is not present on the player, then we'll use the value from `default_dimension_restriction`.
+permission_restrict_dimensions: false
+# `true` allows entry by default, `false` denies entry by default.
+default_dimension_restriction: true
 
 preload_worlds: false
-worlds:
+# To set worlds to be preloaded on server startup, add them to the `world_preload` list.
+# Ex:
+# world_preload:
+#   - something
+#   - another
+#
+# For worlds to preload, the option `preload_worlds` must be set to true as well.
+world_preload: