TrueOG Release v1.1

TrueOG Version 1.1 (Core 1.3.1) has the following new features and bug fixes:
- Multiple configurable lobby types
- Updated /hbcreatelobby to require a lobby type
- Added /hbreloadconfigs to reload the configs without a server restart
- Added silent game state update that doesn't call its event
- Game state is now set to dead during lobby shutdown
- Updated HB join messages to include live games
- Updated HB join messages to send a message when there are no available lobbies
- World Manager will nolonger error when a greater max voting maps is configured. It will default to the max it can pick from.

Author: Gxorge

README.md

@@ -21,9 +21,10 @@ The plugin currently does not generate this automatically and therefore it must
 - /hbforcestart [time] - force the game to start at a specified time - theherobrine.command.forcestart
 - /hbdropshard - force the shard carrier to drop the shard +10 blocks on the x-axis - theherobrine.command.dropshard
 - /hbjoin [lobby id] - allows players to join a lobby - no permission
-- /hbcreatelobby - create a new lobby - theherobrine.command.createlobby
+- /hbcreatelobby <configuration id> - create a new lobby - theherobrine.command.createlobby
 - /hbdeletelobby <lobby id> - delete a lobby - theherobrine.command.deletelobby
 - /hbspectate - switch from playing to spectating whilst in-lobby - theherobrine.command.spectate
+- /hbreloadconfigs - reload lobby configs - theherobrine.reloadconfigs
 
 ### Kit Permissions
 Requiring permissions for classic and unlockable kits can be set in the config.yml.
@@ -38,18 +39,33 @@ Requiring permissions for classic and unlockable kits can be set in the config.y
 - Sorcerer - theherobrine.kit.unlockable.sorcerer
 
 ### Other Permissions
-- theherobrine.overfill - allow players to join above the limit 
+- theherobrine.overfill - allow players to join above the limit
+
+## Lobby Setup
+Within your `plugins/TheHerobrine-OG` folder you should have a folder called "lobbies". Within this, you can have yaml files for each of your lobby configurations. This is an example configuration:
+```yaml
+id: "default"         # Used internally for identification, and by the map base (see below)
+prefix: "HB"          # Lobby prefix to be used.
+minPlayers: 8         # Min players to start a game
+maxPlayers: 13        # Max players
+startTime: 90         # How long until the game starts when the min is reached
+allowOverfill: false  # Can players with the permission overfill the max?
+votingMaps: 4         # How many maps should be selected for voting, this should be no more than the amount in the map base config
+endVotingAt: 10       # What time does voting end? (in the starting countdown)
+autoStartAmount: 1    # How many lobbies should be auto started on boot?
+```
+This file and directory will be automatically created if they do not exist. (A default config will be created if there is zero in the folder.)
 
 ## Map Setup
-Your base server directory should include a folder called `maps` (or whatever set in the config.yml). Within this folder, there should be a file called `maps.yaml`. This is how a demo `maps.yaml` should look:
+Your base server directory should include a folder called `maps` (or whatever set in the config.yml). Within this folder, there should be a file for each of your configs (mentioned above) called `<config id>.yaml`. This is how it should look:
 ```yaml
 maps:
   - map1
   - map2
   - map3
 ```
 
-In your `maps` directory, there should be a folder with the name listed in `maps.yaml` with the world data and a file called `mapdata.yaml`.
+In your `maps` directory, there should be a folder with the name listed in `<config id>.yaml` with the world data and a file called `mapdata.yaml`.
 This files contains map information and the location of the survivor's spawn, herobrine's spawn, the alter location and the shard location.
 This is what an example file should look like:
 ```yaml

build.gradle

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "uk.hotten.herobrine"
-version = "1.3.1-1.0"
+version = "1.3.1-1.1"
 
 repositories {
     mavenLocal()

src/main/java/uk/hotten/herobrine/HerobrinePluginOG.java

@@ -37,9 +37,11 @@ public void onEnable() {
         getCommand("hbjoin").setExecutor(new JoinLobbyCommand());
         getCommand("hbjoin").setTabCompleter(new JoinLobbyCompleter());
         getCommand("hbcreatelobby").setExecutor(new CreateLobbyCommand());
+        getCommand("hbcreatelobby").setTabCompleter(new CreateLobbyCompleter());
         getCommand("hbdeletelobby").setExecutor(new DeleteLobbyCommand());
         getCommand("hbdeletelobby").setTabCompleter(new DeleteLobbyCompleter());
         getCommand("hbspectate").setExecutor(new SpectateCommand());
+        getCommand("hbreloadconfigs").setExecutor(new ReloadConfigsCommand());
 
         ScoreboardLib.setPluginInstance(this);
 

src/main/java/uk/hotten/herobrine/commands/CreateLobbyCommand.java

@@ -5,14 +5,28 @@
 import org.bukkit.command.CommandExecutor;
 import org.bukkit.command.CommandSender;
 import uk.hotten.herobrine.lobby.LobbyManager;
+import uk.hotten.herobrine.lobby.data.LobbyConfig;
 import uk.hotten.herobrine.utils.Message;
 
 public class CreateLobbyCommand implements CommandExecutor {
 
     @Override
     public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
-        sender.sendMessage(Message.format("Creating lobby..."));
-        String lobby = LobbyManager.getInstance().createLobby();
+        if (args == null || args.length == 0) {
+            sender.sendMessage(Message.format(ChatColor.RED + "Correct Usage: /hbcreatelobby <configuration id>"));
+            sendAvailable(sender);
+            return true;
+        }
+
+        LobbyConfig lobbyConfig = LobbyManager.getInstance().getLobbyConfig(args[0]);
+        if (lobbyConfig == null) {
+            sender.sendMessage(Message.format(ChatColor.RED + args[0] + " is not a valid configuration."));
+            sendAvailable(sender);
+            return true;
+        }
+
+        sender.sendMessage(Message.format("Creating lobby from config '" + lobbyConfig.getId() + "'..."));
+        String lobby = LobbyManager.getInstance().createLobby(lobbyConfig);
         if (lobby == null) {
             sender.sendMessage(Message.format(ChatColor.RED + "Failed to create lobby, please contact your administrator."));
             return true;
@@ -21,4 +35,9 @@ public boolean onCommand(CommandSender sender, Command cmd, String label, String
         sender.sendMessage(Message.format(ChatColor.GREEN + "Lobby " + lobby + " created successfully."));
         return true;
     }
+
+    private void sendAvailable(CommandSender sender) {
+        sender.sendMessage(Message.format(ChatColor.RED + "The following types are available:"));
+        LobbyManager.getInstance().getLobbyConfigsIds().forEach(id -> sender.sendMessage(Message.format(ChatColor.RED + " - " + id)));
+    }
 }

src/main/java/uk/hotten/herobrine/commands/CreateLobbyCompleter.java

@@ -0,0 +1,21 @@
+package uk.hotten.herobrine.commands;
+
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandSender;
+import org.bukkit.command.TabCompleter;
+import uk.hotten.herobrine.lobby.LobbyManager;
+
+import java.util.List;
+
+public class CreateLobbyCompleter implements TabCompleter {
+
+    @Override
+    public List<String> onTabComplete(CommandSender sender, Command cmd, String label, String[] args) {
+
+        if (args.length == 1) {
+            return LobbyManager.getInstance().getLobbyConfigsIds();
+        }
+
+        return null;
+    }
+}

src/main/java/uk/hotten/herobrine/commands/ReloadConfigsCommand.java

@@ -0,0 +1,28 @@
+package uk.hotten.herobrine.commands;
+
+import org.bukkit.ChatColor;
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandExecutor;
+import org.bukkit.command.CommandSender;
+import uk.hotten.herobrine.lobby.LobbyManager;
+import uk.hotten.herobrine.utils.Console;
+import uk.hotten.herobrine.utils.Message;
+
+public class ReloadConfigsCommand implements CommandExecutor {
+
+    @Override
+    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
+        sender.sendMessage(Message.format(ChatColor.YELLOW + "Note: This will not affect already created lobbies!"));
+        sender.sendMessage(Message.format("Reloading lobby configurations..."));
+        try {
+            LobbyManager.getInstance().checkAndLoadConfigs(false);
+
+            sender.sendMessage(Message.format(ChatColor.GREEN + "Successfully loaded " + LobbyManager.getInstance().getLobbyConfigsIds().size() + " lobby configuration(s)."));
+        } catch (Exception e) {
+            sender.sendMessage(Message.format(ChatColor.RED + "Failed to reload lobby configuration files. Please contact your administrator."));
+            Console.error("Failed to reload config files.");
+            e.printStackTrace();
+        }
+        return true;
+    }
+}

src/main/java/uk/hotten/herobrine/game/GameManager.java

@@ -108,10 +108,10 @@ public GameManager(JavaPlugin plugin, GameLobby gameLobby, RedisManager redis, P
         gameState = GameState.BOOTING;
         shardState = ShardState.WAITING;
 
-        requiredToStart = plugin.getConfig().getInt("minPlayers");
-        maxPlayers = plugin.getConfig().getInt("maxPlayers");
-        startTimer = plugin.getConfig().getInt("startTime");
-        allowOverfill = plugin.getConfig().getBoolean("allowOverfill");
+        requiredToStart = gameLobby.getLobbyConfig().getMinPlayers();
+        maxPlayers = gameLobby.getLobbyConfig().getMaxPlayers();
+        startTimer = gameLobby.getLobbyConfig().getStartTime();
+        allowOverfill = gameLobby.getLobbyConfig().isAllowOverfill();
         networkName = plugin.getConfig().getString("networkName");
         networkWeb = plugin.getConfig().getString("networkWeb");
         boolean lockClassicKits = plugin.getConfig().getBoolean("lockClassicKits");
@@ -182,6 +182,13 @@ public void run() {
         }.runTask(plugin);
     }
 
+    // Should only be used in GameLobby's shutdown to force the state to dead.
+    public void setGameStateSilently(GameState newState) {
+        GameState old = gameState;
+        gameState = newState;
+        Console.debug(gameLobby, "Game state silently updated to " + newState.toString() + "(from " + old.toString() + ")!");
+    }
+
     public void setShardState(ShardState newState) {
         new BukkitRunnable() {
 
@@ -205,7 +212,7 @@ public void startWaiting() {
 
         // In case the timer decreased from players leaving and a world was loaded
         Bukkit.getServer().getScheduler().runTask(plugin, () -> gameLobby.getWorldManager().clean(false));
-        startTimer = plugin.getConfig().getInt("startTime");
+        startTimer = getGameLobby().getLobbyConfig().getStartTime();
 
         waitingRunnable = new WaitingRunnable(this).runTaskTimerAsynchronously(plugin, 0, 10);
     }

src/main/java/uk/hotten/herobrine/lobby/GameLobby.java

@@ -14,8 +14,10 @@
 import uk.hotten.herobrine.data.RedisManager;
 import uk.hotten.herobrine.game.GameManager;
 import uk.hotten.herobrine.game.runnables.MapVotingRunnable;
+import uk.hotten.herobrine.lobby.data.LobbyConfig;
 import uk.hotten.herobrine.stat.StatManager;
 import uk.hotten.herobrine.utils.Console;
+import uk.hotten.herobrine.utils.GameState;
 import uk.hotten.herobrine.world.WorldManager;
 
 import java.util.ArrayList;
@@ -24,6 +26,7 @@ public class GameLobby {
 
     private JavaPlugin plugin;
 
+    @Getter private LobbyConfig lobbyConfig;
     @Getter private String lobbyId;
 
     @Getter private GameManager gameManager;
@@ -35,8 +38,9 @@ public class GameLobby {
 
     @Getter private ArrayList<Player> players;
 
-    public GameLobby(JavaPlugin plugin, String lobbyId) {
+    public GameLobby(JavaPlugin plugin, LobbyConfig lobbyConfig, String lobbyId) {
         this.plugin = plugin;
+        this.lobbyConfig = lobbyConfig;
         this.lobbyId = lobbyId;
     }
 
@@ -73,6 +77,7 @@ public void shutdown(boolean removeSelf, boolean recreate) {
         Console.info("Lobby " + lobbyId + " is shutting down...");
         HandlerList.unregisterAll(gameManager.getGmListener());
         HandlerList.unregisterAll(worldManager);
+        gameManager.setGameStateSilently(GameState.DEAD);
         gameManager.updateTags(GameManager.ScoreboardUpdateAction.BEGONETHOT);
         gameManager.getScoreboards().values().forEach(Scoreboard::deactivate);
         gameManager.getScoreboards().clear();
@@ -85,6 +90,6 @@ public void shutdown(boolean removeSelf, boolean recreate) {
         Console.info("Lobby " + lobbyId + " has shutdown.");
 
         if (recreate)
-            LobbyManager.getInstance().createLobby();
+            LobbyManager.getInstance().createLobby(lobbyConfig);
     }
 }