MiguelEconomy X EasyNPC

Turn your EasyNPC characters into real shopkeepers — powered by MiguelEconomy.

This mod is an addon that bridges two popular mods: EasyNPC (which lets you place and customize NPC characters) and MiguelEconomy (which adds an in-game currency system). Together they let players walk up to an NPC, open a shop, and buy or sell items using coins — no command blocks, no complicated setup.

---

What This Mod Does

• NPC Shops — Assign a shop to any EasyNPC character. Players can open it by right-clicking the NPC.
• Buy & Sell — Each item in a shop can be set to allow buying, selling, or both, each at its own price.
• Progression System — Players earn ranks as they play (based on money earned and job levels). Higher ranks unlock access to better shops and exclusive items.
• Shop Builder — Server operators can build and edit shops directly in-game through a visual menu, without touching any files.
• JSON Config — All shops and NPC assignments are stored in easy-to-read JSON files in the server's config folder, so advanced users can edit them directly if they prefer.

---

Requirements

Mod	Required?
Minecraft Forge 1.20.1	Yes
MiguelEconomy	Yes (handles the currency)
EasyNPC	Yes (provides the NPCs)

---

How to Use

For Players

1. Walk up to an NPC that has a shop assigned and right-click it.
2. A shop window opens. Browse the items listed.
3. Click Buy to purchase an item (coins are deducted from your balance) or Sell to turn items in your inventory into coins.
4. Some items or shops are locked behind a rank. Open the Progression screen (available from the shop screen) to see your current rank and what you need to reach the next one.

For Server Operators — Setting Up a Shop

Option A: In-Game Shop Builder

1. Use the /shop create command (requires operator permission).
2. The Shop Builder menu opens. Add items, set buy/sell prices, and save.
3. Once saved, open the NPC binding config file and link the shop ID to the NPC's name or UUID.

Option B: JSON Files

1. Start the server once — it will create the config folder at:

   config/migueleconomy_easynpc/npc_shops/
   

2. Each .json file in that folder represents one NPC's shop. You can copy and edit example_npc.json as a starting point.
3. Restart the server, or run /shop reload, to apply changes.

Example NPC shop file:

{
  "shops": [
    {
      "id": "basic_goods",
      "title": "Basic Goods",
      "description": "Everyday supplies.",
      "requiredTier": "survivor",
      "entries": [
        {
          "id": "bread",
          "item": { "itemId": "minecraft:bread", "count": 1 },
          "buyEnabled": true,
          "sellEnabled": false,
          "buyPrice": 10,
          "sellPrice": 0,
          "description": "A loaf of bread."
        }
      ]
    }
  ],
  "npcBindings": [
    {
      "npcName": "Merchant",
      "shopIds": ["basic_goods"]
    }
  ]
}

Tip: You can match an NPC by name (npcName) or by their exact UUID (npcUuid). Using UUID is more reliable if multiple NPCs share the same name.

Progression Tiers

Players start at the Survivor rank. As they earn money and level up jobs through MiguelEconomy, they automatically advance through ranks. Each rank can unlock:

• Access to entire shops
• Individual items within a shop

The tier list and requirements are configured in:

config/migueleconomy_easynpc/progression.json

---

Commands

Command	Permission	What it does
/level	Player	Opens your progression screen so you can see your current tier and unlock path
/shop create	Operator	Opens the in-game Shop Builder with a blank draft for a new shop
/shop builder	Operator	Opens the in-game Shop Builder
/shop builder open	Operator	Same as /shop builder; kept as a readable alias
/shop reload	Operator	Reloads shop, NPC binding, progression, and economy config without restarting
/shop debug	Operator	Shows shop/debug counts, detected EasyNPC entities, mapped NPCs, and economy adapter status
/he shopbuilder	Operator	Legacy alias for opening the Shop Builder
/he reloadshops	Operator	Legacy alias for /shop reload
/he debugshop	Operator	Legacy alias for /shop debug
/he settier <players> <tier>	Operator	Manually sets one or more players to a progression tier

/shop create, /shop builder, /shop reload, /shop debug, and the /he admin commands require operator permission level 2.

---

Config Folder Layout

config/
└── migueleconomy_easynpc/
    ├── progression.json       ← tier definitions and unlock requirements
    └── npc_shops/
        ├── example_npc.json   ← auto-generated sample, safe to delete
        └── your_npc.json      ← one file per NPC (or group of NPCs)