Integration testing of Marketplace hut complete.

Author: armele

README.md

@@ -1,17 +1,43 @@
 MC Trade Post
 =======
 *Description*
+
 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.
 
-*How-To*
-Craft a Marketplace hut. Using the build tool, choose the Economics style, and contruct the Marketplace as you would any other hut. Interactions for the MC Trade Post mod are handled primarily in the Marketplace interface on that hut block.
+*In-Game How-To*
+
+Craft a Marketplace hut. Using the build tool, choose the "Economics" style from the MC Trade Post mod, and contruct the Marketplace as you would any other hut. Interactions for the MC Trade Post mod are handled primarily in the Marketplace interface on that hut block.
+
+*Custom Items*
+
+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.
+
+*Custom Blocks*
+
+Marketplace Hut Block - Block implementation of the item above.
+
+==========
+*Compatibility Reference*
+
+mctradepost-0.0.4 -> MineColonies 1.1.950 (Minecraft 1.21.1)
+
+*Installation*
+
+Download the appropriate mctradepost-x.y.z.jar file from Github at the root project directory.
+Copy that Jar file into your mods directory.
+Note that MineColonies and its dependencies must be present to work.
+
 
+==========
 *Current Status*
+
 This mod can best be described as a "pre-alpha" state. It functionality may change rapidly and without warning.
 
-*Roadmap*
+*Roadmap (Roughly Prioritized)*
+
 Interface for spending earned income.
 - Unlock subsequent levels of the merchant building
 - Summon traders
@@ -23,6 +49,7 @@ Assembling colonies into collections (empire, state, etc.)
 Express shipping (intracolony and inter-colony) - faster item transport. Faster people transport.
 
 *Complete*
+
 Marketplace implementation for selling items.
 
 

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=1.0.0
+mod_version=0.0.4
 # 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

@@ -77,7 +77,7 @@ public void onBlockPlacedByBuildTool(
         if (tileEntity != null) {
             MCTradePostMod.LOGGER.info("Placing hut of type {}", tileEntity.getClass().getName());
         } else {
-            MCTradePostMod.LOGGER.info("Attempting to place a null tile entity.");
+            MCTradePostMod.LOGGER.error("Attempting to place a null tile entity.");
         }
 
         if (tileEntity instanceof final MCTPTileEntityColonyBuilding hut)

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

@@ -83,6 +83,7 @@ private int getStatFor(String id, String intervalArg) {
      */
     private void updateStats()
     {
+        // TODO: Add current balance field.
         int itemCount = getStatFor(ITEM_SOLD, selectedInterval);
         final Text countLabel = findPaneOfTypeByID("itemcount", Text.class);
         countLabel.setText(Component.literal(itemCount + ""));   

src/main/java/com/deathfrog/mctradepost/core/blocks/huts/MCTPBaseBlockHut.java

@@ -40,6 +40,11 @@ public EntityAIWorkShopkeeper generateAI()
     @Override
     public ResourceLocation getModel()
     {
+        // TODO: Fix [17May2025 13:09:20.953] [Render thread/WARN] [net.minecraft.client.renderer.texture.TextureManager/]: Failed to load texture: mctradepost:textures/entity/citizen/default/shopkeepermale1_b.png
+        // java.io.FileNotFoundException: mctradepost:textures/entity/citizen/default/shopkeepermale1_b.png
+        // TODO: Fix [18May2025 08:30:35.970] [Render thread/WARN] [net.minecraft.client.renderer.texture.TextureManager/]: Failed to load texture: mctradepost:textures/entity/citizen/default/shopkeepermale1_w.png
+        // java.io.FileNotFoundException: mctradepost:textures/entity/citizen/default/shopkeepermale1_w.png
+        
         // MCTradePostMod.LOGGER.info("Getting JobShopkeeper model {}", ModModelTypes.SHOPKEEPER_MODEL_ID);
         // MCTradePostMod.LOGGER.warn("Model load trace", new Exception("Model trace"));
         return ModModelTypes.SHOPKEEPER_MODEL_ID;

src/main/java/com/deathfrog/mctradepost/core/client/gui/modules/WindowEconModule.java

@@ -28,6 +28,7 @@
 public class ItemValueRegistry
 {
     private static final Map<Item, Integer> itemValues = new ConcurrentHashMap<>();
+
     private static boolean configured = false;
     private static boolean startTracking = false;
 
@@ -50,7 +51,6 @@ public static void generateValues()
         Level level = server.overworld();
         RecipeManager recipeManager = level.getRecipeManager();
 
-        // TODO: Cut back on the logging once satisfied with the value system.
         for (Item item : BuiltInRegistries.ITEM)
         {
             if (itemValues.containsKey(item)) {
@@ -278,6 +278,24 @@ public static Set<ItemStorage> getSellableItems()
             .collect(Collectors.toSet());
     }
 
+    /**
+     * Retrieves a set of item keys representing sellable items.
+     * Logs an error message if the item values map is empty.
+     *
+     * @return a set of strings representing the keys of sellable items.
+     */
+    public static Set<String> getSellableItemKeys()
+    {
+        if (itemValues.isEmpty())
+        {
+            MCTradePostMod.LOGGER.error("getSellableItemKeys called when itemValues is empty");
+        }
+        return itemValues.entrySet().stream()
+            .filter(e -> e.getValue() > 0)
+            .map(e -> e.getKey().toString())
+            .collect(Collectors.toSet());
+    }
+
     /**
      * Logs all known item values to the mod logger.
      */    
@@ -327,5 +345,10 @@ private static void loadInitialValuesFromJson() {
 
         MCTradePostMod.LOGGER.info("Item seed values loaded.");
         // logValues();
+    }
+
+    /* In theory this should only be called on the client side after deserializing... */
+    public static void deserializedSellableItem(String s, int value) {
+        itemValues.putIfAbsent(BuiltInRegistries.ITEM.get(ResourceLocation.parse(s)), value);
     }    
 } 

src/main/java/com/deathfrog/mctradepost/core/colony/jobs/JobShopkeeper.java

@@ -129,9 +129,12 @@ public void lostShelfAtDisplayPos(BlockPos pos) {
         if (displayShelfContents.containsKey(pos)) {
             List<ItemFrame> frames = colony.getWorld().getEntitiesOfClass(ItemFrame.class, new AABB(pos));
 
+            // If a new frame can be found at the expected position, use it.
             if (!frames.isEmpty()) {
                 displayShelfContents.put(pos, new DisplayCase(pos, frames.get(0).getUUID(), displayShelfContents.get(pos).getStack(), 0));
+            // Otherwise, issue a message about the missing frame.
             } else {
+                // TODO: Put some delay logic on the sending of this message so it isn't a constant spam.
                 displayShelfContents.put(pos, new DisplayCase(pos, null));
                 MCTradePostMod.LOGGER.warn("Missing a display frame at {}", pos);
                 MessageUtils.format("entity.shopkeeper.brokenframe").sendTo(getColony()).forAllPlayers();
@@ -165,6 +168,20 @@ private void syncDisplayFramesWithSavedItems()
         }
     }
 
+    /**
+     * Initialize the display shelf locations based on what is tagged in the structure.
+     * This makes the building look for the correct number of display shelves even if some are missing.
+     * That way a "repair" action will fix the problem.
+     */
+    public void identifyExpectedShelfPositions() {
+        // We want any tagged display locations nto be added into the displayShelfContents if not already there.
+        final List<BlockPos> shelfLocations = getLocationsFromTag("display_shelf");
+
+        for (BlockPos pos : shelfLocations)
+        {
+            displayShelfContents.putIfAbsent(pos, new DisplayCase(pos, null));
+        }
+    }
 
     /**
      * Deserializes the NBT data for the building, restoring its state from the provided CompoundTag.
@@ -178,20 +195,8 @@ private void syncDisplayFramesWithSavedItems()
     public void deserializeNBT(@NotNull final HolderLookup.Provider provider, final CompoundTag compound)
     {
         super.deserializeNBT(provider, compound);
-        displayShelfContents.clear();
-
-        final List<BlockPos> shelfLocations = getLocationsFromTag("display_shelf");
-        MCTradePostMod.LOGGER.info("Shelf locations, as reported by structure tagging: {}", shelfLocations.size());
-
-        // Initialize the display shelf locations based on what is tagged in the structure.
-        // This makes the building look for the correct number of display shelves even if some are missing.
-        // That way a "repair" action will fix the problem.
-        for (BlockPos pos : shelfLocations)
-        {
-            displayShelfContents.put(pos, new DisplayCase(pos, null));
-        }
 
-        // Then fill in those locations with the saved items.
+        // Fill in display shelf locations with the saved items.
         ListTag shelfTagList = compound.getList(TAG_DISPLAYSHELVES, Tag.TAG_COMPOUND);
         for (int i = 0; i < shelfTagList.size(); ++i)
         {

src/main/java/com/deathfrog/mctradepost/core/colony/jobs/buildings/modules/ItemValueRegistry.java

@@ -26,6 +26,8 @@
 import net.minecraft.world.level.Level;
 import org.jetbrains.annotations.NonNls;
 import org.jetbrains.annotations.NotNull;
+import java.util.Map;
+
 import com.minecolonies.api.util.InventoryUtils;
 import static com.minecolonies.api.entity.ai.statemachine.states.AIWorkerState.*;
 import static com.minecolonies.api.util.constant.Constants.*;
@@ -37,7 +39,8 @@
 
 
 /**
- * Handles the Marketplace.
+ * Handles the Shopkeeper AI.  The shopkeeper works in the Marketplace.
+ * 
  */
 public class EntityAIWorkShopkeeper extends AbstractEntityAIInteract<JobShopkeeper, BuildingMarketplace>
 {
@@ -87,6 +90,9 @@ public class EntityAIWorkShopkeeper extends AbstractEntityAIInteract<JobShopkeep
     private final static VisibleCitizenStatus SELLING =
       new VisibleCitizenStatus(ResourceLocation.parse(MCTradePostMod.MODID + ":textures/icons/work/shopkeeper.png"), "com.mctradepost.gui.visiblestatus.shopkeeper");
 
+    private final static VisibleCitizenStatus COMMUTING =
+      new VisibleCitizenStatus(ResourceLocation.parse(MCTradePostMod.MODID + ":textures/icons/work/shopkeeper_commute.png"), "com.mctradepost.gui.visiblestatus.shopkeeper");
+
     /**
      * Constructor for the AI
      *
@@ -238,21 +244,33 @@ private IAIState getMaterials()
      */
     private IAIState decideWhatToDo()
     {
-        worker.getCitizenData().setVisibleStatus(VisibleCitizenStatus.WORKING);
+
+        worker.getCitizenData().setVisibleStatus(COMMUTING);
 
         if (!walkToBuilding())
         {
             setDelay(2);
             return getState();
         }
+        
+        worker.getCitizenData().setVisibleStatus(VisibleCitizenStatus.WORKING);
 
         final BuildingMarketplace building = this.building;
-        // Map<BlockPos, DisplayCase> displayShelves = building.getDisplayShelves();
 
+        building.identifyExpectedShelfPositions();
+
+        Map<BlockPos, DisplayCase> displayShelves = building.getDisplayShelves();
         // MCTradePostMod.LOGGER.info("Deciding what to do. Display shelves: {}", displayShelves.size());
 
+        if (displayShelves.isEmpty()) {
+            MCTradePostMod.LOGGER.warn("No display frames were found for the shopkeeper to use.");
+            MessageUtils.format("entity.shopkeeper.noframes").sendTo(building.getColony()).forAllPlayers();
+            setDelay(DECIDE_DELAY);
+            return PAUSED;
+        }
+
         // First pass: Find any empty item frame (considered available to fill)
-        for (final BlockPos displayLocation : building.getDisplayShelves().keySet())
+        for (final BlockPos displayLocation : displayShelves.keySet())
         {
             DisplayCase displayCase = building.getDisplayShelves().get(displayLocation);
             final Level world = building.getColony().getWorld();
@@ -294,25 +312,12 @@ private IAIState decideWhatToDo()
                         return CRAFT;
                     } else if (ticks >= 0) {
                         displayCase.setTickcount(ticks + 1);
-                    } else { // Something got put in the display frame but not by the builder.  Remove it!
-                        ItemStack frameItem = frame.getItem();
-                        if (!frameItem.isEmpty())
-                        {
-                            // Remove the item from the frame
-                            frame.setItem(ItemStack.EMPTY);
-
-                            // Attempt to insert into the worker's inventory
-                            ItemStack leftover = InventoryUtils.addItemStackToItemHandlerWithResult(worker.getInventoryCitizen(), frameItem);
-
-                            // If inventory is full and there are leftovers, drop it at the worker's feet
-                            if (!leftover.isEmpty()) {
-                                InventoryUtils.spawnItemStack(world, worker.getX(), worker.getY(), worker.getZ(), leftover);
-                            }
-
-                            MCTradePostMod.LOGGER.info("Shopkeeper removed unauthorized item {} from display at {}", frameItem, pos);
-
-                        }
-
+                    } else { 
+                        // We are going to rely on sellFromDisplay (from CRAFT state) to take the item out.
+                        this.currentTarget = pos;
+                        setDelay(DECIDE_DELAY);
+                        worker.getCitizenData().setVisibleStatus(SELLING);
+                        return CRAFT;
                     }
 
                 }
@@ -325,6 +330,7 @@ private IAIState decideWhatToDo()
 
     /**
      * The AI will now remove the item from the display stand that he found full on his building and "sell" it, adding experience and stats.
+     * Triggered from the CRAFT state.
      * @return the next IAIState after doing this
      */
     private IAIState sellFromDisplay()
@@ -338,16 +344,33 @@ private IAIState sellFromDisplay()
             ItemStack item = frame.getItem();
             if (!item.isEmpty())
             {
-                // "Sell" the item — remove it from the frame
-                frame.setItem(ItemStack.EMPTY);         // Empty the visual frame
-                sellItem(item);                         // Calculate the value of the item and credit it to the economic module and stats module.
-                displayCase.setStack(ItemStack.EMPTY);  // Note that the display case is empty
-                displayCase.setTickcount(-1);           // Reset the timer.
+                final List<ItemStorage> list = building.getModuleMatching(ItemListModule.class, m -> m.getId().equals(SELLABLE_LIST)).getList();
 
-                // Add experience, stats, etc.
-                worker.getCitizenExperienceHandler().addExperience(BASE_XP_GAIN);
-                incrementActionsDoneAndDecSaturation();
+                if (list.contains(new ItemStorage(item)))
+                {
+                    // "Sell" the item — remove it from the frame
+                    frame.setItem(ItemStack.EMPTY);         // Empty the visual frame
+                    sellItem(item);                         // Calculate the value of the item and credit it to the economic module and stats module.
+
+                    // Add experience, stats, etc.
+                    worker.getCitizenExperienceHandler().addExperience(BASE_XP_GAIN);
+                    incrementActionsDoneAndDecSaturation();                    
+                } else {
+                    // Remove the invalid item from the frame
+                    frame.setItem(ItemStack.EMPTY);
+
+                    // Attempt to insert into the worker's inventory
+                    ItemStack leftover = InventoryUtils.addItemStackToItemHandlerWithResult(worker.getInventoryCitizen(), item);
+
+                    // If inventory is full and there are leftovers, drop it at the worker's feet
+                    if (!leftover.isEmpty()) {
+                        InventoryUtils.spawnItemStack(world, worker.getX(), worker.getY(), worker.getZ(), leftover);
+                    }
 
+                    MCTradePostMod.LOGGER.info("Shopkeeper removed unauthorized item {} from display at {}", item, currentTarget);
+                }
+                displayCase.setStack(ItemStack.EMPTY);  // Note that the display case is empty
+                displayCase.setTickcount(-1);           // Reset the timer.
             }
         }