Merge pull request #2 from leo-210/feat/config

[Feat] Mod configuration

4 files changed, 320 insertions, 34 deletions

diff --git a/src/main/java/world/anhgelus/molehunt/Game.java b/src/main/java/world/anhgelus/molehunt/Game.java
index b116b72..54e5c3a 100644
--- a/src/main/java/world/anhgelus/molehunt/Game.java
+++ b/src/main/java/world/anhgelus/molehunt/Game.java
@@ -18,7 +18,7 @@ import java.util.stream.Collectors;
 public class Game {

 

     private Timer timer = new Timer();

-    public final static int DEFAULT_TIME = 90*60; // 1:30

+    public final static int DEFAULT_TIME = Molehunt.CONFIG.GAME_DURATION;

     private int remaining = DEFAULT_TIME;

 

     private final MinecraftServer server;

@@ -34,11 +34,17 @@ public class Game {
     }

 

     public void start() {

-        if (started) return;

-        final int n = (server.getCurrentPlayerCount() - server.getCurrentPlayerCount() % 4)/4;

+        final int n;

+        if (Molehunt.CONFIG.MOLE_COUNT < 0) {

+            n = Math.floorDiv(server.getCurrentPlayerCount(), Math.floorDiv(100, (int) Molehunt.CONFIG.MOLE_PERCENTAGE));

+        } else {

+            n = Molehunt.CONFIG.MOLE_COUNT;

+        }

+

         final var playerManager = server.getPlayerManager();

+

         final var players = new ArrayList<>(playerManager.getPlayerList());

-        for (int i = 0; i < n; i++) {

+        for (int i = 0; i < n && !players.isEmpty(); i++) {

             final var r = ThreadLocalRandom.current().nextInt(0, players.size());

             final var mole = players.get(r);

             if (mole == null) throw new IllegalStateException("Mole is null!");

@@ -54,7 +60,7 @@ public class Game {
         gamerules.get(GameRules.DO_IMMEDIATE_RESPAWN).set(true, server);

         gamerules.get(GameRules.DO_ENTITY_DROPS).set(false, server);

 

-        final var title = new TitleS2CPacket(Text.of("§eYou are..."));

+        final var title = new TitleS2CPacket(Text.translatable("molehunt.game.start.suspense"));

         playerManager.getPlayerList().forEach(p -> {

             p.kill();

             p.networkHandler.sendPacket(timing);

@@ -70,10 +76,10 @@ public class Game {
                 playerManager.getPlayerList().forEach(p -> {

                     p.networkHandler.sendPacket(timing);

                     if (moles.contains(p)) {

-                        p.networkHandler.sendPacket(new TitleS2CPacket(Text.of("§cThe Mole!")));

-                        p.networkHandler.sendPacket(new SubtitleS2CPacket(Text.of("§6get the list of moles with /molehunt moles")));

+                        p.networkHandler.sendPacket(new TitleS2CPacket(Text.translatable("molehunt.game.start.mole.title")));

+                        p.networkHandler.sendPacket(new SubtitleS2CPacket(Text.translatable("molehunt.game.start.mole.subtitle")));

                     } else {

-                        p.networkHandler.sendPacket(new TitleS2CPacket(Text.of("§aNot the Mole!")));

+                        p.networkHandler.sendPacket(new TitleS2CPacket(Text.translatable("molehunt.game.start.survivor")));

                     }

                     // reset health and food level

                     p.setHealth(p.getMaxHealth());

@@ -111,7 +117,7 @@ public class Game {
     }

 

     public void stop() {

-        server.getPlayerManager().broadcast(Text.of("Game stopped"), false);

+        server.getPlayerManager().broadcast(Text.translatable("commands.molehunt.stop.success"), false);

         end();

     }

 

@@ -120,7 +126,7 @@ public class Game {
         timer = new Timer();

         started = false;

         final var pm = server.getPlayerManager();

-        final var winnerSuspense = new TitleS2CPacket(Text.of("§eAnd the winners are..."));

+        final var winnerSuspense = new TitleS2CPacket(Text.translatable("molehunt.game.end.suspense.title"));

         pm.getPlayerList().forEach(p -> {

             p.networkHandler.sendPacket(timing);

             p.networkHandler.sendPacket(winnerSuspense);

@@ -131,25 +137,17 @@ public class Game {
             public void run() {

                 TitleS2CPacket winner;

                 if (gameWonByMoles()) {

-                    winner = new TitleS2CPacket(Text.of("§cThe Moles!"));

+                    winner = new TitleS2CPacket(Text.translatable("molehunt.game.end.winners.moles.title"));

                 } else {

-                    winner = new TitleS2CPacket(Text.of("§aNot the Mole!"));

+                    winner = new TitleS2CPacket(Text.translatable("molehunt.game.end.winners.survivors.title"));

                 }

-                pm.sendToAll(new SubtitleS2CPacket(Text.of("§6The Moles were " + getMolesAsString())));

+                pm.sendToAll(new SubtitleS2CPacket(Text.translatable("molehunt.game.end.winners.subtitle").append(getMolesAsString())));

                 pm.sendToAll(winner);

                 pm.sendToAll(timing);

             }

         }, 4*1000);

     }

 

-    public int getRemaining() {

-        return remaining;

-    }

-

-    public Text getRemainingText() {

-        return Text.of("Time remaining: "+ TimeUtils.printTime(remaining));

-    }

-

     public Text getShortRemainingText() {

         return Text.of("§c" + TimeUtils.printShortTime(remaining));

     }

@@ -162,7 +160,7 @@ public class Game {
         return moles.stream()

                 .map(ServerPlayerEntity::getDisplayName)

                 .filter(Objects::nonNull)

-                .map(Text::getString)

+                .map(Text::toString)

                 .collect(Collectors.joining(", "));

     }

 

diff --git a/src/main/java/world/anhgelus/molehunt/Molehunt.java b/src/main/java/world/anhgelus/molehunt/Molehunt.java
index 5273b21..5df63b1 100644
--- a/src/main/java/world/anhgelus/molehunt/Molehunt.java
+++ b/src/main/java/world/anhgelus/molehunt/Molehunt.java
@@ -1,6 +1,7 @@
 package world.anhgelus.molehunt;
 
 import com.mojang.brigadier.Command;
+import com.mojang.brigadier.exceptions.SimpleCommandExceptionType;
 import net.fabricmc.api.ModInitializer;
 import net.fabricmc.fabric.api.command.v2.CommandRegistrationCallback;
 import net.fabricmc.fabric.api.entity.event.v1.ServerLivingEntityEvents;
@@ -9,10 +10,11 @@ import net.fabricmc.fabric.api.message.v1.ServerMessageEvents;
 import net.minecraft.network.packet.s2c.play.OverlayMessageS2CPacket;
 import net.minecraft.server.command.ServerCommandSource;
 import net.minecraft.server.network.ServerPlayerEntity;
-import net.minecraft.text.Text;
+import net.minecraft.text.*;
 import net.minecraft.world.GameMode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import world.anhgelus.molehunt.config.Config;
 
 import java.util.HashMap;
 
@@ -23,6 +25,8 @@ public class Molehunt implements ModInitializer {
 
     public static final String MOD_ID = "molehunt";
     public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
+    public static final Config CONFIG = new Config(MOD_ID);
+
     public Game game;
 
     public static HashMap<ServerPlayerEntity, Boolean> timerVisibility = new HashMap<>();
@@ -37,20 +41,16 @@ public class Molehunt implements ModInitializer {
             game.start();
             return Command.SINGLE_SUCCESS;
         }));
-//        command.then(literal("time").executes(context -> {
-//            context.getSource().sendFeedback(() -> game.getRemainingText(), false);
-//            return Command.SINGLE_SUCCESS;
-//        }));
         command.then(literal("timer").requires(ServerCommandSource::isExecutedByPlayer).then(
                 literal("show").executes(context -> {
                     timerVisibility.put(context.getSource().getPlayer(), true);
-                    context.getSource().sendFeedback(() -> Text.of("Showing molehunt timer"), false);
+                    context.getSource().sendFeedback(() -> Text.translatable("commands.molehunt.timer.show"), false);
 
                     var player = context.getSource().getPlayer();
                     assert player != null;
 
                     if (game == null || !game.hasStarted()) {
-                        player.networkHandler.sendPacket(new OverlayMessageS2CPacket(Text.of("§cGame has not started yet")));
+                        player.networkHandler.sendPacket(new OverlayMessageS2CPacket(Text.translatable("commands.molehunt.stop.failed").setStyle(Style.EMPTY.withColor(16733525))));
                     } else {
                         player.networkHandler.sendPacket(new OverlayMessageS2CPacket(Text.of(game.getShortRemainingText())));
                     }
@@ -60,18 +60,17 @@ public class Molehunt implements ModInitializer {
         ).then(
                 literal("hide").executes(context -> {
                     timerVisibility.put(context.getSource().getPlayer(), false);
-                    context.getSource().sendFeedback(() -> Text.of("Hiding molehunt timer"), false);
+                    context.getSource().sendFeedback(() -> Text.translatable("commands.molehunt.timer.hide"), false);
                     return Command.SINGLE_SUCCESS;
                 })
         ));
-        command.then(literal("moles").requires(source -> (game != null) && game.isAMole(source.getPlayer())).executes(context -> {
-            context.getSource().sendFeedback(() -> Text.literal("List of moles: " + game.getMolesAsString()),false);
+        command.then(literal("moles").requires(source -> (game != null) && game.hasStarted() && game.isAMole(source.getPlayer())).executes(context -> {
+            context.getSource().sendFeedback(() -> Text.translatable("commands.molehunt.moles.list").append(" " + game.getMolesAsString()),false);
             return Command.SINGLE_SUCCESS;
         }));
         command.then(literal("stop").requires(source -> source.hasPermissionLevel(1)).executes(context -> {
             if (game == null || !game.hasStarted()) {
-                context.getSource().sendError(Text.of("Game has not started yet"));
-                return Command.SINGLE_SUCCESS;
+                throw (new SimpleCommandExceptionType(Text.translatable("commands.molehunt.stop.failed"))).create();
             }
 
             game.stop();
diff --git a/src/main/java/world/anhgelus/molehunt/config/Config.java b/src/main/java/world/anhgelus/molehunt/config/Config.java
new file mode 100644
index 0000000..75301ad
--- /dev/null
+++ b/src/main/java/world/anhgelus/molehunt/config/Config.java
@@ -0,0 +1,37 @@
+package world.anhgelus.molehunt.config;
+
+public class Config {
+    public final int GAME_DURATION;
+    public final double MOLE_PERCENTAGE;
+    public final int MOLE_COUNT;
+
+    public Config(String fileName) {
+        final SimpleConfig CONFIG = SimpleConfig.of(fileName).provider(Config::defaultConfig).request();
+
+        // In seconds
+        GAME_DURATION = CONFIG.getOrDefault("game_duration", 90) * 60;
+        MOLE_PERCENTAGE = CONFIG.getOrDefault("mole_percentage", 25);
+        MOLE_COUNT = CONFIG.getOrDefault("mole_count", -1);
+    }
+
+    private static String defaultConfig(String s) {
+        return """
+                # Molehunt mod configuration file
+
+                # The duration of a molehunt game, in minutes.
+                # Default : 90 minutes (1 hour 30 minutes).
+                game_duration = 90
+                
+                # Mole percentage.
+                # For example, a mole percentage of 25% will get 1 mole every 4 players.
+                # Default : 25 %.
+                mole_percentage = 25
+                
+                # Mole count (absolute).
+                # This setting will overwrite the mole_percentage setting.
+                # If set below 0, this setting is disabled.
+                # Default : -1.
+                mole_count = -1
+                """;
+    }
+}
diff --git a/src/main/java/world/anhgelus/molehunt/config/SimpleConfig.java b/src/main/java/world/anhgelus/molehunt/config/SimpleConfig.java
new file mode 100644
index 0000000..ef8bef3
--- /dev/null
+++ b/src/main/java/world/anhgelus/molehunt/config/SimpleConfig.java
@@ -0,0 +1,252 @@
+package world.anhgelus.molehunt.config;
+
+/*
+ * Copyright (c) 2021 magistermaks
+ * Slightly modified by Léo-21
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+import net.fabricmc.loader.api.FabricLoader;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Scanner;
+
+public class SimpleConfig {
+
+    private static final Logger LOGGER = LogManager.getLogger("SimpleConfig");
+    private final HashMap<String, String> config = new HashMap<>();
+    private final ConfigRequest request;
+    private boolean broken = false;
+
+    public interface DefaultConfig {
+        String get( String namespace );
+
+        static String empty( String namespace ) {
+            return "";
+        }
+    }
+
+    public static class ConfigRequest {
+
+        private final File file;
+        private final String filename;
+        private DefaultConfig provider;
+
+        private ConfigRequest(File file, String filename ) {
+            this.file = file;
+            this.filename = filename;
+            this.provider = DefaultConfig::empty;
+        }
+
+        /**
+         * Sets the default config provider, used to generate the
+         * config if it's missing.
+         *
+         * @param provider default config provider
+         * @return current config request object
+         * @see DefaultConfig
+         */
+        public ConfigRequest provider( DefaultConfig provider ) {
+            this.provider = provider;
+            return this;
+        }
+
+        /**
+         * Loads the config from the filesystem.
+         *
+         * @return config object
+         * @see SimpleConfig
+         */
+        public SimpleConfig request() {
+            return new SimpleConfig( this );
+        }
+
+        private String getConfig() {
+            return provider.get( filename ) + "\n";
+        }
+
+    }
+
+    /**
+     * Creates new config request object, ideally `namespace`
+     * should be the name of the mod id of the requesting mod
+     *
+     * @param filename - name of the config file
+     * @return new config request object
+     */
+    public static ConfigRequest of( String filename ) {
+        Path path = FabricLoader.getInstance().getConfigDir();
+        return new ConfigRequest( path.resolve( filename + ".properties" ).toFile(), filename );
+    }
+
+    private void createConfig() throws IOException {
+
+        // try creating missing files
+        request.file.getParentFile().mkdirs();
+        Files.createFile( request.file.toPath() );
+
+        // write default config data
+        PrintWriter writer = new PrintWriter(request.file, "UTF-8");
+        writer.write( request.getConfig() );
+        writer.close();
+
+    }
+
+    private void loadConfig() throws IOException {
+        Scanner reader = new Scanner( request.file );
+        for( int line = 1; reader.hasNextLine(); line ++ ) {
+            parseConfigEntry( reader.nextLine(), line );
+        }
+    }
+
+    private void parseConfigEntry( String entry, int line ) {
+        if( !entry.isEmpty() && !entry.startsWith( "#" ) ) {
+            String[] parts = entry.split("=", 2);
+            if( parts.length == 2 ) {
+                config.put( parts[0].stripTrailing(), parts[1].strip() );
+            }else{
+                throw new RuntimeException("Syntax error in config file on line " + line + "!");
+            }
+        }
+    }
+
+    private SimpleConfig( ConfigRequest request ) {
+        this.request = request;
+        String identifier = "Config '" + request.filename + "'";
+
+        if( !request.file.exists() ) {
+            LOGGER.info( identifier + " is missing, generating default one..." );
+
+            try {
+                createConfig();
+            } catch (IOException e) {
+                LOGGER.error( identifier + " failed to generate!" );
+                LOGGER.trace( e );
+                broken = true;
+            }
+        }
+
+        if( !broken ) {
+            try {
+                loadConfig();
+            } catch (Exception e) {
+                LOGGER.error( identifier + " failed to load!" );
+                LOGGER.trace( e );
+                broken = true;
+            }
+        }
+
+    }
+
+    /**
+     * Queries a value from config, returns `null` if the
+     * key does not exist.
+     *
+     * @return  value corresponding to the given key
+     * @see     SimpleConfig#getOrDefault
+     */
+    @Deprecated
+    public String get( String key ) {
+        return config.get( key );
+    }
+
+    /**
+     * Returns string value from config corresponding to the given
+     * key, or the default string if the key is missing.
+     *
+     * @return  value corresponding to the given key, or the default value
+     */
+    public String getOrDefault( String key, String def ) {
+        String val = get(key);
+        return val == null ? def : val;
+    }
+
+    /**
+     * Returns integer value from config corresponding to the given
+     * key, or the default integer if the key is missing or invalid.
+     *
+     * @return  value corresponding to the given key, or the default value
+     */
+    public int getOrDefault( String key, int def ) {
+        try {
+            return Integer.parseInt( get(key) );
+        } catch (Exception e) {
+            return def;
+        }
+    }
+
+    /**
+     * Returns boolean value from config corresponding to the given
+     * key, or the default boolean if the key is missing.
+     *
+     * @return  value corresponding to the given key, or the default value
+     */
+    public boolean getOrDefault( String key, boolean def ) {
+        String val = get(key);
+        if( val != null ) {
+            return val.equalsIgnoreCase("true");
+        }
+
+        return def;
+    }
+
+    /**
+     * Returns double value from config corresponding to the given
+     * key, or the default string if the key is missing or invalid.
+     *
+     * @return  value corresponding to the given key, or the default value
+     */
+    public double getOrDefault( String key, double def ) {
+        try {
+            return Double.parseDouble( get(key) );
+        } catch (Exception e) {
+            return def;
+        }
+    }
+
+    /**
+     * If any error occurred during loading or reading from the config
+     * a 'broken' flag is set, indicating that the config's state
+     * is undefined and should be discarded using `delete()`
+     *
+     * @return the 'broken' flag of the configuration
+     */
+    public boolean isBroken() {
+        return broken;
+    }
+
+    /**
+     * deletes the config file from the filesystem
+     *
+     * @return true if the operation was successful
+     */
+    public boolean delete() {
+        LOGGER.warn( "Config '" + request.filename + "' was removed from existence! Restart the game to regenerate it." );
+        return request.file.delete();
+    }
+
+}
\ No newline at end of file