GUI Shop

GuiShop is a Fabric server-side mod to create and manage GUI shops in Minecraft. It comes with its own economy but also integrates seamlessly with other economy providers. GuiShop started as a fork of UnsafeDodo's work, but has since been heavily modified to fit my needs.

Features

Support for multiple shops

Sell as many items you want

Shop view supports pagination

Support for multiple balances

Buy and sell one or multiple items at once

Bought items appear in your cursor

Other notable features:

• Drag and drop any items from your inventory to the shop. If it can be sold, it will be sold.
• Selling back a used item applies a configurable payout penalty, see Sell pricing.
• Shop items support item components (enchantments, custom names, custom model data, etc.).
• Supports multiple currencies, each item can be configured to use a different currency.
• Supports any economy mod that implements the Common Economy API.
• Has its own built-in economy provider that can be configured with multiple currencies and accounts.
  • These currencies can be used by other mods that use the Common Economy API.
  • Has commands to manage balances (view, send, add, remove).
  • Can simulate any real-life currency by configuring prefix, suffix, decimal places and an icon.
  • Shops can be opened through commands, allowing integration with NPC mods like Taterzens.
  • The mod supports LuckPerms for permissions.

Installation

Put the .jar file in the "mods" folder

(Requires Fabric API and (optionally) a supported Economy)

Commands and permissions

All commands can be used by admins (permission level 2 or higher, see each command below) or by users/groups with the specific permission

Commands examples

Create a shop: /guishop create "Test shop""

Add item in a shop: /guishop additem "Diamond" minecraft:diamond[minecraft:enchantment_glint_override=true,minecraft:custom_name=hello] 250 100 guishop:credit "This is a Diamond\\An expensive diamond\\Shiny" (you can split each description line by using "\\")

Item components are supported in the same way as in the /give command. You can use an item generator like mcstacker or the one from Gamergeeks to generate items with components like enchantments, custom names, etc. In-game, you'll also get suggestions for item components.

The buy and sell prices are without any formatting so say you configured 2 decimal places in your config and you want to sell an item for 1.50, you would use 150 as the sell price.

Remove item from shop: /guishop removeitem "Test shop" "Diamond"

Open a shop and show it to a specific player: /guishop open "Test shop" "Steve"

You can also add items only to be bought or sold in a shop. Items with a buy price of -1 can only be sold and items with a sell price of -1 can only be bought.

Configuration

Everything GuiShop writes lives under ./config/gui-shop/:

config/gui-shop/
├── config.json              # economy, database, commands and sell pricing
└── shops/
    ├── spawn_shop.snbt      # one file per shop, named after the shop id
    ├── farm_shop.snbt
    └── backups/             # copies taken automatically before a shop is upgraded to a newer Minecraft version

Shops are no longer part of the main config file. Each shop is its own .snbt file, which is Minecraft's own item format, so item components survive a Minecraft update instead of having to be re-entered by hand.

Main configuration

./config/gui-shop/config.json:

{
  "economyDisabled": false,
  "database": {
    "type": "sqlite",
    "fileLocation": "./world/guishop.sqlite"
  },
  "economy": {
    "currencies": {
      "credit": {
        "name": "Credits",
        "prefix": "$",
        "suffix": "",
        "decimalPlaces": 2,
        "icon": "minecraft:diamond"
      }
    },
    "accounts": {
      "account": {
        "name": "Account",
        "currency": "credit",
        "icon": "minecraft:diamond"
      }
    }
  },
  "command": {
    "disabled": false,
    "alias": ""
  },
  "economyProviders": {
    "guishop:credit": [
      "account"
    ]
  },
  "sellPricing": {
    "firstUsePenalty": 0.15,
    "minValueFraction": 0.05,
    "damageCurveExponent": 3.0,
    "repairCostPenaltyPerPoint": 0.02,
    "customNamePenalty": 0.1,
    "lorePenalty": 0.1
  }
}

economyDisabled, database and economy configure the built-in economy provider. Set economyDisabled to true if you only use another economy mod; the rest of that block is then ignored.

economyProviders selects which economies the shops actually use. It maps mod_id:currency_id to a list of account_ids. That can be an external economy mod that uses the Common Economy API, or the built-in provider, for the built-in one, prefix your configured currency with guishop:.

sellPricing sets the server-wide defaults for what a used item is worth when a player sells it back. Any shop can override these individually, see below.

Sell pricing

When a player sells an item back, GuiShop doesn't always pay the full sellPrice, it pays less if the item was damaged, repaired (which lowers max durability), renamed, or had its lore changed while the player owned it. This stops players from buying an item, using it for a while, and selling it back for the same price, and rewards selling items in near-mint condition.

The payout is sellPrice × multiplier, where multiplier starts at 1.0 (full price) and gets multiplied down by each of these, in order:

Items that aren't damageable (blocks, food, etc.) always sell for full price unless they've been renamed or had their lore changed. sellPrice: -1 (item can't be sold) and sellPrice: 0 are unaffected by any of this, a 0 sell price always pays out 0.

Every shop entry can override any of these six settings just for that item, see Shop files below.

adjustedPayout = max(round(sellPrice * multiplier), 1)
multiplier     = max(damageMultiplier * repairMultiplier * nameMultiplier * loreMultiplier, minValueFraction)

remainingDurabilityFraction = (maxDamage - damage) / maxDamage
damageMultiplier = minValueFraction
    + (1 - firstUsePenalty - minValueFraction) * remainingDurabilityFraction ^ damageCurveExponent

delta = max(0, repairCost - originalRepairCost)
repairMultiplier = max(minValueFraction, 1 - delta * repairCostPenaltyPerPoint)

Shop files

Each shop is one .snbt file in ./config/gui-shop/shops/. The file name is the shop id; the displayName inside is what players see, so renaming a shop does not rename its file.

{
  DataVersion: 4671,
  displayName: "Spawn Shop",
  icon: "minecraft:chest",
  defaultCurrency: "guishop:credit",
  entries: [
    {
      displayName: "The boat",
      description: ["This is a nice boat", "Very beautiful"],
      buyPrice: 50L,
      sellPrice: 25L,
      stack: {id: "minecraft:acacia_chest_boat"}
    },
    {
      displayName: "Free BBQ Sword",
      buyPrice: 0L,
      sellPrice: -1L,
      currency: "guishop:credit",
      stack: {
        id: "minecraft:diamond_sword",
        components: {
          "minecraft:enchantments": {"minecraft:sharpness": 5},
          "minecraft:custom_name": {text: "Hello", bold: true}
        }
      }
    },
    {
      displayName: "Amethyst",
      description: ["<red>Such a spectacular</red>", "<purple>amethyst</purple>", "<rainbow>SHINY</rainbow>"],
      buyPrice: 200L,
      sellPrice: 100L,
      stack: {id: "minecraft:large_amethyst_bud"}
    }
  ]
}

• DataVersion is the Minecraft version the file was written for. Leave it alone, the mod stamps it, and uses it to upgrade the file's items automatically after a Minecraft update, taking a copy into shops/backups/ first.
• stack is a vanilla item stack, in exactly the shape the /give command uses.
• buyPrice and sellPrice are longs (note the L). -1 means the item cannot be bought, or cannot be sold, respectively.
• currency is optional per entry and falls back to the shop's defaultCurrency.
• description is optional and is omitted entirely when empty.
• icon is optional and defaults to minecraft:chest.
• A shop may also carry its own sellPricing block, with the same keys as the one in config.json, to override the server-wide defaults for that shop only.

Both displayName and description support the Simplified Text Format.

You can edit these files by hand or use the in-game commands. Just remember to:

• reload the mod using /guishop reload after editing a shop file,
• save in-game changes using /guishop forcesave to write them back to disk,
• not work in the files and in-game at the same time.
  • If in-game changes are saved, they overwrite any edits made to the files.
  • If the files are reloaded, they overwrite any unsaved in-game changes.
  • Be careful making large-scale edits while the server is running, since the mod saves in-game changes automatically every 30 minutes.

Upgrading from an older GuiShop

The old ./config/guishop.json and ./config/guishopeconomy.json are migrated automatically on first start: settings move into config/gui-shop/config.json, each shop becomes a .snbt file, and the originals are kept as .pre-migration-backup copies next to where they were.

Supported Economies:

From 1.4.5 and onwards, the mod supports any (combination of) economy mod that uses the Common Economy API. A great example is Common Bridge, which bridges multiple economy plugins to use the Common Economy API.

GuiShop also comes with its own economy provider which can be configured in the config file. This build-in economy provider can be configured with multiple currencies and accounts. (The multi-account per currency functionality has not been properly implemented yet.)