new readme

Author: Innectic

API/src/main/java/me/ifydev/dimensify/api/DimensifyConstants.java

@@ -126,7 +126,6 @@ public class DimensifyConstants {
             Arrays.asList(
                     "&a&l/dimensify unload <world> [save_map?]",
                     "&a&l/dimensify cache [purge]",
-                    "&a&l/dimensify list",
                     "&a&l/dimensify default [world]"
             )
     );

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

@@ -7,6 +7,7 @@
 import me.ifydev.dimensify.api.portal.PortalType;
 import me.ifydev.dimensifyspigot.DimensifyMain;
 import me.ifydev.dimensifyspigot.portal.SpigotPortalMeta;
+import org.bukkit.Bukkit;
 import org.bukkit.configuration.ConfigurationSection;
 import org.bukkit.configuration.InvalidConfigurationException;
 import org.bukkit.configuration.file.FileConfiguration;
@@ -27,8 +28,6 @@ public class SpigotFlatFileHandler extends AbstractDataHandler {
     private File storageFile;
     private FileConfiguration storage;
 
-    private String defaultWorld;
-
     public SpigotFlatFileHandler(ConnectionInformation connectionInformation) {
         super(connectionInformation);
     }
@@ -61,10 +60,6 @@ public void initialize(String defaultWorld) {
             plugin.getLogger().severe("Could not create storage.yml");
             e.printStackTrace();
         }
-
-        this.defaultWorld = defaultWorld;
-        String defaultDimension = this.getDefaultDimension(true);
-        if (!defaultDimension.equals("")) this.defaultWorld = defaultDimension;
     }
 
     @Override
@@ -239,7 +234,8 @@ public List<Dimension> getDimensions(boolean skipCache) {
 
     @Override
     public Optional<Dimension> getDimension(String name) {
-        if (name.equalsIgnoreCase(defaultWorld)) return Optional.of(new Dimension(defaultWorld, "", Optional.empty(), false));
+        String defaultDimension = getDefaultDimension(false);
+        if (name.equalsIgnoreCase(defaultDimension)) return Optional.of(new Dimension(defaultDimension, "", Optional.empty(), false));
         return this.dimensions.stream().filter(d -> d.getName().equalsIgnoreCase(name)).findFirst();
     }
 
@@ -254,17 +250,19 @@ public boolean setDefaultDimension(String name) {
 
         dimensions.stream().filter(d -> d.getName().equalsIgnoreCase(name)).findFirst().ifPresent(dim -> {
             dim.setDefault(true);
-            this.defaultWorld = dim.getName();
 
             storage.set("dimensions." + dim.getName() + ".default", true);
+            saveStorage();
         });
         return true;
     }
 
     @Override
     public String getDefaultDimension(boolean skipCache) {
-        if (skipCache)
-            for (Dimension dimension : this.getDimensions(false)) if (dimension.isDefault()) return dimension.getName();
-        return defaultWorld;
+        // TODO: We don't support skipping the cache in this case right now.
+        // It shouldn't be needed anyways, but /shrug
+
+        for (Dimension dimension : this.getDimensions(false)) if (dimension.isDefault()) return dimension.getName();
+        return Bukkit.getWorlds().get(0).getName();
     }
 }

DimensifySpigot/src/main/java/me/ifydev/dimensifyspigot/commands/handlers/BasicHandler.java

@@ -107,9 +107,8 @@ public static String deleteDimension(String dimension) {
             return DimensifyConstants.CANNOT_DELETE_MAIN_WORLD;
         DimensifyMain plugin = DimensifyMain.get();
 
-        if (!plugin.getApi().getDatabaseHandler().map(db -> db.getDimension(dimension).isPresent()).orElse(false))
-            plugin.getWorldController().loadWorld(new DimensifyWorld(dimension, plugin));
-        else return DimensifyConstants.INVALID_WORLD.replace("<WORLD>", dimension);
+        if (!plugin.getWorldController().getWorld(dimension, false).isPresent())
+            return DimensifyConstants.INVALID_WORLD.replace("<WORLD>", dimension);
 
         // World exists, delete it
         boolean deleted = plugin.getWorldController().deleteWorld(dimension);

DimensifySpigot/src/main/java/me/ifydev/dimensifyspigot/commands/handlers/PortalHandler.java

@@ -50,7 +50,7 @@ public static String deletePortal(String portal) {
         if (!db.get().getPortal(portal).isPresent())
             return DimensifyConstants.PORTAL_DOES_NOT_EXIST.replace("<PORTAL>", portal);
         return db.get().removePortal(portal)
-                ? DimensifyConstants.PORTAL_DELETED : DimensifyConstants.COULD_NOT_CONNECT_TO_DATABASE;
+                ? DimensifyConstants.PORTAL_DELETED.replace("<PORTAL>", portal) : DimensifyConstants.COULD_NOT_CONNECT_TO_DATABASE;
     }
 
     public static String linkPortal(String portal, String destination) {

README.md

@@ -1,2 +1,166 @@
 # Dimensify
-Create multiple worlds that can be warped between in one server
+
+Configure and manage multiple worlds within Minecraft.
+
+# Commands
+
+All commands in this plugin have permissions.
+
+To even run the `/dimensify` command, this requires `dimensify.command.base`
+
+## `/dimensify create <dimension_type> <name> [args...]`
+
+Create a new dimension.
+
+Permission: `dimensify.dimension.create`
+Arguments:
+  * `dimension_type`
+    - `flat`
+    - `default`
+    - `amplified`
+    - `large_biomes`
+    - `customized`
+    - `DEFAULT_1_1`
+
+Dimension type is what kind of generation to use. Possible values are displayed above.
+    
+Arguments:
+  * `name`
+  
+  This is the name of the dimension. It will be used whenever you're trying to go to the dimension, link portals, send players, etc.
+
+  The remaining arguments of this command are used for customizing the world generation.
+  
+  For example, if you wanted to have structures in your world, the command might be:
+  
+  `/dimensify create default testing structures`
+  
+  To add a seed:
+  
+  `/dimensify create default testing structures seed=somethingcool`
+  
+  To set the environment:
+  
+  `/dimensify create default testing structures seed=somethingcool env=nether`
+  
+  Possible values for `env`:
+  
+  - nether
+  - normal
+  - the_end
+
+## ``/dimensify send <player> <dimension>`
+
+Send a player to a dimension.
+
+Permission: `dimensify.send`
+
+* `player`
+
+The player you would like to send
+
+Arguments:
+* `dimension`
+
+The name of the dimension you would like to send them to
+
+## `/dimensify go <dimension>`
+
+Send yourself to a dimension
+
+Permission: `dimensify.go`
+
+Arguments:
+* `dimension`
+
+The name of the dimension you would like to go to
+
+## `/dimensify delete <dimension>`
+
+Delete a dimension.
+
+Permission: `dimensify.dimension.delete`
+
+Arguments:
+* `dimension`
+
+The name of the dimension you would like to delete
+
+## `/dimensify portal create <name>`
+
+Create a new portal for linking.
+
+Permission: `dimensify.portal.create`
+
+Arguments:
+* `name`
+
+The name of the new portal
+
+## `/dimensify portal delete <name>`
+
+Delete a portal.
+
+Permission: `dimensify.portal.delete`
+
+Arguments:
+* name
+
+The name of the portal that should be deleted
+
+## `/dimensify portal link <source_portal> <destination_dimension>`
+
+Link a portal to a dimension.
+
+Permission: `dimensify.portal.link`
+
+Arguments:
+* `source_portal`
+
+The name of the portal that you have created previously using `/dimensify portal create`
+
+* `destination_dimension`
+
+The name of the dimension that the portal should send the player to
+
+## `/dimensify portal list`
+
+List all registered portals
+
+Permission: `dimensify.list.portals`
+
+## `/dimensify list`
+
+List all registered worlds
+
+Permission: `dimensify.list.dimensions`
+
+## `/dimensify unload <world> [save_map?]`
+
+Unload a world from memory.
+
+Permission: `dimensify.dimension.unload`
+
+Arguments:
+- `world`
+
+The name of the world to unload
+
+- `save_map`
+
+This is an optional argument. It is a boolean value, meaning only `true` and `false` work.
+
+If this value is true, the map will be saved before getting unloaded.
+
+## `/dimensify default [world]`
+
+Get or set the default world.
+
+Permission: `dimensify.default`
+
+If no arguments are provided, this command will give you the default world.
+
+Arguments:
+- `world`
+
+The world to set the default to