Shop 2.3.5

Enjoy a highly customizable Shop that can be configured in game! Use NPCs as shopkeepers, and set up a shop with ease using the game interface to add, edit, or remove items on the fly!

 Features of Shop

• Beautiful user interface
• Discount system (by permissions)
• Automatic shop filling (+ the plugin has support for the ItemCostCalculator plugin)
• Selling items (players can sell items to the store and receive money for it)
• Performance
• Adding/editing/removing items IN GAME
• Supports NPC
• Supports Custom Vending Machines
• Supports NoEscape
• Convert from ServerRewards
• Favorite  items
• By default, the plugin has English, Russian and Chinese translations
• Transfer money between players directly in the plugin!
• Shop allows you to use multiple economy plugins at once (players can choose what they want to pay with)
• For each item, you can choose which payment methods are available and how much they will cost, based on the selected method

Commands

• shop  - open shop interface  
• shop.install – starts the shop installation process
• shop.refill <recovery_rate> -  refill shop again
  recoveryRate: A value between 0 and 1 that determines the multiplier for the cost of selling items. For example, shop.refill 0.5 means that items will have a sale cost of 50% of their purchase cost.
• shop.convert.sr [clear]  - convert items from ServerRewards to Shop. The option clear means clearing Shop items before convert
• shop.setvm [categories: cat1 cat2 ...]  - add custom VM in config
• shop.setnpc  [categories: cat1 cat2 ...]  - add  NPC in config
• shop.remove all - a console command to remove all items and categories from the plugin
• shop.remove item [category name/all] - a console command to remove an item (or all items)
• shop.remove category [category name/all] - a console command to remove a  category (or all categories)
• shop.fill.icc  [all/buy/sell] - a console command for updating prices of items in the store using ItemCostCalculator. all - updates both Price and SellPrice, buy - updates Price, sell - updates SellPrice
• shop.convert.from.1.2.26 –  command to convert Shop plugin version 1.2.26 to version 1.3.0+
• shop.reset – resets store data, including templates, configurations, and items.
  • shop.reset template – resets the store interface template data.
  • shop.reset config – resets store configuration data.
  • shop.reset items – resets store items data.
  • shop.reset full – completely resets all store data (templates, configurations and items).
• shop.manage  – used to manage the Shop plugin.
  • shop.manage economy list – displays a list of all available economic systems in the plugin.
  • shop.manage economy set <economy_ID> <name>  – ыets the selected economic system by plugin ID and name. The command updates the corresponding economic system on the server and saves the changes in the configuration.
    • FOR EXAMPLE:
      shop.manage economy set 0 Economics – sets the main economy plugin to "Economics”.
      shop.manage economy set 1 ServerRewards – sets the additional economy system with ID 1 to "ServerRewards”.

Permissions

• shop.setvm  - for  command "shop.setvm"
• shop.setnpc  - for  command "shop.setnpc"
• shop.free  - for free item purchases
• shop.admin  -  admin permission

Sort Types

• None
• Name
• Amount
• PriceDecrease
• PriceIncrease

Category Types

• None – normal category for items
• Favorite – category for favorite items
• Hided  – hidden category, available only in NPC stores or Vending Machines

Video
P.S. Video of the old version, video for the V2+ version is now in development

 Showcase

Full screen Templates

• Template OLD STYLE

• Template NEW RUST

In-Menu Templates

• Template V1 (V1.1)

• Template V1 (V1.1) with BASKET

• Template V2

• Template V2 with BASKET

Installer

Editor

 TEST SERVER

Join our test server to view and experience all our unique features yourself!
Copy the IP Address below to start playing!

connect 194.147.90.239:28015

FAQ

Q: I get the message "The plugin does not work correctly, contact the administrator!”. What should I do?  
A: This means that your plugin is not installed. To install the plugin, use the command "/shop.install”. You need to have "shop.admin” permission to access this command.  

Q: Where can I see an example of a config?
A:    Config

Q: How to use BankSystem to store the economy
A:  

  "Economy": {
    "Type (Plugin/Item)": "Plugin",
    "Plugin name": "BankSystem",
    "Balance add hook": "Deposit",
    "Balance remove hook": "Withdraw",
    "Balance show hook": "Balance",
    "ShortName": "",
    "Display Name (empty - default)": "",
    "Skin": 0,
    "Lang Key (for Title)": "LangTitle",
    "Lang Key (for Balance)": "BalanceTitle"
  },

Q: How to use ServerRewards to store the economy
A:  

  "Economy": {
    "Type (Plugin/Item)": "Plugin",
    "Plugin name": "ServerRewards",
    "Balance add hook": "AddPoints",
    "Balance remove hook": "TakePoints",
    "Balance show hook": "CheckPoints",
    "ShortName": "",
    "Display Name (empty - default)": "",
    "Skin": 0,
    "Lang Key (for Title)": "LangTitle",
    "Lang Key (for Balance)": "BalanceTitle"
  },

Q: How to use Economics to store the economy
A:  

  "Economy": {
    "Type (Plugin/Item)": "Plugin",
    "Plugin name": "Economics",
    "Balance add hook": "Deposit",
    "Balance remove hook": "Withdraw",
    "Balance show hook": "Balance",
    "ShortName": "",
    "Display Name (empty - default)": "",
    "Skin": 0,
    "Lang Key (for Title)": "LangTitle",
    "Lang Key (for Balance)": "BalanceTitle"
  },

 Q: How to use IQEconomic  to store the economy
A:  

  "Economy": {
    "Type (Plugin/Item)": "Plugin",
    "Plugin name": "IQEconomic",
    "Balance add hook": "API_SET_BALANCE",
    "Balance remove hook": "API_GET_BALANCE",
    "Balance show hook": "API_REMOVE_BALANCE",
    "ShortName": "",
    "Display Name (empty - default)": "",
    "Skin": 0,
    "Lang Key (for Title)": "LangTitle",
    "Lang Key (for Balance)": "BalanceTitle"
  },

Q: How to use scrap to pay for items
A:  

  "Economy": {
    "Type (Plugin/Item)": "Item",
    "Plugin name": "",
    "Balance add hook": "",
    "Balance remove hook": "",
    "Balance show hook": "",
    "ShortName": "scrap",
    "Display Name (empty - default)": "",
    "Skin": 0,
    "Lang Key (for Title)": "LangTitle",
    "Lang Key (for Balance)": "BalanceTitle"
  },

Q: How to add KIT as shop item
A:  https://pastebin.com/4szBQCgz

Q: How to add Command as shop item
A:  https://pastebin.com/bcCkzBEL

Q:  How do I make a weapon spawn with ammo in it?
A:  You need to configure the "Weapon" section in the item config:

          "Weapon": {
            "Enabled": true,
            "Ammo Type": "ammo.rifle.explosive",
            "Ammo Amount": 128
          }

Q:  How do I make items spawn some content (liquid, weapon modifications)?
A:  You need to configure the "Content" section in the item config:

          "Content": {
            "Enabled": true,
            "Contents": [
              {
                "ShortName": "weapon.mod.lasersight",
                "Condition": 100.0,
                "Amount": 1,
                "Position": -1
              }
            ]
          },

Q: How to turn off the sell feature?  
A: You need to turn off "Enable item selling” in the config, or do it in the item setting in the game.  

"Enable item selling?": false,

Q: How to use the ItemCostCalculator with Shop?  
A: You need to use command "shop.refill" (command to refill the Shop)

Q: What should be the size of images for item icons?
A:  Typically, the image dimensions for item icons are 512x512 pixels, but any square image can suffice.

Q: I get the error "UI is unavailable for player. Reason: Menu UI is not initialized". How to fix it?
A: This error occurs when the interface template is not installed or configured. Follow these steps:
1. Reset the template using the command: shop.reset template (use only template to avoid data loss).
2. Install the interface via shop.install in the game (to visually select a template) or through the console.
Note: Ensure you have the shop.admin permission to execute these commands.

Q: How do I add Shop to the ServerPanel menu?
A: Follow these simple steps:
1. Open ServerPanel menu in-game and click "+ADD CATEGORY" button
2. Set these exact parameters:

• Type: Plugin
• Plugin Name: Shop
• Plugin Hook: API_OpenPlugin

3. Click "SAVE" button to create the category
4. Reset Shop template and install it:

• Type in console: shop.reset template (IMPORTANT: use only "template"!)
• Then type: shop.install

Note: If Shop doesn't appear in ServerPanel menu, make sure both plugins are loaded and you typed the parameters exactly as shown above.

Q: I see black images with Rust logo or get error 429 when loading images. What should I do?
A: These issues occur when there are problems downloading images from the internet. To fix this, enable Offline Image Mode which will use local images instead:

1. Enable the mode in config:
   • Open "oxide/config/Shop.json" (or "carbon/config/Shop.json" for Carbon)
   • Set "Enable Offline Image Mode": true
2. Set up the images:
   • Create folder "TheMevent" in "oxide/data" (or "carbon/data" for Carbon)
   • Download PluginsStorage (click "CODE" → "Download ZIP")
   • Extract the ZIP and copy all contents to the "TheMevent" folder
3. Reload the plugin:
   • Type o.reload Shop (Oxide) or c.reload Shop (Carbon)

Note: If using a hosting service, you may need to use their file manager or FTP to upload the files.

Q: What placeholders are available for commands and what do they do?
A: You can use these placeholders in shop commands and they will be automatically replaced when a player purchases a command item:

• %steamid% - Replaced with the player's Steam ID (e.g., "76561198000000000")
• %username% - Replaced with the player's display name (e.g., "PlayerName")
• %player.x% - Replaced with the player's X coordinate position
• %player.y% - Replaced with the player's Y coordinate position
• %player.z% - Replaced with the player's Z coordinate position

Example usage in shop commands:

"Command (%steamid%)": "say Welcome %username%!|teleport %steamid% %player.x% %player.y% %player.z%"

Note: Multiple commands can be separated by the "|" character, and they will be executed in sequence when the item is purchased.