Finalized configuration and coin implementation.

Author: armele

README.md

@@ -4,7 +4,7 @@
 
 This mod extends the MineColonies mod.  It, and it's dependencies, are required for MC Trade Post to function.
 
-MC Trade Post introduces an economic system which allows the selling of excess items for Minecash (‡). These accounts can be used for a variety of purposes, such as bribing raiders to leave the town alone, and unlocking additional upgrades and features.  
+MC Trade Post introduces an economic system which allows the selling of excess items for Trade Coins (‡). These coins can be used for a variety of purposes, such as bribing raiders to leave the town alone, unlocking vacations and resorts at which your colonists can improve stats and get happier, and other additional upgrades and features.
 
 ### In-Game How-To
 
@@ -14,11 +14,16 @@ Craft a Marketplace hut. Using the build tool, choose the "Economics" style from
 
 Marketplace Hut - Supports the Marketplace building and the Shopkeeper job.  
 Advanced Clipboard - Just like the regular clipboard but with a button that filters the outstanding needs down to only those expected to be fulfilled by a player.  
+Trade Coin - These coins can be minted from the marketplace by sneak-right-clicking your advanced clipboard on the Marketplace hut. The hut must be upgraded, first! Trade Coins will (eventually) be used as the basis for triggering most Trade Post mod features.
 
 ### Custom Blocks
 
 Marketplace Hut Block - Block implementation of the item above.  
 
+### Configuration
+The value of a Trade Coin can be configured.
+The level of the marketplace required to mint coins can be configured.
+
 ## Installation
 
 Download the appropriate mctradepost-x.y.z.jar file from Github at the root project directory.  
@@ -27,7 +32,7 @@ Note that MineColonies and its dependencies must be present to work.
 
 ### Compatibility Reference
 
-mctradepost-0.0.4 -> MineColonies 1.1.950 (Minecraft 1.21.1)  
+mctradepost-0.1.003 -> MineColonies 1.1.950 (Minecraft 1.21.1)  
 
 ## Building Design Reference
 ### Marketplace
@@ -40,7 +45,7 @@ These frames should be mounted in empty (air) blocks tagged with the "display_sh
 This mod can best be described as a "pre-alpha" state. It functionality may change rapidly and without warning.
 
 ### Roadmap (Roughly Prioritized)
-External configurability
+
 Interface for spending earned income.  
 - Unlock subsequent levels of the merchant building  
 - Summon traders  
@@ -55,7 +60,7 @@ Express shipping (intracolony and inter-colony) - faster item transport. Faster
 ### Complete
 
 Marketplace implementation for selling items.  
-
+Ability to turn income into coin items (and vice-versa).
 
 ## Additional Resources
 

gradle.properties

@@ -32,7 +32,7 @@ mod_name=MC Trade Post
 # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
 mod_license=All Rights Reserved
 # The mod version. See https://semver.org/
-mod_version=0.1.0
+mod_version=0.1.003
 # The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
 # This should match the base package used for the mod sources.
 # See https://maven.apache.org/guides/mini/guide-naming-conventions.html

mctradepost-0.0.4.jar mctradepost-0.1.003.jarmctradepost-0.0.4.jar renamed to mctradepost-0.1.003.jar

@@ -1,16 +1,21 @@
 package com.deathfrog.mctradepost;
 
-import java.io.ObjectInputFilter.Config;
 import java.lang.reflect.Field;
+import java.util.HashMap;
+import java.util.Map;
 
+import com.deathfrog.mctradepost.network.ConfigurationPacket;
+
+import net.minecraft.server.MinecraftServer;
+import net.minecraft.server.level.ServerPlayer;
 import net.neoforged.bus.api.SubscribeEvent;
 import net.neoforged.fml.ModContainer;
 import net.neoforged.fml.common.EventBusSubscriber;
 import net.neoforged.fml.config.ModConfig;
 import net.neoforged.fml.event.config.ModConfigEvent;
 import net.neoforged.neoforge.common.ModConfigSpec;
 import net.neoforged.neoforge.common.ModConfigSpec.ConfigValue;
-import net.neoforged.neoforge.common.ModConfigSpec.IntValue;
+import net.neoforged.neoforge.server.ServerLifecycleHooks;
 
 
 // An example config class. This is not required, but it's a good idea to have one to keep your config organized.
@@ -21,29 +26,51 @@ public class MCTPConfig
     public static final ModConfigSpec.Builder BUILDER = new ModConfigSpec.Builder();
     public static final ModConfigSpec SPEC;
 
-    public static final ConfigValue<Integer> marketplaceLevel3;
+    // Server side Neoforge-managed configurations.
+    public static final ConfigValue<Integer> tradeCoinValue;
+    public static final ConfigValue<Integer> mintingLevel;
 
     static {
         BUILDER.push("marketplace");
 
-        marketplaceLevel3 = BUILDER
-            .comment("How much does unlocking the level 3 marketplace cost?")
-            .define("marketplaceLevel3", 500);
+        tradeCoinValue = BUILDER
+            .comment("What is the value of a Trade Coin (‡)?")
+            .define("tradeCoinValue", 500);
+
+        mintingLevel = BUILDER
+            .comment("At what building level can the Marketplace mint coins?")
+            .define("mintingLevel", 2);
 
         BUILDER.pop();
 
         SPEC = BUILDER.build(); // Last
 
-        // TODO: Eliminate once testing is complete.
-        MCTradePostMod.LOGGER.info("Static initialization of MCTPConfig complete.");
+        // MCTradePostMod.LOGGER.info("Static initialization of MCTPConfig complete.");
     }
 
 
+    /**
+     * Sets up the configuration on the server side and sends configuration packets to all connected players.
+     * This method ensures it's executed only on the server side by checking the LogicalSide.
+     * If a valid server instance is found, it iterates over all connected players and sends them
+     * the current configuration using the ConfigurationPacket. Logs the process for debugging purposes.
+     * 
+     * @param sourceEvent The event triggering the configuration setup.
+     */
     private static void setupConfiguration(final ModConfigEvent sourceEvent)
     {
-        // No-op
+        // Ensure this runs only on the dedicated or integrated server
+        MinecraftServer server = ServerLifecycleHooks.getCurrentServer();
+        if (server != null) {
+            for (ServerPlayer player : server.getPlayerList().getPlayers()) {
+                ConfigurationPacket.sendPacketsToPlayer(player);
+            }
+            MCTradePostMod.LOGGER.info("Config sent to all connected players.");
+        } else {
+            MCTradePostMod.LOGGER.error("Could not get server to send config.");
+        }
     }
-
+    
     @SubscribeEvent
     static void onLoad(final ModConfigEvent.Loading event)
     {
@@ -66,4 +93,102 @@ public static void register(ModContainer modContainer) {
         MCTradePostMod.LOGGER.info("Registering MCTPConfig to handle configurations.");
         modContainer.registerConfig(ModConfig.Type.COMMON, SPEC, "mctradepost-common.toml");
     }
+
+    /**
+     * Deserialize a configuration setting from a string to its corresponding value in the config class.
+     * @param configKey The key of the configuration setting to deserialize.
+     * @param configValue The value of the configuration setting as a string.
+     */
+    public static void deserializeConfigurationSetting(String configKey, String configValue) {
+        try {
+            Field field = MCTPConfig.class.getDeclaredField(configKey);
+
+            if (!ConfigValue.class.isAssignableFrom(field.getType())) {
+                MCTradePostMod.LOGGER.warn("Field '{}' is not a ConfigValue", configKey);
+                return;
+            }
+
+            field.setAccessible(true); // Allow access to private fields
+
+            @SuppressWarnings("unchecked")
+            ConfigValue<Object> configField = (ConfigValue<Object>) field.get(null); // Static field
+
+            // Infer value type and parse from string
+            Object parsedValue = parseValue(configField.get(), configValue);
+
+            if (parsedValue != null) {
+                configField.set(parsedValue);
+                MCTradePostMod.LOGGER.info("Updated config '{}' to '{}'", configKey, configField.get());
+            } else {
+                MCTradePostMod.LOGGER.warn("Could not parse value '{}' for '{}'", configValue, configKey);
+            }
+
+        } catch (NoSuchFieldException | IllegalAccessException e) {
+            MCTradePostMod.LOGGER.error("Error updating config '{}'", configKey, e);
+        }
+    }
+
+    /**
+     * Returns a map of configuration settings that can be serialized to a string.
+     * This includes all public static fields of type ConfigValue.
+     * The key in the map is the name of the field, and the value is the current value of that field as a string.
+     * @return A map of configuration settings that can be serialized to a string.
+     */
+    public static Map<String, String> getSerializableConfigSettings() {
+        Map<String, String> configMap = new HashMap<>();
+
+        for (Field field : MCTPConfig.class.getDeclaredFields()) {
+            if (ConfigValue.class.isAssignableFrom(field.getType())) {
+                try {
+                    field.setAccessible(true);
+
+                    @SuppressWarnings("unchecked")
+                    ConfigValue<Object> configField = (ConfigValue<Object>) field.get(null); // static field
+
+                    String key = field.getName();
+                    String value = String.valueOf(configField.get());
+
+                    configMap.put(key, value);
+                } catch (IllegalAccessException e) {
+                    MCTradePostMod.LOGGER.warn("Failed to read config field '{}'", field.getName(), e);
+                }
+            }
+        }
+
+        return configMap;
+    }
+
+
+    /**
+     * Parses a configuration value from a string to its corresponding value in the config class.
+     * Infer the value type from the type of the corresponding config field.
+     * @param currentValue The current value of the configuration setting.
+     * @param configValue The value of the configuration setting as a string.
+     * @return The parsed value or null if the parsing failed.
+     */
+    private static Object parseValue(Object currentValue, String configValue) {
+        try {
+            if (currentValue instanceof Integer) {
+                return Integer.parseInt(configValue);
+            } else if (currentValue instanceof Boolean) {
+                return Boolean.parseBoolean(configValue);
+            } else if (currentValue instanceof Double) {
+                return Double.parseDouble(configValue);
+            } else if (currentValue instanceof Float) {
+                return Float.parseFloat(configValue);
+            } else if (currentValue instanceof Long) {
+                return Long.parseLong(configValue);
+            } else if (currentValue instanceof String) {
+                return configValue;
+            } else {
+                // Add support for more types if needed
+                MCTradePostMod.LOGGER.warn("Unsupported config value type: {}", currentValue.getClass().getSimpleName());
+                return null;
+            }
+        } catch (Exception e) {
+            MCTradePostMod.LOGGER.error("Error parsing config value '{}'", configValue, e);
+            return null;
+        }
+    }
+
 }

src/main/java/com/deathfrog/mctradepost/MCTPConfig.java

@@ -15,6 +15,8 @@
 import com.deathfrog.mctradepost.core.colony.jobs.buildings.modules.ItemValueRegistry;
 import com.deathfrog.mctradepost.core.event.ClientRegistryHandler;
 import com.deathfrog.mctradepost.item.AdvancedClipboardItem;
+import com.deathfrog.mctradepost.item.CoinItem;
+import com.deathfrog.mctradepost.network.ConfigurationPacket;
 import com.deathfrog.mctradepost.network.ItemValuePacket;
 import com.minecolonies.api.blocks.ModBlocks;
 import com.mojang.logging.LogUtils;
@@ -28,6 +30,7 @@
 import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.CreativeModeTabs;
 import net.minecraft.world.item.Item;
+import net.minecraft.world.item.Rarity;
 import net.minecraft.world.level.block.Block;
 import net.neoforged.api.distmarker.Dist;
 import net.neoforged.api.distmarker.OnlyIn;
@@ -36,14 +39,12 @@
 import net.neoforged.fml.ModContainer;
 import net.neoforged.fml.common.EventBusSubscriber;
 import net.neoforged.fml.common.Mod;
-import net.neoforged.fml.config.ModConfig;
 import net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent;
 import net.neoforged.fml.event.lifecycle.FMLLoadCompleteEvent;
 import net.neoforged.neoforge.client.event.EntityRenderersEvent;
 import net.neoforged.neoforge.client.event.RegisterItemDecorationsEvent;
 import net.neoforged.neoforge.client.gui.ConfigurationScreen;
 import net.neoforged.neoforge.client.gui.IConfigScreenFactory;
-import net.neoforged.neoforge.common.ModConfigSpec;
 import net.neoforged.neoforge.common.NeoForge;
 import net.neoforged.neoforge.event.BuildCreativeModeTabContentsEvent;
 import net.neoforged.neoforge.event.entity.player.PlayerEvent;
@@ -351,6 +352,8 @@ public class MCTradePostMod
     public static final DeferredItem<AdvancedClipboardItem> ADVANCED_CLIPBOARD = ITEMS.register("advanced_clipboard",
         () -> new AdvancedClipboardItem(new Item.Properties().stacksTo(1)));
 
+    public static final DeferredItem<CoinItem> MCTP_COIN = ITEMS.register("mctp_coin", 
+        () -> new CoinItem(new Item.Properties().stacksTo(64).rarity(Rarity.UNCOMMON)));
 
     public static MCTPBaseBlockHut blockHutMarketplace;
 
@@ -403,7 +406,6 @@ public MCTradePostMod(IEventBus modEventBus, ModContainer modContainer)
         modEventBus.addListener(this::onLoadComplete);
 
         // Register our mod's ModConfigSpec so that FML can create and load the config file for us
-        // TODO: Once working, refactor into server/client/common pattern.
         MCTPConfig.register(modContainer);
 
         // This will use NeoForge's ConfigurationScreen to display this mod's configs
@@ -444,11 +446,19 @@ private void onLoadComplete(final FMLLoadCompleteEvent event) {
     @EventBusSubscriber(modid = MCTradePostMod.MODID, bus = EventBusSubscriber.Bus.MOD)
     public class NetworkHandler {
 
+        /**
+         * Handles the registration of network payload handlers for the mod.
+         * This method is invoked when the RegisterPayloadHandlersEvent is fired,
+         * allowing the mod to set up its network communication protocols.
+         *
+         * @param event The event that provides the registrar for registering payload handlers.
+         */
         @SubscribeEvent
         public static void onNetworkRegistry(final RegisterPayloadHandlersEvent event) {
             // Sets the current network version
             final PayloadRegistrar registrar = event.registrar("1");
 
+            // Register the payload handler for the ItemValuePacket - used to update the client with the list (and value) of sellable items.
             registrar.playBidirectional(
                 ItemValuePacket.TYPE,
                 ItemValuePacket.STREAM_CODEC,
@@ -457,41 +467,17 @@ public static void onNetworkRegistry(final RegisterPayloadHandlersEvent event) {
                     ItemValuePacket::handleDataInServerOnMain
                 )
             );        
-        }
 
-        /**
-         * This event fires on server-side both at initial world load and whenever a new player
-         * joins the server (with getPlayer() != null), and also on datapack reload (with null).
-         * Note that at this point the client has not yet received the recipes/tags.
-         *
-         * @param event {@link net.neoforged.neoforge.event.OnDatapackSyncEvent}
-         *   
-        @SubscribeEvent(priority = EventPriority.LOWEST)
-        public static void onDataPackSync(final OnDatapackSyncEvent event)
-        {
-            final MinecraftServer server = event.getPlayerList().getServer();
-            final GameProfile owner = server.getSingleplayerProfile();
-
-            if (event.getPlayer() == null)
-            {
-                // for a reload event, we also want to rebuild various lists (mirroring FMLServerStartedEvent)
-                ItemValueRegistry.generateValues();
-
-                // and then finally update every player with the results
-                for (final ServerPlayer player : event.getPlayerList().getPlayers())
-                {
-                    if (player.getGameProfile() != owner)   // don't need to send them in SP, or LAN owner
-                    {
-                        ItemValuePacket.sendPacketsToPlayer(player);
-                    }
-                }
-            }
-            else if (event.getPlayer().getGameProfile() != owner)
-            {
-                ItemValuePacket.sendPacketsToPlayer(event.getPlayer());
-            }
-        }       
-        */
+            // Register the payload handler for the ConfigurationPacket - used to update the client with configurations they need to be aware of.
+            registrar.playBidirectional(
+                ConfigurationPacket.TYPE,
+                ConfigurationPacket.STREAM_CODEC,
+                new DirectionalPayloadHandler<>(
+                    ConfigurationPacket::handleDataInClientOnMain,
+                    ConfigurationPacket::handleDataInServerOnMain
+                )
+            );              
+        }
 
         @EventBusSubscriber(modid = MCTradePostMod.MODID)
         public class ServerLoginHandler {
@@ -501,6 +487,7 @@ public static void onPlayerLogin(PlayerEvent.PlayerLoggedInEvent event) {
                 if (event.getEntity() instanceof ServerPlayer player) {
                     MCTradePostMod.LOGGER.debug("Synchronizing information to new player: {} ", player);
                     ItemValuePacket.sendPacketsToPlayer(player);
+                    ConfigurationPacket.sendPacketsToPlayer(player);
                 }
             }
         }

src/main/java/com/deathfrog/mctradepost/MCTradePostMod.java

@@ -8,6 +8,7 @@
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.neoforged.neoforge.registries.DeferredRegister;
 
+@SuppressWarnings("null")
 public class TileEntityInitializer
 {
     public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITIES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, MCTradePostMod.MODID);

src/main/java/com/deathfrog/mctradepost/apiimp/initializer/TileEntityInitializer.java

@@ -4,6 +4,7 @@
 import com.deathfrog.mctradepost.api.colony.buildings.ModBuildings;
 import com.minecolonies.api.colony.buildings.registry.BuildingEntry;
 
+
 public class BlockHutMarketplace extends MCTPBaseBlockHut {
     public BlockHutMarketplace() {
         super();