# Table of Contents - [EconomyShopGUI - Overview | EconomyShopGUI wiki](#economyshopgui-overview-economyshopgui-wiki) - [FAQ & Read Me - start here! | EconomyShopGUI wiki](#faq-read-me-start-here-economyshopgui-wiki) - [Commands: | EconomyShopGUI wiki](#commands-economyshopgui-wiki) - [Permissions: | EconomyShopGUI wiki](#permissions-economyshopgui-wiki) - [Troubleshooting: | EconomyShopGUI wiki](#troubleshooting-economyshopgui-wiki) - [General How-To's: | EconomyShopGUI wiki](#general-how-to-s-economyshopgui-wiki) - [Limited Items | EconomyShopGUI wiki](#limited-items-economyshopgui-wiki) - [About YAML (YML files) | EconomyShopGUI wiki](#about-yaml-yml-files-economyshopgui-wiki) - [Config.yml | EconomyShopGUI wiki](#config-yml-economyshopgui-wiki) - [API Usage | EconomyShopGUI wiki](#api-usage-economyshopgui-wiki) - [Languages | EconomyShopGUI wiki](#languages-economyshopgui-wiki) - [Sections | EconomyShopGUI wiki](#sections-economyshopgui-wiki) - [Shops | EconomyShopGUI wiki](#shops-economyshopgui-wiki) - [FAQ & Read Me - start here! | EconomyShopGUI wiki](#faq-read-me-start-here-economyshopgui-wiki) - [About YAML (YML files) | EconomyShopGUI wiki](#about-yaml-yml-files-economyshopgui-wiki) - [API Usage | EconomyShopGUI wiki](#api-usage-economyshopgui-wiki) --- # EconomyShopGUI - Overview | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/#what-is-economyshopgui-esgui-and-what-can-it-do) What is EconomyShopGUI(ESGUI) and what can it do? ----------------------------------------------------------------------------------------------------------------------------------------------------- This plugin is a fully customizable GUI shop plugin that your players can use to buy items from, and sell items to the server. There are numerous features and configuration options in the plugin, such as a DiscordSRV hook, discounts/multipliers, player transaction logs, seasonal pricing, multiple supported economy's, ... The best part being is that it is possible to add/edit/remove shop items/category's using ingame commands, no configs files required, nor server restarts to edit the shop! ### [](https://wiki.gpplugins.com/economyshopgui/#key-features) **Key features:** * Add/edit/delete items and shop category's with [in-game commands](https://wiki.gpplugins.com/economyshopgui/basics/commands#commands) , no config files needed! * Add as many shop [category's](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) as you like. Example: Blocks, Redstone, Potions, Food, Mob Drops, etc... * Support for [sub sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#sub-shops) * Add unlimited items to the [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) * Browse and install premade shop layouts from our [Marketplace](https://layouts.gpplugins.com/) * Add [discounts](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discounts-1) and/or sell [multipliers](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sell-multipliers) using permissions. * [Seasonal pricing](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#seasonal-pricing) per item or per shop * Use multiple currencies at the same time using [per section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#specific-currency) or [per item](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#economy) currencies. * [DiscordSRV hook](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discordsrv-hook) to log shop transactions to a discord channel. * Add different [goat horns](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#instrument) , [enchantments](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) , [potion effects](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types) , [spawner types](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#spawner-type) , [knowledge books](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#recipe) , [player heads](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#skull-owner) , [stew effects](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#stew-effect) , [armor trims](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#armor-trim) , [ominous bottles](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#ominous-strength) , [fireworks](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework) , [leather armor with RGB colors](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#armor-color-required-specific-item-any-leather-armor-piece) , ... and many more item types * Bedrock players [support](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#bedrock) thru GeyserMC/Floodgate * Support for 3rd party spawners from 10+ directly [supported spawner plugins](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-provider) . * Customize the look of the shop by changing the [option items](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#option-items) /[navigation bars](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#navigation-bars) or with [fill items](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#mainshop-fill-item) * [Placeholder expansion](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions-1) with custom placeholders totalling at 100+ placeholder combinations. * [Multiple language](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#currently-supported-languages) support * Set a list of [banned gamemodes](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#banned-gamemodes) * Specific click actions for [different click type](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#click-mappings) s per shop * Support for [NPC Shops](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-make-an-npc-shop) * Support for [physical shops](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-use-shopstands) in your world * Support of Minecraft versions 1.8.x - 1.21.x with default shop files for each version * [Discord](https://discord.com/invite/nPyuB4F) support server * Multiple [economy providers](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) supported * [Transaction log file](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#transactions) to keep track of your economy * Execute [commands](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands) when players purchase/sell items _\*Premium Only_ * Add custom items with [Component](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#components) /[NBT data](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#nbt-data) to shops _\*Premium Only_ * Specific item economy's, specify a [per item economy/currency](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#economy) _\*Premium Only_ * Support for custom [item economy](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) 's, puchase/sell shop items for ingame items _\*Premium Only_ * Multiple [buy](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy-prices) and [sell](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell-prices) prices support for items to add different ways to buy/sell the item _\*Premium Only_ * [Limit the amount of items](https://wiki.gpplugins.com/economyshopgui/basics/limited-items) for each player or globally _\*Premium Only_ * [Dynamic](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#dynamic-pricing) [Pricing](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#dynamic-pricing) which allows different item prices according supply and demand _\*Premium Only_ * Full PlaceholderAPI support inside item names/lore, aswell as shop tiles/navigation bar items _\*Premium Only_ * Direct support for item enchantments from EcoEnchants, AdvancedEnchantments, ExcellentEnchants and [CrazyEnchantments](https://www.spigotmc.org/resources/crazy-enchantments.16470/) _\*Premium Only_ * [MySQL](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#mysql) support to sync limited stock or DynamicPricing between multple servers _\*Premium Only_ [](https://wiki.gpplugins.com/economyshopgui/#shops-images) Shops Examples: -------------------------------------------------------------------------------- ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx-X8mi6dLha8lw5vs%252FMain%2520Menu%2520%28Premium%29.png%3Falt%3Dmedia%26token%3D9702c73b-1c62-463a-9d0a-8d1f37b89193&width=768&dpr=4&quality=100&sign=5e9fa2f3&sv=2) Default Main Menu (files in the /sections/ folder)(\*Top row items are Premium only section examples) ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx0pm1Lr6k1NVfuMD4%252FBlocks.png%3Falt%3Dmedia%26token%3Dff2dcd6a-e8d1-4478-af45-45d94b0f6a88&width=768&dpr=4&quality=100&sign=ff1e919e&sv=2) Default Blocks Page1 (files in the /shops/ folder)(\*Shift+Click to edit item only available in Premium version) ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx-qGlyRVQyvGSGzip%252FOres.png%3Falt%3Dmedia%26token%3Dc3ed89ac-cfbc-48b7-8375-13bfd42e759b&width=768&dpr=4&quality=100&sign=acb10e4f&sv=2) ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx-xT84kAP2V7eFg_B%252FOthers.png%3Falt%3Dmedia%26token%3D19a50f1d-8701-45ce-905d-7b717c999d48&width=768&dpr=4&quality=100&sign=198f66b2&sv=2) ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx00jS-FQZPd5sPd8r%252FPotions%2520and%2520Tipped%2520Arrows.png%3Falt%3Dmedia%26token%3Da979fea6-217c-4d56-a891-740282575590&width=768&dpr=4&quality=100&sign=a68de582&sv=2) ### [](https://wiki.gpplugins.com/economyshopgui/#in-game-item-editor) In-Game Item Editor - \*Premium Only: ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx0VS4XlNGInlWNymN%252FItemEditor-Main.PNG%3Falt%3Dmedia%26token%3D1da92169-1825-4874-91cd-5306cd215c47&width=768&dpr=4&quality=100&sign=76320d2a&sv=2) Item Editor Main menu ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MjZq82V_aqVRHEs8D_L%252F-Mj_BdSUT9sCbeeR_-YJ%252FSchermafbeelding%25202021-09-14%2520183819.png%3Falt%3Dmedia%26token%3D67d71c95-b6a4-44f4-a43b-bc62efd66126&width=768&dpr=4&quality=100&sign=3d0973a0&sv=2) Item editor options ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx0fSOtNuxrsuU60uv%252FCommands%2520%28Premium%29.png%3Falt%3Dmedia%26token%3Db88c36f3-07e1-458d-b08d-1a2308d92ffe&width=768&dpr=4&quality=100&sign=dd23f178&sv=2) Example item with command assigned to it ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MXwZ58BwTdom3uGj_83%252F-MXx0jJ0ioOvt9pEc5HC%252FNBT%2520Items%2520%28Premium%29.png%3Falt%3Dmedia%26token%3D0bce9047-4f29-408e-aa54-abb8bbdfe0a6&width=768&dpr=4&quality=100&sign=2b91a69e&sv=2) Custom item with NBT data tag(s) [](https://wiki.gpplugins.com/economyshopgui/#where-to-get-it) Where to get it: ------------------------------------------------------------------------------------ #### [](https://wiki.gpplugins.com/economyshopgui/#free-version) Free Version: * [GPPlugins](https://gpplugins.com/plugin/economyshopgui) * [SpigotMC](https://www.spigotmc.org/resources/economyshopgui.69927/) * [BukkitDev](https://dev.bukkit.org/projects/economyshopgui) (24hr delay when new version released) * [Polymart](https://polymart.org/resource/456) #### [](https://wiki.gpplugins.com/economyshopgui/#premium-version) Premium Version: * GPPlugins * [SpigotMC](https://www.spigotmc.org/resources/economyshopgui-premium.104414/) * [Polymart](https://polymart.org/resource/economyshopgui-premium.908) [](https://wiki.gpplugins.com/economyshopgui/#plugin-showcase-videos) Plugin showcase videos: -------------------------------------------------------------------------------------------------- * English by SoulStriker: [https://www.youtube.com/watch?v=zhDAtuROTfk](https://www.youtube.com/watch?v=zhDAtuROTfk) * Dutch by BelgiumGames: [https://www.youtube.com/watch?v=G6CBSwxBJGE](https://www.youtube.com/watch?v=G6CBSwxBJGE) * German by Produktecheck: (Outdated) [https://www.youtube.com/watch?v=a-Y\_-bJ58Kg](https://www.youtube.com/watch?v=a-Y_-bJ58Kg) * Spanish by Ajneb97: [https://www.youtube.com/watch?v=U7-raDmZXj4](https://www.youtube.com/watch?v=U7-raDmZXj4) If you want to create a video on how to use this plugin and feature it here, be sure to send us a message on [Discord](https://discord.com/invite/nPyuB4F) ! [](https://wiki.gpplugins.com/economyshopgui/#notes) \*Notes: ------------------------------------------------------------------ * _\*1_: Max items IS unlimited, However, adding an outrageous number of items may have adverse effects on plugin or server performance. (we have not observed this being an issue yet) * _\*2_: Vanilla Mobs only. ESGUI does NOT change any mob spawning behavior, it only changes the mobtype of the spawner when placed. * _\*Premium Only_: Premium version has additional features not available in the free version. Please upgrade and support the developers if you need those extra features! The Free version will always support vanilla functionality and compatibility. [NextFAQ & Read Me - start here!](https://wiki.gpplugins.com/economyshopgui/basics/faq) Last updated 4 months ago Was this helpful? --- # FAQ & Read Me - start here! | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/basics/faq#getting-started) Getting Started with ESGUI: --------------------------------------------------------------------------------------------------------- ESGUI is made up of 4 main files that are fully configurable, and is where everything about the plugin and shop items are stored. Unless you are only using [commands](https://wiki.gpplugins.com/economyshopgui/basics/commands#editshop) to configure your shops, you will need to access your files and know how they work. 1. The [Config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) - this is where you configure _How_ ESGUI should function. Any changes made to this file may require a server restart. * [More about this file here!](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) 2. The [Sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) configurations - These configs can be used to configure the shop category(section) items inside the main menu which link to the shop itself. * [More about these files here!](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) 3. The [Shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) configurations (most used files, you'll be here alot)- These configs store all item information for every shop item in a specific section. * [More about these files here!](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) 4. Last, and least used file is the [languages file](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) in the `LanguageFiles` folder. * Depending on which one you have configured ESGUI to use in the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#language-option) , this is where you can make changes to the messages and text lines of ESGUI's interface. * [More about these files here!](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) 5. You will also need to install [a supported economy provider](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) to use EconomyShopGUI. ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#dependencies) Dependencies: 1. **Economy Plugin** - You will need to use an economy plugin, currently the plugin supports the following economy providers listed here. 1. (**Note:** You only need **one of these** plugins for basic usage, but you can use multiple for multiple currencies. Other Vault Based Economy Plugins not listed here may also work with some limitations) 2. **Permissions Plugin** \- A permissions plugin is optional, but recommended. Blocking access to certain shop category's or items requires one, see [our guide here on how to use a permissions plugin](https://wiki.gpplugins.com/economyshopgui/basics/permission#setup-permissions) . [](https://wiki.gpplugins.com/economyshopgui/basics/faq#faq-frequently-asked-questions) FAQ (Frequently Asked Questions): ------------------------------------------------------------------------------------------------------------------------------ ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#its-broken-questions) It's Broken Questions: 1. \_\_\_(this or that)_\_\_\__ doesn't work! * Please check [Troubleshooting](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting) for common issues and how to resolve them! 2. Only OPped players can access the shops: * [Setup Permissions](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) , and Ensure you have only ONE [permissions plugin](https://wiki.gpplugins.com/economyshopgui/basics/permission#installing-a-permission-plugin) . 3. Why are all my spawners pig spawners? * There is a [conflicting plugin or you have misconfigured the plugin. See TS16 here](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-16-pig-spawners) . 4. Why are there Barrier blocks in my shops? * [There are invalid or misconfigured items in your shops file. See TS15 here.](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-15-you-have-barrier-blocks-in-your-shop) 5. Plugin is disabled or is showing an internal error: * [Check for missing dependencies or errors in files](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-14-plugin-is-disabled-errors) ! 6. Enchantments not keeping their level in an anvil: * Non-Vanilla Enchantment levels (unsafe enchants) will be removed by vanilla MC when the item is used in an anvil. We cannot fix this. ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#general-questions) General Questions: 1. How/where do I find ESGUI's files? ([config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) , [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) , [sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) , and [language](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) files) * In [General How-To's here!](https://wiki.gpplugins.com/economyshopgui/basics/how-to#plugin-files) 2. How do I upgrade to premium? * In [General How-To's here!](https://wiki.gpplugins.com/economyshopgui/basics/how-to#upgrade-to-premium) 3. How do I change the tool(s) for silk-touching a spawner? * In the [config.yml here!](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-break-materials) 4. How do I add a shop? * Use the ingame edit command * Use the config files, this will require to create a [sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) and [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) config with the same name 5. How do I change the plugin's language? * In the [Config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#language-option) language-file setting 6. How do I change the currency symbol? * You can change it to w/e you want inside the [language file](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#language-file-example) you are using. 7. How do I setup discounts? * In the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discounts) ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#shops-item-questions) Shops/Item questions: 1. How do I \_\_\_(configure items)\_\_\_ ? * change the **material** of items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#material) * change the **buy** or **sell** price of items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) * change/add/remove the **displayname** of items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-name) * change/add/remove the **name** of items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#name) * add/remove **enchantments** to items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) * add/remove **potion effects** to items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types) * add/remove **lore** to items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#lore) * set the **mob of a spawner**? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#spawner-type) * set the **recipe of a knowledge\_book**? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#recipe) * set the **texture of a player\_head**? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#skull-owner) * add/remove **custom items (NBT data)**? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#nbt-data) _\*Premium Feature_ * add/remove **commands** to/from items? - [With Command(s)](https://wiki.gpplugins.com/economyshopgui/basics/commands) | [Editing YML file(s)](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands) _\*Premium Feature_ 2. How do I add or remove items from shops? * Use the ingame [edit](https://wiki.gpplugins.com/economyshopgui/basics/commands#editshop) command to add/edit/remove items. * Use the [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) config from the shop category. 3. How do I make an item non-buyable/sellable? * Set it's buy or sell price to a negative #. Ex: `sell: -1` 4. How do I make a Voucher item/Paper Money? * [In How-To's here](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-store-share-money-as-an-item) ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#section-main-menu-questions) Section/Main Menu Questions: 1. How do I remove or add a section (main menu item/shop)? * Use the ingame edit command to add/edit/remove sections. * Or: Remove the [sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) **AND** [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) config. * It is important to remove both files, else a example shop will be created. 2. How do I disable a shop without removing it? * Disable it in the [sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) config 3. How do I change \_\_\_(this or that)_\_\_\__ of the main menu/sections? * Edit the [sections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) config, and `/sreload` * You may also use the /eshop commands to edit shop sections 4. How do I make a hidden shop? * [In How-To's here](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-make-a-hidden-shop-workaround) 5. How to disable the back button? * [In config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#disable-back-button) ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#permissions-questions) Permissions Questions: 1. How do I use permissions? * [Learn how to setup permissions here](https://wiki.gpplugins.com/economyshopgui/basics/permission#setup-permissions) . 2. What permissions do I need? * [See Basic Permissions here](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) . 3. Only OPped players can access the shops: * [Setup Permissions](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) . ### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#compatibility-questions) Compatibility Questions: 1. What plugins are compatible with ESGUI? _- Must be enabled in_ [_config.yml_](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#silkspawners-compatibility) _to work!_ 1. Compatible Silk-Spawner Plugins: * [_See a list of compatible spawner plugins here_](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-provider) 2. Compatible economy plugins: 1. See a list [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) 3. Compatible item plugins: _\*Premium feature_ 1. See a list [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#material) 4. Placeholder support: 1. See the available placeholders [here](https://wiki.gpplugins.com/economyshopgui/basics/how-to#using-the-placeholderapi-expansion) 5. Seasonal prices per season 1. See how to configure seasonal prices [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#seasonal-pricing) 2. How do I change what can be used to break spawners? * [Configure it in the config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-break-materials) 3. Can I use ESGUI with an eco plugin other than EssentialsX? * Yes! You can use any supported Vault plugin or a supported economy plugin listed [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) . 4. Can I use items as currency(in exchange for items) in the shop? * Yes, but this requires the premium version of the plugin where you can [setup physical item economys](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-create-custom-item-economys) . #### [](https://wiki.gpplugins.com/economyshopgui/basics/faq#advanced-administration-questions) Advanced administration questions: 1. Is the source code available? - No. 2. Will the source code ever be available? - No. 3. Can you decompile, modify or make changes the plugin? * **No.** * "EconomyShopGUI" aka "ESGUI" is the Intellectual Property (IP) of GP Plugins and may not be modified. * Sharing of the plugin is only permitted for the free version. The Premium version is NOT to be shared or otherwise manipulated per the posted Terms Of Service (TOS). * You may only use the Premium version on servers YOU OWN. [](https://wiki.gpplugins.com/economyshopgui/basics/faq#upgrading-from-free-to-premium) Upgrading from free to premium --------------------------------------------------------------------------------------------------------------------------- [Upgrading your plugin from free to premium is super easy, there are two ways to do this: Either copy all changes manually(not recommended) to the premium version's files or use the import command (recommended).](https://wiki.gpplugins.com/economyshopgui/basics/how-to#upgrade-to-premium) [PreviousEconomyShopGUI - Overview](https://wiki.gpplugins.com/economyshopgui) [NextCommands:](https://wiki.gpplugins.com/economyshopgui/basics/commands) Last updated 5 months ago Was this helpful? --- # Commands: | EconomyShopGUI wiki #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#legend) Legend: * Any value bracketed by `****` (angle brackets) is a **required** value * Any value bracketed by `**[value]**` (square brackets) is an **optional** value, and can be omitted from command execution if not needed/desired [](https://wiki.gpplugins.com/economyshopgui/basics/commands#commands) Commands: ------------------------------------------------------------------------------------- * `**/shop [player]**` = Open the shop * Note: the optional argument`[player]` can only be specified in console. * `**/shop
[player]**` = Open a shop section directly from the command instead of typing /shop and choosing a shop section * Note: the optional argument`[player]` can only be specified in console. * `**/sellall**` = Sell all items from your inventory * `**/sellall **` = Sell all items in your inventory that match the specified [material](https://www.digminecraft.com/lists/item_id_list_pc.php) * `**/sellall hand**` = Sell the item stack that you are currently holding in your hand * `**/sreload**` = Reloads the plugin and shops([Sections.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) and [Shop.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) ). \*Some settings in the [Config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) require a server restart to take effect! * `**/shopgive
[player]**` = Allows admins to give a certain shop item to players or them self to test them for example. * `**/editshop additem
[displayname]**` = [Add an item](https://wiki.gpplugins.com/economyshopgui/basics/commands#adding-items) to a specific shop section with this command * `**/editshop edititem
**` = Allows you to [edit an existing item](https://wiki.gpplugins.com/economyshopgui/basics/commands#editing-items) in the shop * `**/editshop deleteitem
**` = This command allows you to [remove an item](https://wiki.gpplugins.com/economyshopgui/basics/commands#deleting-items) from the shop * `**/editshop import Essentials worth.yml**` = Import all items sell prices from the worth.yml of essentials * `**/editshop addhanditem
**` = With this oommand you can add items from your hand to the shop. (Great for items with hidden/special NBT data!) * `**/sellgui [player]**` = This command opens a empty inventory where you can drop items in to sell, closing the inventory will complete the transaction and will give the items that couldn't be sold back to the player * `**/editshop addsection
**` = Allows u to add a shop section * `**/editshop editsection
**` = Allows you to edit a existing shop section * `**/editshop deletesection
**` = Removes a section from the sections.yml configuration * `**/editshop uploadLayout**` = Starts the upload process of your current layout * `**/editshop installLayout **` = Starts the install process from a premade shop layout * `**/editshop updateLayout **` = Allows updating existing layouts from our layout website (You cannot use this command if you aren't the author of the layout) * `**/editshop shopstands give
**` = Give yourself a new shop stand item which can be placed anywhere on the ground * `**/editshop shopstands browse**` = Opens a GUI which shows all existing shop stands on the server * `**/editshop shopstands destroy **` = Destroy a shop stand by its ID * `**/eshop logs export**` - Exports the current logged transactions to a web site for easy a easy overview/inspecting #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#premium-version-only-commands) \*Premium version only commands: * `**/shop search**` \- Brings up a search bar to search for shop items matching their material name * `**/editshop update**` - Downloads new versions from a ingame command * `**/editshop import EconomyShopGUI all**` - Allows you to import config files from the free version [How to use this command](https://wiki.gpplugins.com/economyshopgui/basics/commands#import-command) * You should only need to use this command **once** when upgrading from [Free to Premium](https://gpplugins.gitbook.io/economyshopgui/basics/how-to#upgrade-to-premium) . * `**/editshop import shopguiplus all**`\- Allows data importing from ShopGUI+ * `**/editshop globalstock set/add/reset
[amount]**` \- Can be used to edit the global stock on a item * `**/editshop playerstock set/add/reset
[amount]**` - Can be used to edit the player stock on a item * `**/editshop globalsell set/add/reset
[amount]**` \- Can be used to edit the global sell limit on a item * `**/editshop playersell set/add/reset
[amount]**` - Can be used to edit the player sell limit on a item * `**/editshop dynamicpricing reset [index]**` - Allows to reset the DynamicPricing of a specific item, from a sepecific section or all items at the same time * `**/editshop database cleanup **` - Allows to remove expired data from the database to cleanup and reduce file size [](https://wiki.gpplugins.com/economyshopgui/basics/commands#using-the-editshop-command) Using the editshop command: ------------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#adding-items) Adding items: There are two ways to add items to shop via commands: * Adding items from you inventory which are configured automatically is as easy as: `**/eshop addhanditem**` * Adding items to the shop manually can be done using the command `**/editshop additem
[displayname]**`. * You may need to use `**/sreload**` after adding items to load the new items. #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#command-breakdown) Command Breakdown: * `**/editshop additem
[displayname]**` * `**
**` = The [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) where you want to add the item * `****` = The [material](https://www.digminecraft.com/lists/item_id_list_pc.php) of the item * `****` = Price the player will pay to [Buy/Purchase](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) the item * `****` = Price the player will receive when [selling the item to the server](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell) * `**[displayname]**` = _\[Optional\]_ The [displayname](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-name) you want to give the item. It can contain spaces, '&' color-codes and special characters. * \*An _**index**_ for the new item will automatically be created when it is successfully added. * \*[Additional settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#item-settings) (most are optional, but some are needed) may need to be added with the `edititem` command after this command (ex: `Spawnertype` is required to set the mobtype when ESGUI is the [spawner-handler](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings) ) ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#editing-items) Editing items: Editing items is just that easy as adding items, just enter the `**/editshop edititem
**` command. * You may need to use `**/sreload**` after editing items to load the changes. #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#command-breakdown-1) Command Breakdown: * `**/editshop edititem
**` * `**
**` = The [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) of the item you want to edit. * `****` = The index of the item you want to edit. * See [**here**](https://wiki.gpplugins.com/economyshopgui/basics/how-to#obtaining-item-indexes-of-shop-items) how to find the index of a shop item * `****` = the action for the key. Valid options are: `**add, set, remove**` * `****` = the key you wish to edit, aka key '[potiontypes](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types) ', '[enchantments](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) ', '[spawnertype](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#spawner-type) ', etc... [Look here for all available keys](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#item-keys-list-quick-reference-index) . * `****` = the value of the key, aka if you have selected key '[potiontypes](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types) ', you need to enter a potion-type value ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#deleting-items) Deleting items: You already can guess how easy it is, just type the command `**/editshop deleteitem
**` to delete a item from a specified shop section. * You will need to use `**/sreload**` after removing items to load the changes to the shop. #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#command-breakdown-2) Command Breakdown: * `**/editshop deleteitem
**` * `**
**` = The [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) of the item you want to remove. * `****` = The index of the item you want to edit. * See [**here**](https://wiki.gpplugins.com/economyshopgui/basics/how-to#obtaining-item-indexes-of-shop-items) how to find the index of a shop item ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#adding-hand-items) Adding hand items: Mayby you do not want to add a new item to the shop and configure it yourself, so you can use the `**/editshop addhanditem
**` command to add already existing items to the shop. * You may need to use `**/sreload**` after adding items to load the new items. #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#command-breakdown-3) Command Breakdown: * `**/editshop addhanditem
**` * `**
**` = The [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) where you want to add the item * `****` = Price the player will pay to [Buy/Purchase](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) the item * `****` = Price the player will receive when [selling the item to the server](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell) * \*An _**index**_ for the new item will automatically be created when it is successfully added. * \*The command automatically detects the contents of the item and makes a item configuration matching this item in your shops config. Tab Completion in MC V1.13+ is quite useful for filling in most parts of the commands. [](https://wiki.gpplugins.com/economyshopgui/basics/commands#import-command) Using the import command ---------------------------------------------------------------------------------------------------------- Worried about losing data? The import command allows you to import the following options: ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#shopgui) ShopGUI+: _\*Premium feature_ The premium version of the plugin has build in commands to import the settings/current shop data from ShopGUI+. * The `**/editshop import shopguiplus all**` command will create a quickand easy summary of the items/sections/settings which can be imported, this won't import the data directly into your current configs. * Once satisfied with the results of the summary you can run the command `**/editshop import shopguiplus all confirm**` to complete the import. Note that this command will do its best to import the shop from ShopGUI+ as best as possible, with that sayd, it might not reflect all changes 100% to match EconomyShopGUI. ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#economyshopgui) EconomyShopGUI(Free version): _\*Premium feature_ If you have a fresh install of the premium version and haven't changed any of the files/shops; you can use the import command to copy the files from the data folder of the free version to the premium version. * `**/editshop import EconomyShopGUI all**` will import all existing shops, section s and config.yml configurations to ensure a smooth transition to the premium version. It is possible to copy and paste your files manually between versions, but it is recommeded to use the import command. ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#worth.yml) Essentials worth.yml: * `**/editshop import essentials worth.yml**` this will import items sell prices from the worth.yml of EssentialsX to EconomyShopGUI automatically. Note that the sell prices from worth.yml will be replaced with the current sell prices inside the [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) configuration. The current config is copied to the backups folder in case of error when you import or update the plugin. [](https://wiki.gpplugins.com/economyshopgui/basics/commands#how-to-use-the-editshop-command-to-set-limited-stock-for-a-item) How to use the editshop command to set limited stock for a item: --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The limited stock feature is a premium feature which can help to make special edition items on your server by limiting the amount there can be purchased from shop. * `**/editshop globalstock set
**` This will set the limited stock for the item for the whole server as the specified amount * `**/editshop playerstock set
**` This will set the limited stock for the item for the specified player as the specified amount Note that setting the limited stock for a item that hasn't [the limited stock settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock-premium-feature) specified in the shops.yml **won't** make it a limited item, for that you will first need to specify the [base settings inside the shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock-premium-feature) [](https://wiki.gpplugins.com/economyshopgui/basics/commands#how-to-use-commands-to-add-edit-delete-items) How to use commands to add/edit/delete Items: ------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#adding-a-new-item) Adding a new Item: * Command Syntax: * `**/editshop additem
[displayname]**` * `**
:**` The section/shop category to add this item to * `**:**` The item type of the new item * `**:**` The buy price of the shop item * `**:**` The sell price of the shop item * The `**displayname**` value is optional * Example: * `**/editshop additem blocks iron_block 20 2**` * Creates an item in the blocks [shops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) configuration: Copy blocks: '23': #Index automatically generated and added to the end of the shop section's items material: iron_block buy: 20 sell: 2 ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#editing-items-1) Editing items: #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#adding-keys-to-items) Adding keys to items: * Example: * `**/editshop edititem tools 12 add enchantments efficiency:3**` * Adds an enchantment to the item at index 12 in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) : Copy tools: '12': material: iron_pickaxe buy: 300 sell: 30 enchantments: - efficiency:3 #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#modifying-keys-of-items) Modifying keys of items: To modify a specific key on the item you will need to use the set action added in version 3.7/1.9 of the plugin. * Example: * `**/editshop edititem blocks 23 set buy 123.45**` * sets the buy price of the item at index 23 in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) : Copy '23': material: iron_block buy: 123.45 sell: 15 * Example: * `**/editshop edititem tools 12 set enchantments efficiency:3**` * `**/editshop edititem tools 12 add enchantments fortune:2**` * `**/editshop edititem tools 12 add enchantments unbreaking:5**` * The fist command will set the whole enchantment list to efficiency 3, if there were any other enchantments before this, these will be removed. * The following 2 commands will add the fortune and unbreaking enchantment to the list for the item inside section tools at index 12 in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) : Copy tools: '12': material: iron_pickaxe buy: 300 sell: 30 enchantments: - efficiency:3 - fortune:2 - unbreaking:5 #### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#removing-keys-from-items) Removing keys from items: * Example: * `**/editshop edititem tools 12 remove enchantments efficiency:3**` * removes enchantment efficiency 3 from the item at index 12 in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) : Copy tools: '12': material: iron_pickaxe buy: 300 sell: 30 enchantments: - fortune:2 - unbreaking:5 ### [](https://wiki.gpplugins.com/economyshopgui/basics/commands#deleting-items-1) Deleting items: * Command Syntax: * `**/editshop deleteitem
**` * `**
:**` The section/shop category to remove this item from * `**:**` The item index located inside the shops configuration * **TIP**: The item index is displayed when hovering over a shop item, the gray item lore by default. * Example: * `**/editshop deleteitem blocks page1.items.5**` [](https://wiki.gpplugins.com/economyshopgui/basics/commands#cleaning-the-database) **Cleaning the database** ------------------------------------------------------------------------------------------------------------------ Overtime the database will collect redundant amounts of player/item data which can be considered 'expired', this command allows to remove such data which will result in a faster database, and a reduced file size when using SQLite. * `**/editshop database cleanup **` * `****` can be replaced by ALL, PLAYER or ITEM * **ALL** removes both expired player and item data * **PLAYER** will remove only expired player data from the database * Player data is considered expired if the player didn't log in for the [time specified inside the config](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#database-cleanup) * **ITEM** will remove all item entries which no longer exist inside the shop * If a section is renamed(file name, not the name/displayname), all items that were located inside that shop will be considered expired * Shop items that are removed, re-located or do no longer exist by their item index inside the shop config are considered expired [PreviousFAQ & Read Me - start here!](https://wiki.gpplugins.com/economyshopgui/basics/faq) [NextPermissions:](https://wiki.gpplugins.com/economyshopgui/basics/permission) Last updated 1 month ago Was this helpful? --- # Permissions: | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/basics/permission#permission-nodes) Permission nodes: ------------------------------------------------------------------------------------------------------- Items/Category's [](https://wiki.gpplugins.com/economyshopgui/basics/permission#tab-items-categorys) ShopStands [](https://wiki.gpplugins.com/economyshopgui/basics/permission#tab-shopstands) Other permissions [](https://wiki.gpplugins.com/economyshopgui/basics/permission#tab-other-permissions) Commands [](https://wiki.gpplugins.com/economyshopgui/basics/permission#tab-commands) These permissions define whether a player is able to buy/sell items to a specific shop section, the core permissions of EconomyShopGUI. The `**
**` part in permssion nodes is replaced with the actual name of the shop category. This is defined by the name of the shop/section configuration. Permission node Default Description EconomyShopGUI.shop.
`TRUE` Gives access to buy/sell items in a **specific** shop section using the /shop GUI. EconomyShopGUI.shop.all `TRUE` Gives permission to open **all** shop sections and buy/sell items EconomyShopGUI.sellall.
`TRUE` Gives access to sell items in a **specific** shop section using the `/sellall inventory` command. EconomyShopGUI.sellall.all `TRUE` Allows players to sell items using the `/sellall inventory` command to **all** shop sections EconomyShopGUI.sellallitem.
`TRUE` This permission allows players to sell items using the `/sellall ` in **specific** shop sections EconomyShopGUI.sellallitem.all `TRUE` Allows players to sell items to **all** shop sections using the `/sellall ` command EconomyShopGUI.sellallhand.
`TRUE` Allows players to sell in a **specific** shop section with the `/sellall hand` command EconomyShopGUI.sellallhand.all `TRUE` Allows players to sell items using `/sellall hand` to **all** shop sections EconomyShopGUI.sellgui.
`TRUE` Allows players to sell items using the `/sellgui` command in **specific** sections EconomyShopGUI.sellgui.all `TRUE` Allows players to sell items to **all** shop sections using `/sellgui` Per item permissions _**\*Premium only**_ Permission node Default Description EconomyShopGUI.shop.
.item. `FALSE` A per item permission which allows you to buy/sell this specific item in the specific shop. EconomyShopGUI.sellall.
.item. `FALSE` A per item permission which allows you to buy/sell this specific item using the `/sellall` command EconomyShopGUI.sellallitem.
.item. `FALSE` A per item permission which allows you to buy/sell this specific item using the `/sellall item` command EconomyShopGUI.sellallhand.
.item. `FALSE` A per item permission which allows you to buy/sell this specific item using the `/sellall hand`command EconomyShopGUI.sellgui.
.item. `FALSE` em permission which allows you to buy/sell this specific item using the `/sellgui`command Permissions for shop stands are listed here Permission node Default Description EconomyShopGUI.eshop.shopstands.give `OP` Access to `/eshop shopstands give` EconomyShopGUI.eshop.shopstands.destroy `OP` Access to `/eshop shopstands destroy` EconomyShopGUI.eshop.shopstands.browse `OP` Access to `/eshop shopstands browse` EconomyShopGUI.eshop.shopstands.edit `OP` Allows to shift click a shop stand to edit EconomyShopGUI.eshop.shopstands.create `OP` Allows to place down a shop stand item to create one Permission node Default Description EconomyShopGUI.sell-multipliers. `FALSE` Allows players that inhert this permission to have sell multipliers [configured inside the config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sell-multipliers) . EconomyShopGUI.discounts. `FALSE` Allows players that inhert this permission to have discounts [configured inside the config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discounts-1) . EconomyShopGUI.itemindexes `OP` Allows players to see the locations of the shop items inside item lore GUI Editor _**\*Premium only**_ Permission node Default Description EconomyShopGUI.eshop.editor `OP` Gives access to the GUI Editor (when shift-clicking an item in a shop) These permissions allow players to use the different commands of EconomyShopGUI, for default all players have access to all commands except /editshop. Permission node Default Description EconomyShopGUI.shop `TRUE` Allows players to use the `/shop` command EconomyShopGUI.sellall `TRUE` Allows players to use the `/sellall` command EconomyShopGUI.sellallitem `TRUE` Allows a player to use the `/sellall ` command EconomyShopGUI.sellallhand `TRUE` Allows a player to use the `/sellall hand` command EconomyShopGUI.sellgui `TRUE` Allows players to use the `/sellgui` command EconomyShopGUI.reload `OP` Allows players to reload the plugin with command `/sreload` EconomyShopGUI.shopgive `OP` Allows admins to give items to certain players or them self using `/shopgive` EconomyShopGUI.eshop.\* `OP` Allows a player to access **all** subcommands for `/editshop ...` EconomyShopGUI.eshop.additem `OP` Allows players to use the `additem` subcommand EconomyShopGUI.eshop.edititem `OP` Allows players to use the `edititem` subcommand EconomyShopGUI.eshop.deleteitem `OP` Allows players to use the `deleteitem` subcommand EconomyShopGUI.eshop.addhanditem `OP` Allows players to use the `addhanditem` subcommand EconomyShopGUI.eshop.import `OP` Allows players to use the `import`subcommand EconomyShopGUI.eshop.addsection `OP` Allows players to use the `addsection`subcommand EconomyShopGUI.eshop.editsection `OP` Allows players to use the `editsection`subcommand EconomyShopGUI.eshop.deletesection `OP` Allows players to use the `deletesection`subcommand EconomyShopGUI.eshop.uploadLayout `OP` Allows players to use the `uploadLayout`subcommand EconomyShopGUI.eshop.installLayout `OP` Allows players to use the `installLayout`subcommand **Premium permissions:** Permission node Default Description EconomyShopGUI.shop.search `TRUE` Allows players to use the **/shop search** feature EconomyShopGUI.eshop.update `OP` Allows players to update the plugin using **/editshop update**. EconomyShopGUI.eshop.globalstock.\* `OP` Gives access to all subcommands for the `/editshop globalstock` command EconomyShopGUI.eshop.globalstock.add `OP` Allows access to add global stock for a item EconomyShopGUI.eshop.globalstock.set `OP` Allows access to set the global stock modifier for a item EconomyShopGUI.eshop.playerstock.\* `OP` Gives access to all subcommands for the `/editshop playerstock`command EconomyShopGUI.eshop.playerstock.add `OP` Allows access to add player stock for a item EconomyShopGUI.eshop.playerstock.set `OP` Allows access to set the player stock modifier for a item OR all items EconomyShopGUI.eshop.playersell.\* `OP` Gives access to all subcommands for the `/editshop playersell`command EconomyShopGUI.eshop.playersell.set `OP` Allows access to set the player sell limit for a item OR all items EconomyShopGUI.eshop.globalsell.\* `OP` Gives access to all subcommands for the `/editshop globalsell`command EconomyShopGUI.eshop.globalsell.set `OP` Allows access to set the global sell limit for a item OR all items EconomyShopGUI.eshop.dynamicpricing.\* `OP` Gives access to all subcommands for the `/editshop dynamicpricing`command EconomyShopGUI.eshop.dynamicpricing.reset `OP` Allows you to reset the DynamicPricing for a specific item or all items at the same time [](https://wiki.gpplugins.com/economyshopgui/basics/permission#setup-permissions) How to setup and assign permissions: --------------------------------------------------------------------------------------------------------------------------- Note: Some permissions plugins are CaSe SeNsItIvE! be sure to have the right Character's upper-case or lower-case where written in the table(s) above! ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#installing-a-permission-plugin) Installing a permission plugin: Installing a permissions plugin is that easy as dragging and dropping the file inside your server plugin's folder. 1. First you need to go to your permissions plugin page. [We recommend LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/) , LP's `/lp editor` command and webpage is easy to use. 2. **Research how to use the permissions plugin** of your choice and be sure it is **updated and compatible** with your version of Minecraft. \[[Simple Luckperms Tutorial here](https://www.youtube.com/watch?v=Hfp5Sz3m5p4)\ \] 3. Download the plugin. 4. Drop the file inside your plugins folder 5. Restart the server. Note: DO NOT install multiple permissions plugins. they will all fight with each other and cause you unending headaches. :/ ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#configuration) Configuration: We are not going to explain how to setup permissions in detail as everyone will want to setup their server differently. But if you [watch a video on YT](https://www.youtube.com/watch?v=Hfp5Sz3m5p4) or many others you can search for, you can learn how to setup your permissions/ranks plugin just how you want it! See [the list of Basic permissions](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) you will need (above) for ESGUI after installing/setting up your permissions plugin. [](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) Basic permissions you will need to assign to use EconomyShopGUI: ------------------------------------------------------------------------------------------------------------------------------------------------------- Since version **v5.0.0** or **v4.0.0** of the plugin, all required permissions are given by default and so you will not need to assign permissions to start. These are the permission nodes you need to add to a group or a specific player in your permissions plugin. 1a. `EconomyShopGUI.shop.all` Allows access to _**all**_ _shops_ defined in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) file -OR- 1b. `EconomyShopGUI.shop.
` Allows access to _a_ _**specific**_ _shop_ defined in the [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) file _(Replace_ `_
_` _with the section's name in the shops file!)_ [](https://wiki.gpplugins.com/economyshopgui/basics/permission#permissions-update) Permissions update: ----------------------------------------------------------------------------------------------------------- **Please read this as updating the plugin to a newer version will cause your players not be able to sell items using /sellall and /sellgui features!** Since version 4.4 of EconomyShopGUI and version 2.5 of EconomyShopGUI Premium we have have updated our permissions from the plugin to allow servers to have better control over which shops your players should be able to sell items to using /sellgui and /sellall. Before players would need the `**EconomyShopGUI.shop.
**` or `**EconomyShopGUI.shop.all**` permission node to sell items using `**/sellall**` and `**/sellgui**` but these have been split into seperate permissions for each command. ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#how-to-do-it) **How to do it?** Basically if you don't care about which items your players can sell to shop, you will need to give your players the following permission nodes: ➖`**EconomyShopGUI.sellall.all**` ➖`**EconomyShopGUI.sellallitem.all**` ➖`**EconomyShopGUI.sellallhand.all**` ➖`**EconomyShopGUI.sellgui.all**` If you are using LuckPerms as your permissions plugin(recomended), this can easily be done by executing the following commands: ➖ `**/lp group default permission set EconomyShopGUI.sellall.all true**` ➖ `**/lp group default permission set EconomyShopGUI.sellallitem.all true**` ➖ `**/lp group default permission set EconomyShopGUI.sellallhand.all true**` ➖ `**/lp group default permission set EconomyShopGUI.sellgui.all true**` On the other hand if you have a special shop which is only meant for players that have a rank on your server, you should add the shops they should have access to as seperate permission nodes. ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#added-permissions-since-this-update) Added permissions since this update: Permisson node: Description: EconomyShopGUI.sellall.
Gives access to sell items in a **specific** shop section using the `/sellall` command. EconomyShopGUI.sellall.all Allows players to sell items using the `/sellall` command to **all** shop sections EconomyShopGUI.sellallitem.
This permission allows players to sell items using the `/sellall item` in **specific** shop sections EconomyShopGUI.sellallitem.all Allows players to sell items to **all** shop sections using the `/sellall item` command EconomyShopGUI.sellallhand.
Allows players to sell in a **specific** shop section with the `/sellall hand` command EconomyShopGUI.sellallhand.all Allows players to sell items using `/sellall hand` to **all** shop sections EconomyShopGUI.sellgui.
Allows players to sell items using the `/sellgui` command in **specific** sections EconomyShopGUI.sellgui.all Allows players to sell items to **all** shop sections using `/sellgui` [](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions-1) Placeholders: ------------------------------------------------------------------------------------------------------ To use placeholders you will need the PlaceholderAPI plugin. The placeholder expansion is hard coded into the plugin itself, so it isn't requried to install any expansion from the ECloud. ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#item-placeholders) Item placeholders: Item price placeholders are used to display buy/sell prices of shop items in placeholders. * Buy prices: `%esgui_buyprice_
.%` * Sell prices: `%esgui_sellprice_
.%` *
is replaced with the item's section name * is replaced with the item's index inside the shop * Example: page5.items.180 * See [how to obtain the item index](https://wiki.gpplugins.com/economyshopgui/basics/permission#obtaining-item-indexes-of-shop-items) here When a shop item uses dynamic prices, the plugin uses a automatic cache interval to save perfomance. The caching delay of dynamic prices can be specified inside the config.yml. ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#discounts-multipliers) Discounts / Multipliers These placeholders return the percentage as a raw number: * Shop discounts: `%esgui_discount_
%` * Shop sell multipliers: `%esgui_sell_multiplier_
%` ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#shop-placeholders) Shop placeholders: Placeholders related to shop sections. * %esgui\_shop\_rotation\_
% * This placeholder returns the time left for the specified [rotating shop](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#rotating-shops) to rotate ### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#transaction-placeholders) Transaction placeholders: Transaction placeholders are used to display the player/item which made the most amount of transactions in the shop. It is possible to get the top 1-10 players(or amount) purchasing/selling a single item within the current time frame. It is also possible to get the top 1-10 items(or amount) being purchased/sold in shop within the current time frame. Note that the free version of the plugin is limited to only the top 1-3(or amount) placeholders and marks a total of only 72 placeholder combinations which can be used. This totals at 240 placeholder combinations which can be used! Replace **** by either **MONTH, WEEK** or **DAY** Replace **** by **FIRST, SECOND, THIRD, FOURTH, FIFTH, SIXTH, SEVENTH, EIGTH, NINTH** or **TENTH** #### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#top-player-purchasing-items) Top player purchasing items: * `%esgui__player_most_bought_items_current_%` * Player name which bought the most amount of items in the selected time frame * `%esgui__player_most_bought_items_current__amount%` * The amount of items purchased by the player at this ranking in the selected time frame #### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#top-player-selling-items) Top player selling items: * `%esgui__player_most_sold_items_current_%` * Player name which sold the most amount of items the selected time frame * `%esgui__player_most_sold_items_current__amount%` * The amount of items sold by the player at this ranking in the selected time frame #### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#top-purchased-items) Top purchased items: * `%esgui__most_bought_item_current_%` * Item displayname which was purchased the most the selected time frame * `%esgui__most_bought_item_current__amount%` * The amount of the item at this ranking and selected time frame which was purchased #### [](https://wiki.gpplugins.com/economyshopgui/basics/permission#top-sold-items) Top sold items: * `%esgui__most_sold_item_current_%` * Item displayname which was sold the most the selected time frame * `%esgui__most_sold_item_current__amount%` * The amount of the item at this ranking and the selected time frame which was sold Note that the transaction placeholders require the option `advanced-transaction-log:` inside the config.yml to be enabled. [PreviousCommands:](https://wiki.gpplugins.com/economyshopgui/basics/commands) [NextTroubleshooting:](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting) Last updated 3 months ago Was this helpful? --- # Troubleshooting: | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-logs) **TS01. Check your** `**latest.log**` **file for errors or issues:** --------------------------------------------------------------------------------------------------------------------------------------------------------- Plugins will log problems, warnings, and information at server startup. Always start here! * Your Console log has a limit to how many lines it can display and WILL NOT show all of the startup logging after it's finished. It will scroll by too fast to remain on screen. * You can find the `latest.log` in the /**logs/** folder (and zipped previous log files) * You should be able to access your server files directly from your server-host's "File Browser" on the webpage, or via an FTP/SFTP connection (Refer to your server host's support if you can't find it). * If you cannot access your server's files, it may be EXTREMELY difficult to assist in troubleshooting. * You can upload/share files/logs on discord by: * **A.** rename the file extension to one discord will allow (.txt works). * **B.** copy-paste the contents of the log/file to a site like [https://hasteb.in/](https://hasteb.in/) or [https://ghostbin.co/](https://ghostbin.co/) (auto deletes after a few weeks), Save, and copy url to chat. (or [https://pastebin.com/](https://pastebin.com/) - may want to set expiry time) . * **C.** paste the _entire_ log's contents to chat (discord will turn it into a file) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts02.-check-that-you-have-the-latest-version-of-the-plugin) **TS02. Check that you have the latest version of the Plugin:** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * Run a command in console or as an OPped/admin player: `**/version **` - This will show you the current running version of the plugin and if it has a newer version available. [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-03-latest-server-version) **TS03. Check that you have the latest server version** (Bukkit/Spigot/Paper): ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ * This generally only applies to the **latest version of Minecraft**. _Older versions of MC will have a FINAL BUILD that won't be updated anymore._ * `**/version**` by itself will show you the current running build and how many versions out-of-date it is. * Updating to the latest version is recommenced when you are having issues with core Minecraft functionality, plugins are using code that is not available in the running version, and it is general good practice to update it roughly once a month to ensure smooth server operation. * NOTE: if you're running the bleeding edge of Minecraft. (the latest version of Minecraft Mojang released. You CAN EXPECT there to be issues and plugin non-comparability for several months until developers have updated their code to work on the latest version of Minecraft. PLEASE BE PATIENT. ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-04-update-install-plugin) [**TS04 How to update/install a plugin here**](https://wiki.gpplugins.com/economyshopgui/basics/how-to#ts-04-how-to-update-install-a-plugin) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-05-restart-command) **TS05. Use the /RESTART command, not the /RELOAD command:** ------------------------------------------------------------------------------------------------------------------------------------------------------------ While many plugins may still work when using the /reload command to re-initialize the code for the plugin(s): * It will NOT properly update any plugin that you have updated files/versions of * It is KNOWN to BREAK some plugins that have to initialize during server startup. * While ESGUI may work after a /reload, other plugins may have issues and it recommended that you RESTART the server after adding/removing/updating any plugins/jar-files ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts06-is-about-yaml-here) [**TS06 is About YAML here**](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-07-plugins-list-disabled) **TS07. Check** `**/plugins**` **(or** `**/pl**`**) list for disabled plugin(s):** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * this is an easy way to see if a plugin is disabled(red text when run by a player in-game) due to some error on startup, again, check your **latest.log** to find out why! ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-08-alter-player-balances) [**TS08. How to alter player balances here**](https://wiki.gpplugins.com/economyshopgui/basics/how-to#ts-08-how-to-alter-player-balances-as-admin) ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-09-basic-permissions) [**TS09 basic permissions here**](https://wiki.gpplugins.com/economyshopgui/basics/permission#basic-permissions) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts10.-identify-conflicting-plugins-and-commands) **TS10. Identify conflicting plugins and commands:** ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#plugins) A. Plugins: * **You can only have ONE Permissions plugin** on a server. More than one will cause weird issues/permission denied errors. * \>ANY permission plugin of YOUR CHOOSING will work, but only use one, and make sure it is compatible with your MC version. * Common Permission Plugins: [LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/) (Recommended!), PowerRanks, GroupManager, PermissionsX aka PEX (not maintained, do not use.), MyPermissions, bPermissions, zPermissions, PowerfulPerms, PermissionsBukkit, BungeePerms, etc.... * Bukkit's permissions.yml is not supported/may not work as expected. please use a permissions plugin. ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#commands) B. Commands: * **READ THE PLUGIN PAGE(S)/WIKI(S), commands list, and permissions list, and changelogs when updating for all the plugins you use.** Knowing what your plugins do, have available for you to use and configure is the mark of a knowledgeable server owner/admin/maintainer. * if 2 plugins share the same root command, like `/shop` you can either: * **A.** remove the unwanted/needed plugin with the same command * **B.** use the [commands.yml](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#bukkits-commands-yml-file-examples-see-also-yaml-formatting) (Located in the Root folder of your server) to override/redirect the command. ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#c.-both-either) C. Both/Either: * If you have conflicting Commands, Plugins, Permissions or Other conflict, you can identify what is causing the issue by Removing or disabling plugins you think may be causing the issue ONE-BY-ONE: 1. What did you add/change/remove that may have caused the issue? 2. Remove a suspected conflicting plugin 3. Restart server 4. Test/Retest issue. 1. If issue persists, start step 1 again 2. **I**f issue is resolved/gone. the last plugin removed/disabled is most likely related to the problem - Read up on it! (consult that plugin's documentation/wiki). **IF you have a test server or Plugin manager/unloader (ie: Plugman):** you can use that to unload plugin(s) and re-test the issue instead of restarting. Restart your server after identifying and fixing the issue. Loading/unloading plugins in-game are not supported and may cause issues without a proper restart. ### [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#commands-yml) Bukkit's `Commands.yml` file examples: (see also [YAML formatting](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) ): Copy aliases: promote: - lp user $1 promote ranktrack #the above creates an alias that sends a player name to the LuckPerms command to promote a player along the 'ranktrack' already setup in luckperms demote: - lp user $1 demote ranktrack #same as prev, but for demote superpickaxe: [] #the above disables the superpickaxe command dsrv: - discord $1- #the above creates an alias (anotehr command for) for the discordSRV plugin that will take any number of subsiquent command values shop: - EconomyShopGUI:shop $1- #the above will force the /shop command to ALWAYS open the ESGUI shop (and accept any number of additional arguments/values) shop2: - someotherplugin:shop $1- #the above will open someotherplugin's shop when you use the /shop2 command (and accept any number of additional arguments/values) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-11-reset-a-plugin-to-default) **TS11. How to reset a plugin to defaults (From scratch):** --------------------------------------------------------------------------------------------------------------------------------------------------------------------- We tried everything already and we need to start over... 1. Jar may be corrupt: ([see also TS04 - How to update/install plugins](https://wiki.gpplugins.com/economyshopgui/basics/how-to#ts-04-how-to-update-install-a-plugin) ) 1. Downloading the jar from plugin webpage (ie: [spigot](https://www.spigotmc.org/resources/economyshopgui.69927/) ). 2. _Deleting_ the plugin _jar file_ from your server's `plugins/` folder (you may need to stop the server first) 3. Uploading the file you just downloaded to your server host’s `plugins/` folder 4. Restart the server. 2. If needed, Reset configs to defaults: 1. Backup existing files if needed! 2. Delete all the files in `plugins/EconomyShopGUI/` -or- Rename the files inside it * the plugin only looks for `sections.yml`,`shops.yml`, and `config.yml` files, and a `LanguageFiles` folder. anything else will be ignored. This should fix almost any issue. [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-12-command-isnt-working) **TS12. A command isn't working:** --------------------------------------------------------------------------------------------------------------------------------------- 1. Is it disabled in [ESGUI's config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#command-settings) ? ([command itself](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#command-settings) , or in [specific world](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#commands-in-different-worlds) ?) 2. Do you have to required permissions assigned? (check your permissions plugin, and the [list of permission nodes for ESGUI](https://wiki.gpplugins.com/economyshopgui/basics/permission#permission-nodes) 3. Another plugin also has the same command (remove other plugin, or use [commands.yml](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#bukkits-commands-yml-file-examples-see-also-yaml-formatting) ) [See Conflicting commands](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-10-identify-conflicting-plugins-and-commands) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts13.-32-inventory-title-character-error) **TS13. 32 Inventory Title Character Error** --------------------------------------------------------------------------------------------------------------------------------------------------------------- * Fix your [`lang-.yml`](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) 's `inventory--title:` so it does not exceed 32 characters, this includes formatting characters. There are a couple of these! * This is a limitation in 1.12 and older. [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-14-plugin-is-disabled-errors) **TS14. The plugin is Disabled/Red -or-** `**/shop**` **shows internal error:** ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This is commonly due too one of a few reasons: 1. You do not have an Economy plugin ([Required Dependency](https://wiki.gpplugins.com/economyshopgui/basics/faq#dependencies) ) 2. You do not have [Vault](https://dev.bukkit.org/projects/vault) ([Required Dependency](https://wiki.gpplugins.com/economyshopgui/basics/faq#dependencies) ) 3. You have manually edited your YML file(s) and there is an error. (See [YAML Formatting](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files#yaml-formatting) ) Validate your yml formatting, and then any [other errors will be logged at startup to your latest.log](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-check-your-latest-log-file-for-errors-or-issues) 4. You're not running the latest version of MC and ESGUI's default configs are currently only setup for the latest version of MC. ([See Barrier blocks below](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-15-you-have-barrier-blocks-in-your-shop) ) 5. Something else: [Check your startup logs](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-check-your-latest-log-file-for-errors-or-issues) ! [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-15-barrier-blocks) **TS15. You Have BARRIER blocks in your shop:** ---------------------------------------------------------------------------------------------------------------------------------------------- Default configs for ESGUI are currently setup for the _latest version of MC ONLY._ if you are using an older version you will need to do ONE of the following: **A.** Use [files in #shop-files-sharing on discord](https://discord.com/invite/nPyuB4F) for your version of Minecraft: - NOTE: older versioned files may need to be converted. (see notice(s) in that channel were applicable) **B.** Manually remove the invalid items with the [`/editshop`](https://wiki.gpplugins.com/economyshopgui/basics/commands#deleting-items) command: - NOTE: [invalid items will be logged to your latest.log file](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-check-your-latest-log-file-for-errors-or-issues) so you can easily identify them. **C.** Manually remove the invalid items directly from the yml files: - NOTE: [invalid items will be logged to your latest.log](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-check-your-latest-log-file-for-errors-or-issues) file so you can easily identify them. [See also YAML Formatting](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-16-pig-spawners) **TS16. Placed spawners are all Pig Spawners:** -------------------------------------------------------------------------------------------------------------------------------------------- All of my spawners become pig spawners when I place them. * This is typically due to a compatibility issue between ESGUI and another plugin (both trying to intercept the same event) * Or another plugin is blocking this. [Please see TS10 and read up on the conflicting plugin](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-10-identify-conflicting-plugins-and-commands) , it may need to be configured to allow the spawner-place/break event to work (ex: CMI blocks this by default). How to fix this: * The plugin is currently only compatible with the plugins listed in the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawners-compatibility) . (check that first, this post may be outdated). * Don't sell spawners in the Shop or disable in [sections.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-options) * Purchase [ESGUI Premium](https://polymart.org/resource/economyshopgui-premium.908) which supports NBT Tags and add those tags to the items in the shop. [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-17-mob-spawning) TS17. Mobs aren't spawning from my spawners: ----------------------------------------------------------------------------------------------------------------------------------------- This is not an issue with ESGUI. * ESGUI does not manipulate any spawn conditions. * Ex: slime spawner has the same requirements as natural/vanilla slime spawns: slime chunk or swamp biome ([see MC Wiki for more](https://minecraft.fandom.com/wiki/Spawn#Spawn_cycle) ) * Ex: Passive mobs require Grass Blocks to spawn on ([See MC Wiki for more](https://minecraft.fandom.com/wiki/Spawn#Spawn_cycle) ) * Another plugin is blocking mob-spawning. * Plugins such as Worldguard have the capability to prevent mob spawning (allowed by default) * Other plugins, [See TS10.C. and test.](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-10-identify-conflicting-plugins-and-commands) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts18.-players-cant-place-break-blocks) TS18. Players can't place/break blocks: ------------------------------------------------------------------------------------------------------------------------------------------------------- This is not a problem with ESGUI. ESGUI does not prevent any block breaking or placing. Plugins such as the following (or others) have the ability to prevent these actions: * (not a plugin) Spawn Protection distance. builtin to bukkit.yml * Essentials Protect can block players form placing/breaking blocks in places you don't want them to. (Configure it, or remove it) * Worldguard can block placement/breaking of blocks for players who aren't a member/owner of the region the block is attempted to be placed in * Other plugins, [See TS10.B.C. and test.](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-10-identify-conflicting-plugins-and-commands) [](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-19-different-prices-with-sell-command) TS19. Players are getting different prices with the `/sell` command -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The `/Sell` command is NOT part of ESGUI. It is usually found as a part of the Essentials(X) plugin. * ESGUI's command is `/sellall` To fix the issue, do one of the following: * A. Delete the contents of Essential's worth.yml and `/ess reload` * B. Disable or re-direct/alias the `/sell` command using the [commands.yml](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#bukkits-commands-yml-file-examples-see-also-yaml-formatting) * C. Block the command with permissions. (consult your permissions plugin) ESGUI may have a method to synchronize these in the future. Please be patient. [PreviousPermissions:](https://wiki.gpplugins.com/economyshopgui/basics/permission) [NextGeneral How-To's:](https://wiki.gpplugins.com/economyshopgui/basics/how-to) Last updated 5 months ago Was this helpful? --- # General How-To's: | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#updating-installing-plugins) Updating/Installing plugins ------------------------------------------------------------------------------------------------------------------------ When there is a new version available to download, it is important to [**read the changelogs**](https://www.spigotmc.org/resources/economyshopgui.69927/updates) of the update (Typically found on the [plugin's page](https://www.spigotmc.org/resources/economyshopgui.69927) ) for major updates that require a configuration change or config files to be updated. * Make backups of your files before updating! While we do not expect files to be lost/overwritten, it can happen) Once you have read the changelogs its time to update the plugin jar, its easy. You just need to replace the old plugin jar that is located in your server plugins folder with the new one. * It is best practice to **Delete the old plugin jar** file, and **Upload a fresh copy** manually to minimize any potential corruption issues. Most of the time a plugin jar will be named after the plugin and following with the version name. Example: `EconomyShopGUI 3.0.8` [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#plugin-files) How to find your plugin's files: -------------------------------------------------------------------------------------------------------------- [Please read About YAML](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) before editing your files! It DOES NOT tolerate any errors! [Validate it!](https://jsonformatter.org/yaml-validator) * First you need to find your `plugins` folder inside your server's file system. (**Please consult your serverhost's support/documentation on how to access your files!**) * Once inside the `plugins` folder; Open the `EconomyShopGUI` (\*`EconomyShopGUI-Premium` if you have Premium) folder. * Here you will find the[`config.yml`](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) , `Example items.txt`,[`shops.yml`](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) and [`sections.yml`](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) files. (the file extension (`.yml/.txt` ) may be hidden) * Open the file from your serverhost's file manager, or use a program such as [notepad++](https://notepad-plus-plus.org/downloads/) or any other text editor on your local machine. (these are the simplest methods, but you can also use FTP/file sync programs as well which require some more steps, see the application and serverhost documentation for more.) * Now you can start editing your config/shops/sections! See [Config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) , [Sections.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) , [Shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) , and [language](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) pages for more details. * Please Note that YAML does not tolerate any missconfiguration/errors. [Validate your file(s)](https://jsonformatter.org/yaml-validator) here before contacting support. [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#upgrade-to-premium) How do I upgrade to premium? ---------------------------------------------------------------------------------------------------------------- * Purchase the Premium version on [SpigotMC](https://www.spigotmc.org/resources/economyshopgui-premium.104414/) , [Songoda](https://songoda.com/marketplace/product/economyshopgui-premium-esgui-prem.595) or [Polymart](https://polymart.org/resource/economyshopgui-premium.908) * Remove the free version (Jar file only!) from your server and install/upload the premium version. * Then use the [Import command](https://wiki.gpplugins.com/economyshopgui/basics/commands#import-command) to copy your old files from the free version of the plugin. That easy! * Optionally remove the free version's files _after importing_ them to the premium version. [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#backup-files) Updating shops and sections config without losing any modification (Backup files) --------------------------------------------------------------------------------------------------------------------------------------------------------------- To update these configs you need to first [locate the plugin folder](https://wiki.gpplugins.com/economyshopgui/basics/how-to#plugin-files) . To make sure you don't lose any date/modifications you made in the shops and sections config you can: M**ake a backup of the files to another location and remove the current ones.** **Or** **rename the config files from** `**shops.yml**` **to** `**shops-old.yml**` **and** `**sections.yml**` **to** `**sections-old.yml**`**.** _(anything not the original filename.)_ If the plugin can't find the shops, sections, languages or config yml files, it will create new files with the defaults (options, values, prices, displaynames, etc...) when the plugin is next loaded with `/sreload` or server restart/reload. Now you have the 2 shops and 2 sections configs (New and Old). If you did it right, the current configs that are used by the plugin are named `shops.yml` and `sections.yml` and are located inside the plugin folder of EconomyShopGUI. Now the most important step, you need to copy all data/modifications you made in the old config files to the new ones but make sure to keep any core updated modifications in the new config (like option names, functions, ...), otherwise it might cause the plugin to not function correct. * As ESGUI is updated, the format of some keys and other settings change and the `config-version: #` in the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#config-version) is updated to facilitate automatic updates of file formatting and settings. * If you find something is not working, please verify the format of the keys/settings in your files is up-to-date with this wiki and recent changelogs! If you did it right, restart/reload the server or reload the plugin and the shop ingame will have the new configuration files with all of your modification from previous versions. If you are getting errors in console ([Like this one](https://pastebin.com/DNF5frGr) ) or the plugin is disabled. [You most likely have a error inside the new configuration files.](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) Check [Troubleshooting](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting) for more common issues. ### [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#updating-shops-and-sections-config) Updating shops and sections config If you don't want to keep any modifications you made, updating is that simple as removing the old [shops.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) and [sections.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) config and then [restart/reload the server or reload the plugin](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-05-restart-command) . [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-update-install-a-plugin) **How to update/install a plugin:** ----------------------------------------------------------------------------------------------------------------------------------- 1. When Updating plugins **read the change-logs** for your plugin(s), these will be posted to the Updates tab of the plugin page. You may need to make additional changes other than just replacing the .jar file. 2. Download the .jar from [spigot](https://www.spigotmc.org/resources/economyshopgui.69927/) /[bukkit](https://dev.bukkit.org/projects/economyshopgui) /[polymart](https://polymart.org/resource/456) /etc plugin page. _\-NOT your serverhost's 'install plugin button' thing/page, these are notoriously buggy/unreliable and outdated!_ 3. Upload to your server-host's `plugins/` folder (AND delete any previous versions of that plugin you may have, DON'T leave duplicates!) 4. Restart the server, (at this point it should be working!) 5. Optionally/As-Needed: check the config folder for your plugins (inside the `plugins//` folder) and configure the plugin how you want, should you want to change any of the default settings the plugin has created. _(READ the Documentation/WIKI/Comments!) (Changing plugin settings will require either that plugin's internal reload command, or a server restart)_ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-override-a-command-using-commands.yml) **How to override a command using commands.yml:** --------------------------------------------------------------------------------------------------------------------------------------------------------------- The commands.yml is a configuration located inside your main server folder(aka the folder where your server .jar is located) and can be used to override commands from a specific plugin. * Open the commands.yml config located in your main server folder * Add the **shop** command and override it to always use EconomyShopGUI, this should look something like `EconomyShopGUI:shop $1-` * `EconomyShopGUI:shop` means it will use the /shop command of EconomyShopGUI. * **Note** that if you're using the Premium version, it should be `EconomyShopGUI-Premium:shop` instead * `$1-` means any following command arguments will be used, this is important! * Save the file, followed by a server restart to load the changes made. **The final commands.yml should look something like this where the shop and sell command is overriden to always use the EconomyShopGUI command:** Copy command-block-overrides: [] ignore-vanilla-permissions: false aliases: icanhasbukkit: - version $1- shop: - EconomyShopGUI:shop $1- sell: - EconomyShopGUI-Premium:sellall $1- # If using the Premium version, # the syntax is 'EconomyShopGUI-Premium:' [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-alter-player-balances-as-admin) **How to alter player balances (as admin):** --------------------------------------------------------------------------------------------------------------------------------------------------- * Please check the **commands for your vault-compatible ECONOMY plugin** (such as [essentials](https://essinfo.xeya.me/commands.html) ) * [Vault](https://dev.bukkit.org/projects/vault) is an API (Middle-man, and does not have any commands.) * ESGUI Does Not store or handle player balances. Your Economy plugin stores it, and Vault connects everything together. * If using [Essentials(X)](https://essinfo.xeya.me/commands.html) , the command is [`/eco`](https://essinfo.xeya.me/commands.html) to alter player balances. [Please review the Essentials WIKI for much more info about it!!](https://essentialsx.netlify.app/wiki/Home.html) [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-make-a-hidden-shop-workaround) How to make a hidden shop: (Workaround) --------------------------------------------------------------------------------------------------------------------------------------------- You can make a 'hidden shop' with this work-around until we add an official setting/code to hide shops in the future: * setup shop.yml items * setup section.yml shop/section as a glass pane with an ambiguous displayname (\[like `""`(same as the [fill-item](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#mainshop-fill-item)\ ), _**and**_ use/enable the [fill-item](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#mainshop-fill-item)\ in the [sections.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml)\ so no-one will ever suspect)\ \ * setup permissions so everyone can access normal/other shops (define EVERY node in permissions system. and DO NOT USE the `EconomyShopGUI.shop.all` node)\ \ * If needed: Lastly, if needed: have an NPC run the `/shop
` as console -or- assign permission for the hidden shop to your VIP group so they can access it via command (or click the 'fake' fill item in the GUI).\ \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-store-share-money-as-an-item)\ \ How to store/share money as an item:\ \ \ -----------------------------------------------------------------------------------------------------------------------------------------\ \ (alternative to keeping it in your vault/Economy plugin or a `/pay` command)\ \ Configure an item to have enchants or tags that cannot be replicated in survival and set it to have the same buy and sell price. (It would be better to use hidden [NBT tags](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#nbt-data)\ , but that requires premium) ex:\ \ Copy\ \ 1000:\ material: PAPER\ name: "&a$5000 Voucher"\ buy: 5000\ sell: 5000\ lore:\ - "&a$5000 Voucher"\ - "Buy/Sell in the servershop to redeem"\ NBTData: {ESGUI:{Voucher:5000}} # Premium feature/value only (mc 1.20.4 and below)\ components: '{"minecraft:custom_data":{ESGUI:{Voucher:5000}}}' # Premium feature/value only (mc 1.20.5 and above)\ \ Note: This is the same thing as withdrawing money from the bank in real life. If you loose it, it's gone forever. The currency withdrawn/deposited is the can be used anywhere when in the 'bank/vault-eco-plugin' (not just ESGUI)\ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-create-custom-item-economys)\ \ How to create custom item economy's: **\*Premium feature**\ \ \ --------------------------------------------------------------------------------------------------------------------------------------------------------------\ \ Item economys are already a unique feature of the plugin, but it becomes even more powerfull when you can create your own currency's using custom ingame items.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to)\ \ How to:\ \ EconomyShopGUI wouldn't comply its plugin tag if there wasn't an easy command to format the item for you.\ \ To set the economy to an custom item from your inventory on\ \ * **sections**\ \ * **Command**: `/editshop editsection
set economy handItem`\ \ \ * **shop items**\ \ * Command: `/editshop edititem
set economy handItem`\ \ \ \ which will automatically try to format the item from your hand as an valid item economy and apply it to the specific section/item. No need to go thru the hassle of formatting it yourself!\ \ Additionally you can copy the formatted value from your config to the default economy provider.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#format)\ \ Format:\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#examples)\ \ Examples:\ \ * Custom item economy using a player skull\ \ * **Format:** `economy: ITEM:material:PLAYER_HEAD name:&6&lCustom coin skullowner:Notch id:Creator`\ \ \ * Custom item currency using custom name, lore and custom model data\ \ * Format: `economy: ITEM:material:ARROW name:&6&lSniper ammo lore:&cThis ammo can be used for the following guns:\n&aBarret\n&aP90 CustomModelData:1003 id:Bullets`\ \ \ * Custom item currency using enchantments and NBTData\ \ * Format: `ITEM:material:Diamond name:&9Real money enchantments:SHARPNESS:5,EFFICIENCY:3,MENDING,UNBREAKING:2 NBTData:{Damage:5}`\ \ \ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#cutom-currency-displaynames)\ \ Cutom currency displaynames:\ \ Using the ID of the currency you can set the displayname, this is the name which is used to display the currency to the user on shop items.\ \ The first step would be to give the currency a ID using the 'id' flag, see the above examples for how it should be done.\ \ After that you will have to use the ID to set a custom display format inside the config.yml, see an example of how it would look like using a custom item economy [**here**](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#currency-formats)\ .\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#allowed-item-options)\ \ Allowed item options:\ \ * **id**\ \ * **Desciption:** _The ID of the item economy, this is used for easily setting the currency's singular and plural form_\ \ * **Example**: `id:Bullets`\ \ \ * **material** \- The type of the item\ \ * **Description**: _The type of the item._\ \ * **Example**: `material:ARROW`\ \ \ * **name** \- The name of the item. Supports chat and hex colors.\ \ * **Description**: _The name of the item. Supports chat and hex colors._\ \ * **Example**: `name:&9&lCustom coin`\ \ \ * **lore**\ \ * **Description**: _The lore of the item. Supports chat and hex colors. Multiple lines are split using '\\n'._\ \ * **Example**: `lore:This is a custom message\n&cYou can use &4&lcustom &ccolors aswell!`\ \ \ * **skullowner**\ \ * **Description:** _The skull owner of the item_\ \ * **Example**: skullowner:Notch\ \ \ * **skull-texture**\ \ * **Description**: _The skull texture of the item, valid values can be grabbed from_ [_this_](https://minecraft-heads.com/custom-heads/)\ _site._\ \ * **Example**: `skull-texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA 6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvM2ZkYWI0MDQzNGVkNWQwMWY1OGM0NWNhMGM5ZmFkYTQ2NjJlMTc3MmZmNDNlMjk3NDk3OTQ0MGE1Y2ZlMTVjOSJ9fX0=`\ \ \ * **enchantments**\ \ * **Description:** _The enchantments of the item. Multiple values are split using ,_\ \ * **Example**: `enchantments:SHARPNESS:5,EFFICIENCY:5,MENDING,ecoenchants:BLAST_MINING:3,advancedenchants:STRIKE:2,excelentenchants:BLAST_MINING:3`\ \ \ * **potiontypes**\ \ * **Description**: _The potion effects of the item. Multiple values are split using ,_\ \ * **Example**: `potiontypes:FIRE_RESISTANCE,STRONG_HARMING,LONG_INVISIBILITY`\ \ \ * **stew-effect**\ \ * **Description**: _The stew effect for this SUSPICIOUS\_STEW. Multiple values are split using ,_\ \ * **Example**: `stew-effect:WITHER,POISON`\ \ \ * **instrument**\ \ * **Description**: _The goat horn sound when played_\ \ * **Example**: `instrument:ADMIRE`\ \ \ * **CustomModelData**\ \ * **Description**: _The CustomModelData for the item_\ \ * **Example**: `CustomModelData:1003`\ \ \ * **NBTData**\ \ * **Description**: _Sets the raw data of the item_\ \ * **Example**: `NBTData:{Damage:50,HideFlags:127}`\ \ \ * **components:**\ \ * **Description:** _Like the NBTData option, this specifies the item's raw component data for 1.20.5+_\ \ * See this site on how to update NBTData to components: [https://nbt-converter.gpplugins.com/](https://nbt-converter.gpplugins.com/)\ \ \ * **Example:** `components:{"minecraft:consumable":{},"minecraft:food":{nutrition:5,saturation:7.0f}}`\ \ \ * **ignored-tags:**\ \ * **Description:** _Ignores NBT/component data on the item_\ \ * **Example:** `ignored-tags:enchantments,trim,food`\ \ \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-make-an-npc-shop)\ \ How to make an NPC shop:\ \ \ -----------------------------------------------------------------------------------------------------------------\ \ Note that we use [Citzens](https://ci.citizensnpcs.co/job/Citizens2/)\ in this tutorial, any other NPC plugin will work if it supports clickable commands.\ \ **1\. Create the NPC with** `**/npc create Test**` **see their wiki** [**here**](https://wiki.citizensnpcs.co/Commands)\ **for more info on how to use the commands.**\ \ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MZmdrb_zzELOT205C0e%252F-MZmo9fypFRLtpcNAnGG%252F2021-05-03_17.19.04.png%3Falt%3Dmedia%26token%3D3f60fc00-3b6a-4496-8c8c-01e7f8f0128d&width=768&dpr=4&quality=100&sign=2d4b4a48&sv=2)\ \ **2\. Assign the shop command to the NPC with** `**/npc command add shop

**` **to open the shop section for the player that clicks it.**\ \ **You can also assign the command** `**/npc command add shop

**` **to the npc to open the main shop for the player instead of opening a section.**\ \ **If you want to restrict access to certain sections, you can add a permission check to the NPCs with the command** `**/npc cmd -l -r --permissions economyshopgui.shop.

add shop

**`\ \ **This requires that the interacting player has the specified section permission set to true to be able to access the NPC**\ \ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MZmdrb_zzELOT205C0e%252F-MZmvrTDSf1HScW2BwVJ%252F2021-05-03_17.52.59.png%3Falt%3Dmedia%26token%3D4d92ba75-c3d9-4f6b-b4ad-c26c00eadcc9&width=768&dpr=4&quality=100&sign=a5509b48&sv=2)\ \ Note that this command will be executed as the console meaning that the player doesn't need permissions to open the specified shop section. Use -p to run the command as the player. See their wiki [here](https://wiki.citizensnpcs.co/NPC_Commands)\ for more info about the clickable commands.\ \ **3.** _**Optional:**_ Disable the [back button inside the config.yml](https://gpplugins.gitbook.io/economyshopgui/file-configuration/config.yml#disable-back-button)\ so the player cannot go back to the main shop and open another shop section. (This allows your server to have NPC only shops)\ \ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-M6QXvrDDroId1RhlXgl%252F-MZmdrb_zzELOT205C0e%252F-MZmyd-_HND9CSt9JMzI%252F2021-05-03_18.05.20.png%3Falt%3Dmedia%26token%3Dd2edf1d9-8e3f-4a5c-9f76-3a00f1fa7eac&width=768&dpr=4&quality=100&sign=6d90e599&sv=2)\ \ **4.** _**Optional:**_ To prevent players from accessing the shops via commands/gui you need to do the following with your permissions system/plugin: Set the following for all players/groups you don't want to have access to the /shop command (usually the default group):\ \ **4a.** DISABLE/FALSE/NEGATE access to EconomyShopGUI.shop (/shop command itself)\ \ **4b.** ALLOW/TRUE access to EconomyShopGUI.shop.all (_**or**_ _specific shop section(s)_, allows access to specific shop sections)\ \ If setting up a specific/single shop as NPC only: Do NOT use the EconomyShopGUI.shop.all node. Setup permissions for the default group for **every** shop-section you want everyone to have access to (ie: EconomyShopGUI.shop.redstone , etc..). And do NOT define/allow access to the shop(s) section you only want accessible via NPC. Players will access this shop via the NPC who will run a [command as console: /shop

](https://wiki.gpplugins.com/economyshopgui/basics/commands#commands)\ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-setup-the-discordsrv-hook)\ \ How to setup the DiscordSRV hook:\ \ \ -----------------------------------------------------------------------------------------------------------------------------------\ \ The [DiscordSRV hook](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discordsrv-hook)\ allows the plugin to log shop transactions made either thru the GUI or sell commands to a specific discord channel. See below on how to set this up for your server.\ \ 1. Start by setting up DiscordSRV itself and make sure it works. You can find a how to guide on their [website](https://docs.discordsrv.com/Installation/)\ .\ \ 2. When DiscordSRV works, you firstly need to configure the channel you want to send logs to inside the DiscordSRV config.yml itself. See their documentation [here](https://docs.discordsrv.com/installation/initial-setup/#set-up-a-basic-channel-relay)\ on how to setup a channel.\ \ 3. After creating and enabling the channel in DiscordSRV, reload the plugin using `/discordsrv reload`, then you will have to enable the discord hook inside the config.yml from EconomyShopGUI. `enable-discordsrv-hook: true`\ \ 4. Add the channel **name(Not ID)** to the `channel` option under the [DiscordSRV hook settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discordsrv-hook)\ .\ \ 5. Configure the chat message which will be send to discord to your likings. For default it uses a embed styled message but you can use the `raw: ""` option to make it send a raw message instead.\ \ 6. Finally you need to reload EconomyShopGUI using `/sreload` and when done correctly you will see the configured message inside your discord channel when purshing/selling items!\ \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#migration-of-data-to-v2)\ \ Migration of data to V2:\ \ \ -----------------------------------------------------------------------------------------------------------------\ \ This section will explain how to migrate your current shop layout to EconomyShopGUI v6/EconomyShopGUI Premium v5 using the migration command.\ \ It is recommended to **create a backup** of your current shop data before migration, just in case. This includes the shops.yml, sections.yml, config.yml and the database if you are using the premium version.\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#start-by-updating-the-plugin-like-normal)\ \ Start by updating the plugin like normal\ \ * Download the latest version of EconomyShopGUI from your favorite plugin site.\ \ * Stop the server\ \ * Remove the old version of EconomyShopGUI(Premium)\ \ * **Jar file only!** Do not delete the plugin folder obiviously!\ \ \ * Restart the server\ \ \ At this point the plugin will create the default shop layout, so the next steps are only required if you want to keep your current shop layout.\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#using-the-migration-command)\ \ Using the migration command\ \ * Use command `**/eshop migrate economyshopgui V1toV2 --override**` to start migration to new file structure\ \ * The **\--override** flag will override the default shops layout\ \ \ * Now simply reload the shops layout using command /sreload.\ \ \ Congratulations, you successfully migrated to the new shop structure. That wasn't hard, was it?\ \ If you're using the premium version of the plugin, you might also follow the next step to migrate your database. Only required if you want to keep limited stock and sell limit data for shop items.\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#migrating-the-database-premium-only)\ \ Migrating the database _\*Premium only_\ \ * Before migrating your database, just **make sure there is a backup**, we will not be responsible for any dataloss if you haven't made backups!\ \ * Make sure all your shops and sections have already been migrated to the new file structure and they are loaded in EconomyShopGUI using /sreload, because **migrating the database will only migrate items which exists in your current shop layout!**\ \ * Use command `**/eshop migrate economyshopgui V1toV2 --database**` to start migration to the new database structure\ \ * **\--database** flag will try to migrate the data for limited stock and sell limits for items\ \ * Everything except DynamicPricing data will not be kept\ \ \ \ At this point, your done if the migration command didn't report a error, simply restart your server once more to successfully reload all changes!\ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-use-itemsadder-to-use-an-image-as-shop-background-premium-only-requires-itemsadder)\ \ How to use ItemsAdder to use an image as shop background: _\*Premium only, requires ItemsAdder_\ \ \ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\ \ Using ItemsAdder you can set up a custom image from your Resource Pack to show as a background for your shop.\ \ As a precondition for this you'll have to have ItemsAdder set up and running and have the following prepared:\ \ * The images you want to use, located in the resource pack of your /ItemsAdders/contents/ folder. For this example, the images will be called filename\_1 and filename\_2\ \ * Additional Information on how to set up ItemsAdder can be found on their Wiki: [https://itemsadder.devs.beer/first-install](https://itemsadder.devs.beer/first-install)\ and [https://itemsadder.devs.beer/plugin-usage/adding-content/guis](https://itemsadder.devs.beer/plugin-usage/adding-content/guis)\ \ \ 1. To use the image for the main shop UI:\ \ 1. Open your used language file and replace the inventory-main.shop-title: with ':offset\_0::filename\_1::offset\_0::filename\_2:' with offset being the horizontal offset of the image.\ \ 2. Use /sreload to view the placement of the images in the shop\ \ 3. Experiment with different offset values to make the images fit to your liking.\ \ \ 2. To use the image for a section:\ \ 1. Do the same as 1) but instead of setting the main shop title in the language file, replace the shops title in it's section file\ \ \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#creating-subsections-in-a-shop)\ \ Creating SubSections in a shop:\ \ \ -------------------------------------------------------------------------------------------------------------------------------\ \ SubSections are sections that can only be opened by clicking on a specific item in an existing section the same way as you click on an item in the main menu.\ \ Other than that SubSections are essentially the same as any other section and are edited and used the same way, either by editing the section and shop file directly or using the editshop and editsection commands.\ \ To make subsections within another section you need the following:\ \ * A primary section, similar to the main menu, you will click an item to open a different section. For this example we will call this **Blocks**\ \ * Any number of secondary sections, which will contain the items you want to sell. For this example we will call these **Wood**, **Stone** and **Glass**\ \ \ Make sure to reload the plugin after every step using `/sreload`\ \ 1. Create the primary section **Blocks**\ \ * Use the `/editshop addsection` command\ \ \ 2. Create the sections **Wood**, **Stone** and **Glass**\ \ * Use the `/editshop addsection` command\ \ \ 3. Enable the _sub-section_ property for the **Wood**, **Stone** and **Glass Section**\ \ * Use`/editshop editsection add sub-section true`\ \ \ 4. Add three shop items to the **Blocks** section, one being a plank, one being cobblestone and one being glass\ \ * Use the `/editshop additem` and `/editshop edititem` commands\ \ \ 5. Add the _section_ property to the items and use the respective section names (**Wood**, **Stone** and **Glass**)\ \ * Use the `/editshop edititem Blocks add section ` command\ \ \ \ Finally open the Blocks section and verify that the subsection items are working, then you can fill them with content.\ \ The section config of **Blocks** should look similar to this:\ \ Copy\ \ enable: true\ slot: 19\ title: ''\ hidden: false\ display-item: false\ fill-item:\ material: AIR\ nav-bar:\ mode: INHERIT\ item:\ material: GRASS_BLOCK\ displayname: '&2&lBlocks'\ name: '&2&lBlocks'\ \ The section config of **Wood** should look something like this\ \ Copy\ \ enable: true\ item:\ material: OAK_LOG\ displayname: Wood\ slot: 4\ sub-section: true\ \ The shops config of **Blocks** should look somewhat like this\ \ Copy\ \ pages:\ page1:\ items:\ 1:\ material: OAK_PLANKS\ displayname: Wood Blocks\ buy: -1.0\ sell: -1.0\ section: Wood\ \ 2:\ material: COBBLESTONE\ displayname: Stone Blocks\ buy: -1.0\ sell: -1.0\ section: Stone\ \ 3:\ material: GLASS\ displayname: Glass Blocks\ buy: -1.0\ sell: -1.0\ section: Glass\ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-use-shopstands)\ \ How to use ShopStands:\ \ \ -------------------------------------------------------------------------------------------------------------\ \ ShopStands is a seperate module within EconomyShopGUI adding a new variant of physical shops. Unlike NPC shops, these shops open a custom buy/sell menu for the item itself instead of a whole section.\ \ ShopStands are similar to sign shops, but with a modern touch!\ \ This feature comes within its own module, meaning that when disabled, it won't affect performance at all.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#creating-a-new-shop-stand)\ \ Creating a new shop stand\ \ * By default this module is disabled, if not already enabled, [enable it](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#shopstands-module)\ inside the config.yml\ \ * After enabling it, reload the plugin using `/sreload`\ \ \ * Give yourself a new shop stand to place down\ \ * `/eshop shopstands give
`\ \ \ * Simply place the item on the location you want to create the shop stand\ \ * Done, your ShopStand is now ready to use\ \ \ \ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FSz9yaRKCvjdeHEZocoHS%252Fimage.png%3Falt%3Dmedia%26token%3D52d7c975-4c40-43ee-9551-c90ff2131ad2&width=768&dpr=4&quality=100&sign=401ec8cc&sv=2)\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#using-a-shop-stand)\ \ Using a shop stand:\ \ * To open the **buy menu**: **Left click** the shop stand\ \ * To open the **sell menu**: **Right click** the shop stand\ \ * To open the **admin GUI** of a shop stand: **Shift click** the shop stand\ \ \ [](https://wiki.gpplugins.com/economyshopgui/basics/how-to#obtaining-item-indexes-of-shop-items)\ \ Obtaining item indexes of shop items\ \ \ ------------------------------------------------------------------------------------------------------------------------------------------\ \ In several places(for example to edit a item using commands or using price placeholders) you will need the item index of the item inside the shop configuration.\ \ This can simply be obtained by hovering with your mouse over a shop item inside a shop, which will display a gray line by default which mentions the item's section and itemIndex.\ \ Note that this lore is only visible to OP players or users with the permission 'EconomyShopGUI.eshop.itemindexes'!\ \ Note that this lore is only vivible if the _'admin-lore'_ entry is listed under the [config option _'lore-arrengement'_](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#lore-arrangement)\ !\ \ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252Fmsu1bvCuwjgas6rAukWC%252Fimage.png%3Falt%3Dmedia%26token%3Dc70003c9-2ef8-427c-9658-f2639b08c396&width=768&dpr=4&quality=100&sign=b2b1ff60&sv=2)\ \ Example item with section _'Prefixes'_ and itemIndex _'page1.items.10'_\ \ [PreviousTroubleshooting:](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting)\ [NextLimited Items](https://wiki.gpplugins.com/economyshopgui/basics/limited-items)\ \ Last updated 1 month ago\ \ Was this helpful? --- # Limited Items | EconomyShopGUI wiki You can use limited stock aswell as sell limits on the same item. [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#limited-stock) Limited stock --------------------------------------------------------------------------------------------------- Limited stock for specific items could be usefull if you have a special item on your server which you want to be limited for a few players on your server only for example. The feature comes with two options where you can limit the item: 1. [**Global stock**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock) = Limited stock for a specific item where the whole server(each player) can purchase a specified amount of items. 2. [**Player stock**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock) = Limited stock for a specific item where each player individually can purchase a specified amount of items. You can also specify a restock time, if specified when the item gets out of stock it will automatically count down and restock the item for the player or globally. The data for this feature will be saved inside a SQLite database so that it will be consistant over server restarts. When using the item option 'refill-stock', the stock limit for an item on a global or player setting will refill when the items are sold back to shop. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#global-stock) Global stock: Using the [**stock-limit-global**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock) item option, it is possible to specify a amount of stock that the item will have. All players will have the same amount of stock for the item, if someone purchases for example 5 items, the stock will drop with 5 **for every player on the server.** #### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restocking-global-stock) Restocking global stock: 1. Using the [**auto-restock-global-stock**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock) item option, a item can be set to restock after X amount of time**.** 2. Using the [**auto-restock-global-frequency**](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#global-stock) item option, a item can be set to stock after a specified interval. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#player-stock) Player stock: Using the [`**stock-limit-player**`](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock) setting on the item you can specify a amount of stock that every player individually will have for the item. Each player will start with the same amount of stock for the item(which was specified) and can purchase the amount of items that there are in stock till it runs out **for each player individually**. So for example when using the option `**stock-limit-player: 5**` on a item, each player would be able to purchase the item 5 times. #### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restocking-player-stock) Restocking player stock: 1. Using the [**auto-restock-player**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock) item option, a item can be set to restore its stock limit after X amount of time **for a specific player.** * Keep in mind that unlike the fixed frequency, only the player reaching its sell limit will be restored to the original quantity configured inside the config. 2. Using the [**auto-restock-player-frequency**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock) item option, a item can be set to restock after a specified interval. * Keep in mind that unlike the restock time, when a item gets restocked it will happen for **all players** on the server. [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#sell-limits) Sell limits ----------------------------------------------------------------------------------------------- Items using a sell limit, like you may have guessed, are only sell-able for a certain amount. This feature can be used together or seperatly on items with limited stock. There are two modes which can be used to limit a item per player or globally: 1. [**Global sell limits**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit) = Limited amount of items which can be sold spread over the whole server. 2. [**Player sell limits**](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#player-sell-limits) = Limited amount of items which can be sold for each player seperatly. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#global-sell-limits) Global sell limits: Using the [**sell-limit-global**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit) item option, it is possible to set a sell limit for the specific item for all players on the server. Global sell limits will make it so players can buy the same amount over the whole server. For example a player sells 10 items while the global sell limit is set to 10, no other player will be able to sell the same item again untill its restocked. #### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restoring-global-sell-limits) Restoring global sell limits: 1. Using the [**auto-restock-global-sell**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit) item option, a item can be set to restore its sell limit after X amount of time**.** 2. Using the [**auto-restock-global-sell-frequency**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit) item option, a item can be set to restore its sell limit after a specified interval. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#player-sell-limits) Player sell limits: Using the [**sell-limit-player**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-sell-limits) item option, it is possible to specify a per player based sell limit. For example when a player sell limit of 64 has been set, each player will be able to sell 64 of that item. #### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restoring-player-sell-limits) Restoring player sell limits: 1. Using the [**auto-restock-player-sell**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-sell-limits) item option, a item can be set to restore its sell limit after X amount of time **for a specific player.** * Keep in mind that unlike the fixed frequency, only the player reaching its sell limit will be restored to the original quantity configured inside the config. 2. Using the [**auto-restock-player-sell-frequency**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-sell-limits) item option, a item can be set to restore its sell limit after a specified interval. * Keep in mind that unlike the restock time, when a item gets its sell limit restocked it will happen for **all players** on the server. [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restocking-stock-limit-types) Restocking stock/limit types: ---------------------------------------------------------------------------------------------------------------------------------- Currently there are two options for restocking items/limits. * **Restock time:** A specific duration after the item's stock/limit has reached 0. * **Fixed frequency:** A set interval which triggers a restock at a specific time stamps. A restock duration/interval is optional, making it possible to make a one time sell-able/buy-able item. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#restock-time) Restock time: The item is able to restock its stock/limit automatically after a specified time. It is important to keep in mind that this duration only starts counting down when the stock/limit has reached 0. So for example: If there was a stock limit of 50 on a item and when the `**auto-restock-global/player: 10m**` option was specified, the 10 minutes count down will only start when the stock/limit has fully reached 0 and will restock the item to its original amount after 10 minutes. ### [](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#fixed-frequency) Fixed frequency: Using a fixed time it allows us to specify a frequency to restock for example each hour at 25 minutes or rather each Sunday at 7PM. Unlike the restock time, this frequency will happen every x time specified **even** if there is still stock/limits available for the item. Unlike some other cron schedulers we use the populair java Quartz Cron Scheduler which has a slightly different context as some others. The following is how a valid cron schedule should look like: `**auto-restock-player-frequency: 0 0 0 ? * ***`**.** A valid schedule format exists of 6 or 7 values: seconds, minutes, hours, day of month, month, day of week and the optional Year. See the following screenshot for more info: ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FoRAd1o3j2e3fkKrG3qvf%252Fimage.png%3Falt%3Dmedia%26token%3D5ca29350-739f-4bed-9d0d-5a191d3ee300&width=768&dpr=4&quality=100&sign=ea64c3ca&sv=2) To give you some cron schedule examples using the `**auto-restock-player-frequency:**` option: Value Description auto-restock-player-frequency: 0 0 0 ? \* \* Restock player stock every day at 00:00 noon auto-restock-global-frequency: 0 0 12 \* \* ? Restock global stock every day at 12 PM noon auto-restock-global-frequency: 0 30 11 ? \* MON-FRI Restock global stock every Monday, Tuesday, Wednesday, Thursday and Friday at 11:30 AM auto-restock-player-sell-frequency: 0 30 16 ? \* FRI Refill player sell limits every Friday at 4:30 PM auto-restock-player-global-frequency: 59 29 \* ? \* \* Refill global sell limits every hour at 29 minutes and 59 seconds auto-restock-global-frequency: 0 0 12 \* \* ? 2023-2025 Restock global stock every day at 12 PM noon aslong as it is either Year 2023, 2024 or 2025 See more examples on the official Quartz docs here: [http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) [PreviousGeneral How-To's:](https://wiki.gpplugins.com/economyshopgui/basics/how-to) [NextAbout YAML (YML files)](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) Last updated 1 year ago Was this helpful? --- # About YAML (YML files) | EconomyShopGUI wiki **YAML has very specific syntax spacing and does NOT tolerate any misplaced/missing spaces/symbols!** [**Validate it!**](https://jsonformatter.org/yaml-validator) When editing your YML files, please make sure you adhere to YAML's _**very specific**_ syntaxing and formatting outside of any double-quoted-text lines. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files#yaml-formatting) YAML Formatting: --------------------------------------------------------------------------------------------------------------------------- * There will be a SPACE after any `:` character and the following value * Every 'Indent' level you see in the file is TWO SPACES for every level. (NO Tab) * Any line that begins with a `#` is a comment and will be ignored by the plugin * if you encounter any errors after altering your file, or are new to editing these files. [USE AN ONLINE YAML PARSER to validate your file!](https://jsonformatter.org/yaml-validator) . It will immediately identify any formatting errors that **you will need to fix** before proceeding #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files#common-errors) **Common errors:** * Bad spacing: (does not conform to [even-numbered-space-character-indenting](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files#spacing-for-shops-yml) ) * Missing space: after an expected value a space is missing. * ex (displayname:" that will be used with the /shopedit command. ####It is reccomended to use numbers in 1.12 and lower, ####1.13+ has command-tab-complete that can assist in filling out the command, and naming your items here can be helpfull in this case. '1': #again, nothing follows the : becasue it is the defieing valuse for the parts that follow... # #options are another level below the index/item, and have an additional two spaces fro mthe above line. #This line has FOUR SPACES before it. material: GRASS_BLOCK #There must be a space immediately after the : , Then a SINGLE SPACE, followed by the defined value. #Double quotes around the value are only required for values with special characters and spaces #still at FOUR SPACES as these options are more values for item '1' buy: 20 #### setting the value to a NEGATIVE number in either buy or sell will disable that option 'item cannot be bought/sold' sell: -1 lore: #List lines start like a new sub-level, but use a - to define the start of each line in the list #in this case we are expecting lines of text, so we MUST enclose them with double-quotes "" #if you want to use double-quotes IN your line of text, you MUST 'Escape' it by printing it TWICE. (must still start and end with double-quotes) ####Minecraft chat color codes are supported - "example lore" - "&c""Second"" line of lore" enchantments: #another list-foramt is an array. mainly used for enchantments in ESGUI. #it uses the Enchantment_name immediately followed by a : and again immediately followed by the enchantment level - EFFICIENCY:5 - FORTUNE:3 [PreviousLimited Items](https://wiki.gpplugins.com/economyshopgui/basics/limited-items) [NextConfig.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) Last updated 1 year ago Was this helpful? --- # Config.yml | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#general-settings) **General Settings:** ----------------------------------------------------------------------------------------------------------------------- [Please read About YAML](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) before editing your files! It DOES NOT tolerate any errors! [Validate it!](https://jsonformatter.org/yaml-validator) ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#config-version) **Config version:** The first option you will see in the regular config of the plugin is the `config-version: `. This is the version of the config. **Do not change this unless told to do so by support staff**, if you do, you may break the plugin and have to reset or delete your shop files to default files generated by the plugin. Do not change the config version unless told to do so by support staff. changing this may cause unexpected errors and may erase your shops! Copy config-version: 2.0.0.0 # WARNING: Do not change this value as this might end up in a plugin that does not work!! ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#language-option) **Language option:** Here you can change the language file you are using. The default language file is English but if you want to use the German language file for example, set the value to `language-file: lang-de.yml` because the language file is called `lang-de.yml`. [**List of all language files and more info available on the Language page here.**](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) Copy #---------------------------------------Language-------------------------------------------------------- # Here you can change the language of the plugin. language-file: lang-en.yml # See this link for all available language files: https://app.gitbook.com/@gpplugins/s/economyshopgui/economyshopgui-configuration/regular-config.yml-configuration#language-option ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#locale-option) Locale option: **Please check your language file to set the currency symbol.** This setting only formats the commas(,)/periods(.). The locale option currently only works with formatting the prices. But that doesn't say its unhelpful. The locale option takes a [BCP-47 language tag](https://appmakers.dev/bcp-47-language-codes-list/) as input. You can find [valid BCP-47 tags here](https://appmakers.dev/bcp-47-language-codes-list/) You can [see the difference with or without a locale here.](https://imgur.com/a/vFAmL2d) Copy #----------------------------------------Locale--------------------------------------------------------- # This is the locale of the plugin. # Currently its only used to format the prices. locale: en-US # Note: This is not the locale at which messages will be translated, see the above option for that. # The locale is set in BCP 47 language tag. # See this website for some example BCP 47 language tag you can use: https://appmakers.dev/bcp-47-language-codes-list/ ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#currency-format) Currency format: This option allows to customize the format of currency. Example `**"#,##0.#####"**` will show up to five digits after the seperator, while `**"#,##0.##"**` is the default format. This can be changed per currency in the [currency format settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#currency-formats) Copy # Currency format currency-format: "#,##0.##" ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#abbreviations) Abbreviations: Use amount abbreviations(shortcuts) in display prices. For example 5,420 -> 5.4k, 7,084,651 -> 7m, ... and so on. You may use this site for inspiration: [https://crusaders-of-the-lost-idols.fandom.com/wiki/Large\_Number\_Abbreviations](https://crusaders-of-the-lost-idols.fandom.com/wiki/Large_Number_Abbreviations) This can be changed per currency in the [currency format settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#currency-formats) Copy abbreviations: enabled: true # This list is processed from top to bottom # Each entry in the list represents a shorthand notation for a certain magnitude, # with magnitudes increasing by a factor of 1000 as you move down the list formats: - 'k' - 'm' - 'b' - 't' - 'q' ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#update-checking) Update checking: This option allows you to disable update checking on startup or reload of the plugin. Sometimes when there is a sever issue with spigot or with your internet connection, this can take a while and maybe you do not have the time to wait for the plugin to make a connection to the server so you can disable this option. Copy #-----------------------------------------------Updates------------------------------------------------- # This option enables or disables the automatic checking of updates for the plugin on startup or reload of the plugin update-checking: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#debug-mode) **Debug mode:** When debug mode is set to true, error messages pertaining to invalid or miss-configured items will be printed to console _on server startup_ (check your [latest.log](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting#ts-01-logs) !) We recommend leaving it set to true to aid in troubleshooting. It prints nothing to console if there are no issues. Copy #---------------------------------------DebugMode------------------------------------------------------- # Set this value to false to disable debug mode and do not send debug messages to the console. debug: true # NOTE: The console may get spammed when debug mode is enabled. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#storage) Storage: _\*Premium only_ ------------------------------------------------------------------------------------------------------------------ All storage types are currently only used to store the data of DynamicPricing and limited stock. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sqlite) SQLite: SQLite databases are local databases, meaning they're stored inside the plugins folder like a regular plugin config, it doesn't require any configuration for it to work either. Copy # Select the storage type which should be used # Valid options are 'MySQL' and 'SQLite' storage-type: SQLite ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#mysql) MySQL: MySQL allows multiple servers to connect to one database instance. So for example when a player is allowed to only purchase 4 of a specific item using limited stock, and they buy three of these items in the survival server, they will only be able to purchase 1 more of that item in any other server inside your network. Note that we recommend using SQLite if you are not using the MySQL database to sync data between servers, this simply because it is way more performance efficient to use SQLite for both your server and load times of shop items! #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#display-cache) Display cache: Display cache allows to use database caching for MySQL when using dynamic pricing/limited stock which will save database load overtime and will greatly improve the speed of browsing shop pages, especially when using dynamic pricing with a MySQL database. The cache will only be used for item lore in shop pages, it will not be used for actual transactions to prevent data inconsistency between servers. If your server does not sync dynamic pricing/limited stock data between multiple servers, it is safe to set the display cache to any large interval like '1h' or even longer. Active server networks which do sync data between databases and with high player activity may set this to a short interval like '1m' or even disable it by setting it to '-1'. Copy # Configure this to use MySQL mysql: # The name of the database database: database # The host where this database is hosted host: localhost # The port of the database connection port: 3306 # The username username: root # The password password: password # Display cache for dynamic pricing/limited stock display-cache: 5m # Configure the pool settings if needed, if you don't know what this is then just leave it to the default settings pool: maximum-lifetime: 1800000 idle-timeout: 600000 maximum-pool-size: 10 minimum-idle: 10 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#database-cleanup) **Database cleanup:** Cleaning up the database can improve database speed(limited stock and dynamic pricing) and reduce file size(when using SQLite), this is especially useful for public servers with alot of player activity. Read [here](https://wiki.gpplugins.com/economyshopgui/basics/commands#cleaning-the-database) on how to correctly use the cleanup command and when data is considered expired The setting below will determine when to consider player data expired when cleaning the database. Example: Setting it to '3mo' will make it so players that haven't rejoined your server in the past 3 months will be considered expired. Copy database-cleanup: remove-player-data-after: "6mo" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#shopstands-module) **ShopStands module:** ------------------------------------------------------------------------------------------------------------------------- ShopStands is a module within EconomyShopGUI which allows the creation of physical shops which link to one specific ShopItem from /shop, get rid of the ugly sign shops on your server! **See more info** [**here**](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-use-shopstands) **.** Due to the smart design, ShopStands have almost to none performance impact since they are not persistent(1.13+), unlike regular entities. Copy shop-stands: false # ShopStands is a separate module of the plugin, so when disabled, # it will completely disable this feature and its listeners (ShopStands are disabled by default) [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#transactions) **Transactions:** --------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#transaction-log) **Transaction log:** Using the `**transaction-log: true**` setting you may disable/enable the plugin logging transactions to a text file, this can be usefull for identifying price exploits or just which item is the most populair in your store. Copy #---------------------------------------------Transactions---------------------------------------------- # Whether transactions should be logged to a text file transaction-log: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#transactions-database) Transactions database: The transaction database uses extensive logging of shop transactions on your server, which is useful for getting indept insights. The transactions database can be exported into a web version using command `**/eshop logs export**` , which makes it really easy to visualize the economy on your server and is a great way for finding price exploits. ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FRdpnOYdiJg2OX7gquNk6%252Fimage.png%3Falt%3Dmedia%26token%3D7642be64-7962-4691-9f0c-a3458af1ce14&width=768&dpr=4&quality=100&sign=a86471b0&sv=2) Copy # Whether the transaction history should be stored inside a database advanced-transaction-log: true Note that this option needs to be enabled in order to use [transaction placeholders](https://wiki.gpplugins.com/economyshopgui/basics/how-to#transaction-placeholders-premium-feature) . ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#banned-gamemodes) Banned gamemodes: Disallow certain gamemodes from using the shop, defaults to gamemode creative and spectator. Copy # Players will not be able to buy/sell items, nor use /sellall and /sellgui while inside any of the below gamemodes # Possible values: ADVENTURE, CREATIVE, SPECTATOR and SURVIVAL banned-gamemodes: - CREATIVE - SPECTATOR # This behavior can be overridden with the 'EconomyShopGUI.bypassgamemode' permission for specific players When a gamemode has been added to this list, it will still allow players to browse /shop but are not allowed to buy/sell items. This behavior can be overridden with the '**EconomyShopGUI.bypassgamemode**' permission for specific players. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#disabled-commands-in-worlds) **Disabled Commands in Worlds:** --------------------------------------------------------------------------------------------------------------------------------------------- It is possible to disable certain ESGUI commands in certain worlds, you will need this option for that. First you will need to enable the `enable-disabled-worlds: true` option for it to work. Once it is enabled you can list every world's name under the command that you want disabled there. In the default config generated with ESGUI there are already some examples that could be used if the option is enabled. Commands disabled in worlds via the feature above will still be available in the server (just not in the specified world(s)), and will appear in your command-tab-complete-list. This DOES NOT disable the command server-wide! meaning that a command may still conflict with another plugin that has the same command. See [Troubleshooting](https://wiki.gpplugins.com/economyshopgui/basics/troubleshooting) for more. Copy #---------------------------------------DisabledCommandsInWorlds---------------------------------------- # The setting below enables or disables the disabled commands inside certain worlds feature # When this option is true, the commands that are added to the world inside the list below will be disabled enable-disabled-worlds: false # List of commands with disabled worlds # Each command has its own list of worlds that will be disabled. # If a command is not added or the list with worlds for the specified command is empty, # the command will work in every world. disabled-worlds-per-command: shop: - 'creative' balance: - 'world' givemoney: - 'world' - 'boss_fights' sellall: - 'randompvp' editshop: - 'boss-fights' - 'Survival-Spawn' # NOTE: Commands disabled inside worlds with the feature above will still be registered inside the server, # meaning that a command still can conflict with the same command from another plugin. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#providers) **Providers:** --------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) **Economy provider:** Allows you to change the default economy/currency provider which EconomyShopGUI uses. * **VAULT** \= [Vault](https://www.spigotmc.org/resources/vault.34315/) is the default economy provider. Vault needs a economy plugin such as Essentials or CMI(Using Vault injector) to work. * **COINS\_ENGINE** = [CoinsEngine](https://www.spigotmc.org/resources/coinsengine-your-best-custom-multi-currency-economy-plugin.84121/) (Formally known as GamePoints) is a multi currency economy provider which support MySQL * **PLAYER\_POINTS** \= [PlayerPoints](https://www.spigotmc.org/resources/playerpoints.80745/) is a advanced economy provider which supports MySQL but does not support decimal prices such as other economy providers. * **GEMS\_ECONOMY** \= [GemsEconomy](https://www.spigotmc.org/resources/gemseconomy.19655/) is a economy provider which supports multiple currencies and also supports MySQL databases if you need it. This plugin has not been updated in several years and is to be used with caution, as there won't be any support should it stop working. * **VOTING\_PLUGIN** \= Points used by [VotingPlugin](https://www.spigotmc.org/resources/votingplugin.15358/) * **ULTRA\_ECONOMY** \= [UltraEconomy](https://www.spigotmc.org/resources/ultra-economy.83374/) is a modern multi currency economy provider which supports multiple currencies and a MySQL storage type. * **ZESSENTIALS** \= Alternative Essentials plugin suppoting multiple currencies * **TNE** \= [TheNewEconomy](https://www.spigotmc.org/resources/the-new-economy.7805/) is a multy currency economy provider which supports MySQL _**\*Premium only feature**_ * **ECOBITS** \= [EcoBits](https://www.spigotmc.org/resources/109967/) is a premium, modern multi currency economy provider which supports multiple currencies _**\*Premium only feature**_ * **EXP** \= Raw experience points used to enchant items * **LEVELS** \= Experience levels used within the base game _**\*Premium only feature**_ * **ITEM:** = Specific item economy, see [this page](https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-create-custom-item-economys) on how to create custom item currency's _**\*Premium only feature**_ Using the format of `**:**` you may specify the use of a different currency then the default, some examples being `**ULTRA_ECONOMY:, COINS_ENGINE:, ...**`. The plugin allows you to specify multiple economy's at the same time via [per section economy's](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#specific-currency) or [per item economy's](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#economy) . Copy #--------------------------------------------EconomyProvider-------------------------------------------- # The default economy provider used # Available values are 'VAULT', 'PLAYER_POINTS', 'GEMS_ECONOMY', 'ULTRA_ECONOMY', 'LEVELS' and 'ITEM:material:' # Additionally when using GemsEconomy or UltraEconomy you may use a different currency using 'GEMS_ECONOMY:' or 'ULTRA_ECONOMY:' # See this page on how to create custom item currency's: https://wiki.gpplugins.com/economyshopgui/basics/how-to#how-to-create-custom-item-economys economy-provider: ULTRA_ECONOMY:vip ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#currency-formats) Currency formats: A currency format exists of three parts, the currency singular/plural form which are shown as the buy/sell price lore for items and the currency's friendly name which is used to call the currency in language messages send to the player. Each individual 'part' so to call, can be configured differently from each other. See this for an example of how the config looks like for custom currency formats for the Vault currency, the Gems currency from UltraEconomy and a custom item economy with a custom id of Bullets. Copy currency-formats: ultra-economy:Gems: # Gems currency from UltraEconomy singular: "Gem" # Displayed like: 'Buy Price: 1 Gem' plural: "Gems" # Displayed like: 'Buy Price: 5 Gems' friendly: "Gems" # Displayed like: 'You do not have enough Gems' vault: # Vault economy provider singular: "%currency-symbol%" # Displayed like: 'Buy Price: $1' plural: "%currency-symbol%" # Displayed like: 'Buy Price: $5' friendly: "money" # Displayed like: 'You do not have enough money' item:Bullets: # Custom item economy using ID 'Bullets' singular: "Bullet" # Displayed like: 'Buy Price: 1 Bullet' plural: "Bullets" # Displayed like: 'Buy Price: 5 Bullets' friendly: "Bullets" # Displayed like: 'You do not have enough Bullets' coins-engine:Cash2: # Cash2 currency from coins-engine format: "#,##0.#" # Displays the currency with only 1 decimal point(overrides the default) abbreviations: enabled: true# Overrides the default setting for all currency's formats: - 'KK' - 'MM' - 'BB' ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-provider) Spawner provider: This option allows you to set the spawner provider that ESGUI uses. * **DISABLED** \= Disables the spawner provider entirely, the same as disabling the spawner break and place events seperatly. * **DEFAULT** = This is the [default spawner provider inside the plugin configured below](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings) , when this option is used, you can mine or break spawners with the settings inside the config without any external spawner provider. This option also allows you to use [MineableSpawners](https://www.spigotmc.org/resources/mineablespawners-1-8-1-16-silkspawners-alternative.59921/) but you will need to disable the [spawner break event](https://app.gitbook.com/@gpplugins/s/economyshopgui/~/drafts/-MgfT60-2BYNoSkCUZov/file-configuration/config.yml#spawner-settings-1) inside ESGUI. * **AUTO** \= Attempts to automatically detect a supported plugin. If no plugin from the list below is found, it defaults to DEFAULT mode. * **SILKSPAWNERS** = [SilkSpawners](https://www.spigotmc.org/resources/silkspawners-%E2%98%85-ready-to-rock-1-8-1-16-5-supported-%E2%98%85.7811/) is an external spawner provider that has more features to customize/configure the experience with spawners on your server. * SILKSPAWNERSV2 = [SilkSpawners](https://www.spigotmc.org/resources/silkspawners-versions-1-8-8-1-21-4.60063/) is a lightweight plugin to make spawners mineable. * **WILDSTACKER** \= [WildStacker](https://bg-software.com/wildstacker/) is an external spawner provider/stacking plugin, WildStacker allows you to upgrade spawners and make them better. * **ULTIMATESTACKER** \= [UltimateStacker](https://songoda.com/marketplace/product/ultimatestacker-the-simple-to-use-stacker.16) is an external spawner provider that can stack items, spawners and mobs. * **ROSESTACKER** \= [RoseStacker](https://www.spigotmc.org/resources/rosestacker.82729/) is an external spawner provider that can stack items, spawners and mobs. * **MINEABLESPAWNERS** \= [MineableSpawners](https://www.spigotmc.org/resources/mineablespawners-1-8-1-18-silkspawners-alternative.59921/) is an external spawner provider that has more features to customize/configure the experience with spawners on your server. * **SPAWNERMETA** \= [SpawnerMeta](https://www.spigotmc.org/resources/spawnermeta-fully-customizable-upgradable-modifiable-spawners-1-14-1-20.74188/) is an external spawner provider with advanced features, it allows to stack and upgrade spawners. * **SPAWNERLEGACY** = [SpawnerLegacy](https://www.spigotmc.org/resources/116287/) is the premium version of SpawnerMeta which has more upgrades and in general more customizeable features. * **SMARTSPAWNER** \= [SmartSpawner](https://www.spigotmc.org/resources/120743/) is a spawner provider which allows stacking of spawners and storing the drops inside the spawner's inventory * **EPICSPAWNERS** \= [EpicSpawners](https://songoda.com/marketplace/product/epicspawners-the-ultimate-spawner-plugin.13) is an external spawner provider that allows you to stack spawners and create custom spawners with tiers. _**\*Premium only feature**_ * **UPGRADEABLE\_SPAWNERS** = [UpgradeableSpawners](https://www.spigotmc.org/resources/77717/) is an external spawner provider that allows to upgrade spawners. _**\*Premium only feature**_ Copy #--------------------------------------------SpawnerProvider-------------------------------------------- # DISABLED = This will disable both spawner place and break event which disables the spawner provider # DEFAULT = The default spawner provider inside ESGUI # SILKSPAWNERS = An external spawner provider # WILDSTACKER = An external spawner provider that can stack/upgrade spawners # ULTIMATESTACKER = An external spawner provider that can stack spawners # ROSESTACKER = An external spawner provider that can stack spawners # MINEABLESPAWNERS = An external spawner provider # SPAWNERMETA = An external spawner provider that can stack/upgrade spawners # EPICSPAWNERS = An external spawner provider that can stack/upgrade spawners # UPGRADEABLE_SPAWNERS = An external spawner provider that can stack spawners spawner-provider: EPICSPAWNERS # NOTE: When there is no spawner provider set, the default will be used [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#player-transactions) **Player Transactions:** ----------------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#log-player-transactions) **Log Player transactions:** This will log player transactions to console when a player has sold/bought a item. This is really handy if you want to keep track on what you're players are buying/selling, or if you accidentally made an exploit in the shop prices, you can more easily find what players are buying or selling a lot of. Copy #---------------------------------------PlayerTransactions---------------------------------------------- # When this option is set to true, every time a player sells/buys something from the server, it will output it in the console. # This way the server owner or staff can see when a item is bought/sold many times or control/correct prices and exploits in the shop. log-player-transactions: true # Set to false to disable this. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#drop-remaining-items-on-ground) Drop remaining items on ground: When this option is disabled`drop-remaining-items-on-ground: false` the plugin will fill the player's inventory as much as it can (if applicable), and the remaining items will be cancelled. The player will only pay for, and receive the amount of items that fit inside the inventory. When set to `drop-remaining-items-on-ground: true`, the plugin will drop all items that didn't fit in the player's inventory. When this option is set to `true`, players with bad intentions can spam buy something and all the items now sitting on the ground will lag out and potentially **crash your server**. It is highly recommended to keep this set to `false`. Copy # Should we drop the remaining items on the ground when the players inventory is full? drop-remaining-items-on-ground: false # When this option is false, the plugin will only give the items that fit inside the inventory and the remaining items will be cancelled. The player will only pay for the amount of items that fit inside the inventory. # Warning: When this option is true, players could lag out your server by buying an insane amount of items that fall on the ground! ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#use-item-name) Use item name: This option sets wether to use the shop item displayname inside shop transaction messages or the material name Copy # When purchasing a item from shop, should the transaction message say which material was sold/bought from shop or should it be the item name? use-item-name: true # When this is false, purchasing/selling a item to shop will cause the message in chat use the material name of the item instead of the item name to let the player know what has been sold/bought [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#bedrock) Bedrock ------------------------------------------------------------------------------------------------ There are various options inside the plugin to make Bedrock support better. For any of the below features to work, it is required to install [Floodgate](https://geysermc.org/download) on the same server as EconomyShopGUI. When using a proxy server, you will need to [setup Floodgate on your backend server](https://wiki.geysermc.org/floodgate/setup/) to correctly comminucate with your proxy. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#resize-gui) Resize GUI Since the limitations of Bedrock clients. Any GUI size different then a half/full sized inventory would make the bedrock client fill in the left over rows with barrier items. There for, enabling this feature will resize any GUI to a full sized inventory. Copy resize-gui-for-bedrock: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#pre-register-skulls) Pre register skulls Since the limitations of Bedrock clients not being able to render textured player heads, this feature uses Geyser to create a custom resource pack for any connected bedrock player which will make it possible for Bedrock players to view textured player heads. The `add-non-bedrock-items: true` option needs to be enabled inside the config.yml of Geyser for this to work(Enabled by default) Note that this feature requires [Geyser](https://geysermc.org/download) to be installed directly on the same server as EconomyShopGUI A full server restart is required for new textured skulls added to shop for being able to register within the resource pack. Copy pre-register-skulls: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#bedrock-player-profile) Bedrock player profile Since the limitations of Bedrock clients not being able to render textured player heads, **and** the feature above not rendering the player profile of bedrock players in navigation bars, this feature adds a custom player profile when enabled. Meaning when using a navigation bar item with `skullowner: "%player_name%"`(player profile), which creates a skull with the player's texture. While Java players will still be able to visually see this item with their skin texture applied, duo to bedrock limitations, bedrock players will see the custom player profile when this feature is enabled instead. When disabled, bedrock players will see the same item as Java players but duo to limitations for Bedrock clients, they will see the regular steve head. Copy custom-bedrock-player-profile: enabled: true item: material: GOLD_INGOT name: "%player_displayname%" lore: - "%translations-money%: &c%player_balance%" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discordsrv-hook) DiscordSRV Hook ---------------------------------------------------------------------------------------------------------------- The DiscordSRV hook allows you to send shop transactions directly to a discord channel without using the API of EconomyShopGUI. Copy # The DiscordSRV hook allows you to log transaction directly to a discord text channels in your guild when someone makes a transaction enable-discordsrv-hook: true The channel configured to log shop transaction to, also needs to exist as a logging channel inside the config.yml of DiscordSRV. See [their documentation](https://docs.discordsrv.com/installation/initial-setup#set-up-a-basic-channel-relay) on how to add channels. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#available-placeholders) **Available placeholders:** * **%translations-discord-srv-transaction%** - The translated message inside the language file * **%player\_name%** - The player triggering the transaction * **%bought/sold%** - Either 'bought' or 'sold' * **%amount%** - The amount of items used in this transaction * **%items%** - The item names used in this transaction * **%price%** - The total price for all items used in this transact Copy # Configure the message sent to a channel when a transaction is made discordsrv-transactions: channel: shop-transactions raw: "" embed: color: "0x006FFF" title: "" description: "" author: title: "New shop transaction" imageURL: "%player_skull_texture%" fields: 1: title: "Player" message: "```%player_name%```" 2: title: "Mode" message: "```%bought/sold%```" 3: title: "Amount" message: "```%amount%```" 4: title: "Product(s)" message: "```%items%```" 5: title: "Price" message: "```%price%```" footer: title: "" imageURL: "" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#dynamic-pricing) Dynamic Pricing: _\*Premium fearure_ ------------------------------------------------------------------------------------------------------------------------------------- Dynamic pricing is like the name suggests a feature where the prices of items can drop or rise in value depending on demand and supply for the specific item. Take for example emeralds in your shop: If demand is high, and players start buying emeralds, the price will increase as there will be less items inside the market. On the other hand, when players start selling emeralds, the price will drop again as more items will be inside the market. This setting will enable dynamic pricing in the shop for every section/every item. Copy dynamic-pricing: enabled: false ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#save-period) Save period: The save period acts as a fallback which saves the cache to database every set period to prevent data loss caused by server crashes. Note though, this is only available when the database type is SQLite, since when using MySQL, the data is directly saved to database instead of writing to cashe! Copy save-period: 1h ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#price-scaling) Price scaling: A percent for the minimum/maximum sell price for all items depending on demand and supply. For example with a 20% sell scaling and the $250 sell price of the emerald from above, the minimum sell price for this item would be $200 when demand is high and the maximum would be $300 when more items are sold to shop. Copy sellPriceScaling: 20 A percent for the minimum/maximum buy price for all items depending on demand and supply. For example with a 30% buy scale and the $750 buy price of the emerald from above, the minimum buy price for this item would be $525 when the item gets sold alot and maximum would be $975 when demand is high for this item. Copy buyPriceScaling: 30 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#stock-settings) Stock settings: When items are bought/sold from shop, the plugin tracks this data, which is called stock. Ofcourse this stock can't be seen or won't limit purcahses, so we call it virtual stock. The maximum (virtual) stock a item can have. When a item has more (virtual) stock, the price will increase/decrease more when items are bought/sold. On the other hand, when items have less (virtual) stock, their prices will increase/decrease slower when bought/sold. Copy max-stock: 250 Default is 250 which means that the item needs to be sold/bought 125 times before the minimum price(defaultPrice - priceScaling) or maximum price(defaultPrice + priceScaling) is reached. Expensive items(items with overall high prices) in shop will reach their minimum/maximum prices quicker compared to cheaper items. This behavior makes sure dynamic pricing is random per item depending on their overall price in the shop. Tip: It is possible to change the maxStock setting per [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#dynamic-pricing) or per [item](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#dynamic-pricing) to have different effects The minimum amount of (virtual) stock a item can have Copy min-stock: 10 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#price-restoration) Price restoration: When price restoration is enabled, items using a dynamic price, will restore to their original prices overtime whenever the price went up/down. Copy price-restoration: # When enabled, shop items with a dynamic price, will automatically restore prices back to their original price(prices configured in config) in a configurable time frame enabled: true # The time frame the plugin will check for dynamic price restoration frequency: 5m # The percent at which the price will raise/drop towards the original price every configured frequency(default 5 minutes) percent: 1.0 # Whether the plugin should log in console when an item's dynamic price has fully restored to its original price logging: false [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#inventorys) Inventory's: -------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#main-menu-size) **Main menu size:** Allows to change the size of the main menu in rows, one row exists of 9 slots. Thus setting the value to 3 for example, creates a GUI of 27 slots to put shop category's in and 1 row that is reserved for the navigation bar. Copy # Possible values: 2 | 3 | 4 | 5 | 6 # Note that the navigation bar also is 1 row(unless disabled) main-menu: gui-rows: 3 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#main-menu-fill-item) Main menu fill item: The fill item will fill any blank space inside the main menu, unless disabled. Copy # The fill item for inside the main menu which will fill empty spots main-menu: fill-item: enable: true material: "RED_WOOL" name: " " lore: - '&aIgnore this' ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#click-mappings) Click mappings: It is possible to set different actions for specific click types on shop items. The configured mappings inside the config.yml are default for every shop, unless specifically specified inside the [section config](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#click-mappings) . Copy # Possible actions: BUY, SELL, SELL_ALL # Possible click types: LEFT, SHIFT_LEFT, RIGHT, NONE click-mappings: BUY: LEFT SELL: RIGHT SELL_ALL: SHIFT_RIGHT [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#item-settings) Item Settings: ------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#bought-items-lore) Bought items lore: Configured [lore](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#lore) for shop items can optionally be set to never be on bought items. If this is set to false, when a player buys the item, it will no longer have any of its configured lore. Copy #---------------------------------------ItemSettings---------------------------------------------------- # Enable/disable the lore on items given to players when a item is bought from shop bought-items-lore: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#allow-unsafe-enchants) Allow Unsafe enchants: Warning: Non-Vanilla Enchantment levels will be lost if the item is used in an anvil! Allows or disallows enchantments(on items and enchanted books) greater then the maximum level in default Minecraft. `true` will allow levels greater than vanilla, `false` will revert any over-max level enchant to it's normal maximum value (ex: Unbreaking 10 will give Unbreaking 3). Copy # Allows enchants greater than the max level in vanilla Minecraft allow-unsafe-enchants: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#allow-illigal-stacking) Allow Illigal stacking: The `allow-illegal-stacks` option prevents item stacks from having a bigger stack size then the default. An example would be a ender pearl which from default can only be stacked to 16 but setting this option to `true` allows the ender pearl to stack up to 64. On 1.20.5+ servers the items will also stack up to 64 if enabled, even if the max stack size is 16 for example. (This only happens within the transaction screens, but when the item is purchased by the player, it will respect the original stack size inside the inventory again) Copy # This option will toggle whether non-stackable/over-stacked items are allowed inside the shop # When having troubles with illegal-stack plugins and this plugin, disable this option to limit item stacking to their natural stack size to prevent future issues allow-illegal-stacks: true When having troubles with illegal-stack plugins and this plugin, disable this option to limit item stacking to their natural stack size to prevent future issues ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#allow-renamed-items) Allow renamed items: The `allow-renamed-items` option allows/disallows the selling of items that are renamed. When this is **false**, the items that are sold to the shop need to have the same name as the shop items displayed in shop. Copy # Allows items with a different name to be sold to the shop allow-renamed-items: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#allow-lore-items) Allow lore items: The `allow-lore-items` option controls whether or not the sold items to the shop need to have matching lore. When this is set to **false**, the items that are being sold to shop need to have matching lore with the shop item. Copy # Allows items with different lore to be sold to the shop allow-lore-items: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#match-meta) Match meta Matching item meta is crucial to allow different items to be sold with different names, lore, enchantments, spawnertypes, potion types, stew effects, ... and any other custom item which doesn't match the item material. Copy match-item-meta: true Disabling this isn't recommended and will only match items with the same item material. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sort-items) Sort items: It is possible to sort/change the load order of shop items so that way the highest/lowest priced item is prioritized when selling via /sellall or /sellgui Sort options: * **SHOP\_LOAD\_ORDER** \= Items will be loaded in the load order of the shop they are located in * **DESCENDING\_SELL\_PRICE** \= Sort items from HIGH sell prices to LOW sell prices * Items that match each other(duplicate) are prioritized by the highest sell price when selling them * For example when having two similar apples in shop, one sold for 20$ and one sold for 5$, players will sell the apple with the highest price when sold via /sellall or /sellgui * **ASCENDING\_SELL\_PRICE** \= Sort items from LOW sell prices to HIGH sell prices * Items that match each other(duplicate) are prioritized by the lowest sell price when selling them * For example when having two similar diamonds in shop, one sold for 999$ and one sold for 1199$, players will sell the apple with the lowest price when sold via /sellall or /sellgui Copy sort-items-by: SHOP_LOAD_ORDER ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#lore-arrangement) **Lore arrangement:** The lore arrangement option allows to arrange shop item lore completely. Display lore is seperated into 6 different(9 for premium) _parts_ so to call, each _part_ can be arranged from each other in a different order. It is possible to move/reorder the list to your likings, for example, in the default layout buy prices will always appear above the sell prices lore. To change this, simply move the '`buy-prices`' entry beneath the '`sell-prices`' entry which will display the sell prices lore above the buy prices lore for all items. **TIP:** Removing a entry from the lore arrangement list, will remove it for all items Default order of lore: 1. **Special lore** * Contains seasonal pricing lore * Contains lore for item requirements like levels, item permssions. 2. **Buy prices** * Contains lore for buy prices 3. **Item requirements** _**\*Premium feature**_ 1. Lore for item requirements 4. **Sell prices** * Contains lore for sell prices 5. **Decoration lore** * Contains additional buy/sell lore which is added to shop items with buy/sell prices 6. **Item lore** * Contains the item lore itself/the lore configured for this shop item 7. **Item stock** _**\*Premium feature**_ * Contains lore for limited item stock 8. **Sell limit** _**\*Premium feature**_ * Contains lore for limited sell items 9. **Admin lore** * Contains item index lore * Contains item editor lore Copy lore-arrangement: - 'special-lore' - 'buy-prices' - 'sell-prices' - 'decoration-lore' - 'item-lore' - 'item-stock' - 'sell-limit' - 'admin-lore' ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sold-items-ignore-nbt-tags) **Sold Items Ignore NBT Tags:** A list of data tags that will be ignored when selling items to the shop/server. Certain items get extra data tags added to them when placed or used and then cannot be sold to the shop anymore. To prevent this, you can add data tags to this list to ignore the values stored within them. * _Any other_ Component/NBT tag on the item attempting to be sold will block that item from being sold if those additional tags are not exactly replacted by an item defined in the shops configuration * ex: if you have a `diamond_pickaxe` in the shop with `efficiency:3`, and the player adds `silk_touch` to it. And there is no `diamond_pickaxe` with `efficency:3` AND `silk_touch` defined in the shop(s), it cannot be sold to the server * `RepairCost` is the tag Mojang uses in an anvil to track repair/enchant cost. * _\[Empty Shulker boxes get additional tags assigned to them when placed/used, will update this with those later\]_ Copy # The NBT Tags listed below will be ignored when a item gets sold to the shop # For example: # When a tool/armor is damaged it cannot be sold to the server by default, if you add the 'Damage' tag to the list below. A damaged item can be sold to the shop sold-items-ignored-NBTtags: - 'RepairCost' - '' # The 'RepairCost' tag is added by default since all items that get repaired by anvil/mending will get it, if we don't add it to the ignored list, a item repaired will not be able to be sold to the server ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#auto-update-components) Update components: _\*Premium_ Since Minecraft often changes the structure/edits the names of components(Previously NBT data) across Minecraft versions, this option allows the shop to detect whenever your configs have been updated from a older version of the game to a newer version which will automatically update the [components](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#components) item option of shop items, navigation bar, option items, ... Copy auto-update-components: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#max-pages) Max Pages: Specify the maximum number of pages a shop should calculate up too: (Note: there is a hardcoded max of 100 pages. anything over this is a ridiculous number of items to try to load. Copy # Set the limit for maximum pages inside a shop section, default is 50 but you can expand it to 100 if needed max-page-size: 50 # Note: 50 pages is already a limit of 2250 items(50 * 45) inside one shop section which will most likely never be used [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#seasonal-pricing) Seasonal pricing ------------------------------------------------------------------------------------------------------------------ Seasonal pricing adds support for [RealisticSeasons](https://www.spigotmc.org/resources/realisticseasons-1-16-3-1-20-1-seasons-in-your-minecraft-world-with-temperature-and-calendar.93275/) making it possible to add/remove a certain price modifier per season from the item or whole section. Copy # In combination with the plugin RealisticSeasons, you are able to add price modifiers for items per season enable-seasonal-pricing: false ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#modifiers) Modifiers Modifiers are a percent of the price which is added/removed during a specific season. It is possible to add modifiers for a specific shop item only or a complete section with the underlying shop items. Note that modifiers are always calculated from the original price, meaning that if the next season the same item/shop has a modifier, it will be calculated of the original price. Copy season-price-modifiers: Spring: # Increased amount of flowers in Spring Dyes: "-50%" # Increased amount of mobs spawn in Spring Food: "-25%" # No ice will spawn in Spring Blocks:6: "+50%" # Increased amount of Sheeps spawn in Spring Spawners:26: "-25%" # Increased amount of Cows spawn in Spring Spawners:10: "-25%" # Increased amount of Rabbits spawn in Spring Spawners:25: "-25%" # Increased amount of Chickens spawn in Spring Spawners:8: "-25%" # Players will require Leather armor to warm up Farming:15: "+30" Summer: # Most crops/plants will grow twice as fast in Summer Farming: "+35%" Fall: # Increased amount of Mooshrooms spawn Spawners:20: "-50%" # Increased amount of frogs spawn Spawners:13: "-50%" # Increased amount of Spiders spawn Spawners:31: "-40%" # Increased amount of Cave Spiders spawn Spawners:7: "-25%" # Increased amount of Red Mushrooms spawn Farming:24: "-75%" # Increased amount of Brown Mushrooms spawn Farming:7: "-75%" # Increased amount of foxes spawn Mobs:18: "+25%" Winter: # Increased amount of Ice will spawn Blocks:6: "+50%" # Increased amount of Wolves will spawn Spawners:35: "-50%" # Most crops/plants won't grow in Winter Farming: "-20%" # Players will require Leather armor to warm up Farming:15: "+45" ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#seasonal-lore) Seasonal lore Seasonal lore appears on shop items, letting the player know there is a special price for the item because of the current season. Each season has its own icon and will be displayed differently. Copy seasonal-lore: enabled: true Summer: icon: '&e&l☀' Spring: icon: '&6&l🌱' Fall: icon: '&c&l🍂' Winter: icon: '&b&l❄' ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FNscDZFLAw91KTYh7ctxj%252Fimage.png%3Falt%3Dmedia%26token%3Dfb640883-4d6a-44e5-bcdc-8d5dbe02762b&width=768&dpr=4&quality=100&sign=b282e365&sv=2) Summer season ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FcKvCwdVqrK1NYKEobjlI%252Fimage.png%3Falt%3Dmedia%26token%3Dd4281b6c-4064-4856-b6e1-fd4d63bd1a7f&width=768&dpr=4&quality=100&sign=c1b8aa57&sv=2) Fall season [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#discounts) Discounts ---------------------------------------------------------------------------------------------------- Discounts are a list of multiple shop sections with each a different set of discounts, each shop section can hold different groups with each a percentage of the amount of the discount. Players with the permission node `EconomyShopGUI.discounts.` inside your permissions system will then get the specified discount for the whole shop section. Copy # Enable or disable discounts inside the shop enable-discounts: false You will need to enable the discounts with the option above to use this feature! Copy # Here you can set all discounts active inside the shop # Every entry is a shop section that holds the permission nodes with their discounts discounts: # Section blocks Blocks: # Players with the permission node EconomyShopGUI.discounts.vip inside your permissions system will get 20% discount on every item inside this section. vip: 20 # Players with the permission node EconomyShopGUI.discounts.gold inside your permissions system will get 2.5% discount on every item inside this section. gold: 2.5 Farming: vip: 15 Redstone: diamond: 30 all: # Players with the permission 'EconomyShopGUI.discounts.lucky' will get a 1% discount on every item inside the shop lucky: 1 # If a player has for example access to 2 permission discounts inside the same shop section, the group with the highest discount will be active You can use the **'all'** placeholder to give all sections the same discounts without specifieng them seperately. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#sell-multipliers) Sell multipliers ------------------------------------------------------------------------------------------------------------------ Sell multipliers are a list of multiple shop sections with each a different set of multipliers, each shop section can hold different groups with each a percentage of the amount of the multiplier. Players with the permission node `EconomyShopGUI.sell-multipliers.` inside your permissions system will then get the specified multiplier for the whole shop section. Copy # Enable or disable sell multipliers enable-sell-multipliers: true You will need to enable the discounts with the option above to use this feature! Copy # Configure this option to use sell multipliers # Every entry is a shop section that holds the permission nodes with its multipliers sell-multipliers: all: # Players with the permission 'EconomyShopGUI.sell-multipliers.vip' will get an 20% multiplier on any item vip: 20 # Players with the permission 'EconomyShopGUI.sell-multipliers.gold' will get an 2.5% multiplier on any item gold: 2.5 # Players with the permission 'EconomyShopGUI.sell-multipliers.coal' will get an 1% multiplier on any item coal: 1 Spawners: # Players with the permission 'EconomyShopGUI.sell-multipliers.gold' will get an extra 10% multiplier in this section gold: 12.5 # If a player has for example access to 2 sell multipliers inside the same shop section, the multiplier with the highest value will be active You can use the **'all'** placeholder to give all sections the same multipliers without specifieng them seperately. [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#command-settings) **Command Settings:** ----------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#commands) **Commands:** Set a command to false to disable the command in ESGUI. For example if you the shop command to `false`, players will not be able to use `/shop` in your server. (this includes all it's sub commands: ie: `/shop
`) If set to `true`, the command will work. Note: the `/sell` command is NOT part of ESGUI. It is part of Essentials (integration TBD) Copy #-----------------------------------------------Commands------------------------------------------------ # These are the commands included in EconomyShopGUI # Set an command to true to enable it, and set an command to false to disable it. commands: sellall: true shop: true sreload: true editshop: true sellgui: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#command-aliases) Command aliases: These settings allow you to change the command name or add aliases for an command. For example this can be used to make the /shop command work when a player uses /market. Do not use a slash('/') before the alias because it will end up in a command with double slashes(//shop) Copy # Set different aliases for the main shop command, defaults to /shop if empty shop-commands: - "shop" # - "market" # Set different aliases for the sellall command, defaults to /sellall if empty sellall-commands: - "sellall" # Set different aliases for the sellgui command, defaults to /sellgui if empty sellgui-commands: - "sellgui" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#global-gui-settings) Global GUI Settings: ------------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#option-items) Option items: These settings can be changed to customize the items in the transaction screens, as many items as you like are allowed in the GUI. #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#menu-options) Menu options: * menu-size: - Sets the menu size in **rows** * fill-item: - Creates a item which automatically fills the empty slots within the GUI * See more info [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#fill-item) on all the item options you may use for fill items #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#available-item-options) **Available item options:** * material: - Specifies the item type * slot: - Specifies the slot of the item inside the GUI * stack-size: - Specifies the stack size of the item * Also specifies the buy/sell quantity when using action '**INSTA\_BUY'**/'**INSTA\_SELL'** * name: - Specifies the item name * lore: - Specifies the item lore * skull-owner: Specifies a skull owner * type: - The item type, mostly internal use * Available item types: **SELECTED\_ITEM**, **ACTION**, **CONFIRM** * skullowner: - Specifies the owner of the player head * skull-texture: - Specifies a custom skull texture _**\*Premium feature**_ * NBTData: - Specifies the NBT data for the item(1.8-1.20.4) _**\*Premium feature**_ * components: - Specifies the NBT data for the item(1.20.5+) _**\*Premium feature**_ * commands**: -** The commands executed when the player clicks the item _**\*Premium feature**_ * You may use the **%player%** placeholder * The action of the item needs to be set to **COMMAND** for this to work * CustomModelData: - Sets the CustomModelData of the item _**\*Premium feature**_ * action: - Action upon clicking items * Available actions: **REMOVE#**, **ADD#**, **CONFIRM\_TRANSACTION**, **SELL\_ALL**, **OPEN\_BUYSTACKS, CLOSE, COMMAND, INSTA\_BUY, INSTA\_SELL** #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#item-actions) Item actions: * **INSTA\_BUY/INSTA\_SELL** * Instantly completes the transaction of the set amount using option `stack-size` * **REMOVE#, ADD#** * Adds/removes the amount to the current selected amount of items. Replace # with a number between 1 to 64 * The language file only contains placeholders for the numbers 1, 16 and 32. Any other numbers will require the item name to be set manually. * **CONFIRM\_TRANSACTION** * Completes the current transaction with the selected amount * **SELL\_ALL** * Sells all of the selected item in the player's inventory * **OPEN\_BUYSTACKS** * Opens the buy stacks screen * **CLOSE** * Closes the GUI and discards the transaction * **COMMAND** _**\*Premium feature**_ * Executes the list of commands specified using the `commands` option ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FTqPwXA1uuvIOlDNNjLWq%252FScreenshot%25202023-01-09%2520204004.png%3Falt%3Dmedia%26token%3Dcbaad65f-0d5d-4314-94f6-957cc0b4cddd&width=768&dpr=4&quality=100&sign=b3761b90&sv=2) Example from configuration below Copy # Buy screen buy-screen: menu-size: 6 items: 1: material: magenta_stained_glass_pane name: '%translations-min-thirty-two%' stack-size: 32 action: REMOVE32 slot: 29 2: material: magenta_stained_glass_pane name: '%translations-min-sixteen%' stack-size: 16 action: REMOVE16 slot: 20 3: material: magenta_stained_glass_pane name: '%translations-min-one%' action: REMOVE1 slot: 21 4: material: light_blue_stained_glass_pane name: '%translations-plus-one%' action: ADD1 slot: 23 5: material: light_blue_stained_glass_pane name: '%translations-plus-sixteen%' stack-size: 16 action: ADD16 slot: 24 6: material: light_blue_stained_glass_pane name: '%translations-plus-thirty-two%' stack-size: 32 action: ADD32 slot: 33 7: material: ender_pearl name: '%translations-buy%' lore: - '%translations-transaction-screen-total-price%' action: CONFIRM_TRANSACTION slot: 13 type: CONFIRM 8: slot: 31 type: SELECTED_ITEM lore: - '§5x %amount%' 9: material: STRUCTURE_VOID name: '%translations-buy-stacks%' slot: 39 action: OPEN_BUY_STACKS 10: material: BARRIER name: '&cAbort' slot: 41 action: BACK # Fill items FillGrayTopLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 0-3,9,18 FillOrangeTopLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 10 FillGrayTopRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 6-9,17,26 FillOrangeTopRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 16 FillGrayBottemRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 51-54,44,35 FillOrangeBottemRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 43 FillGrayBottomLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 45-48,27,36 FillOrangeBottemLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 37 # Sell screen sell-screen: menu-size: 6 items: 1: material: magenta_stained_glass_pane name: '%translations-min-thirty-two%' stack-size: 32 action: REMOVE32 slot: 29 2: material: magenta_stained_glass_pane name: '%translations-min-sixteen%' stack-size: 16 action: REMOVE16 slot: 20 3: material: magenta_stained_glass_pane name: '%translations-min-one%' action: REMOVE1 slot: 21 4: material: light_blue_stained_glass_pane name: '%translations-plus-one%' action: ADD1 slot: 23 5: material: light_blue_stained_glass_pane name: '%translations-plus-sixteen%' stack-size: 16 action: ADD16 slot: 24 6: material: light_blue_stained_glass_pane name: '%translations-plus-thirty-two%' stack-size: 32 action: ADD32 slot: 33 7: material: ender_pearl name: '%translations-sell%' lore: - '%translations-transaction-screen-total-price%' action: CONFIRM_TRANSACTION slot: 13 type: CONFIRM 8: slot: 31 type: SELECTED_ITEM lore: - '§5x %amount%' 10: material: BARRIER name: '&cAbort' slot: 41 action: BACK # Fill items FillGrayTopLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 0-3,9,18 FillOrangeTopLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 10 FillGrayTopRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 6-9,17,26 FillOrangeTopRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 16 FillGrayBottemRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 51-54,44,35 FillOrangeBottemRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 43 FillGrayBottomLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 45-48,27,36 FillOrangeBottemLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 37 # Buy stacks screen buy-stacks-screen: menu-size: 6 items: 1: material: magenta_stained_glass_pane name: '%translations-min-thirty-two%' stack-size: 32 action: REMOVE32 slot: 29 2: material: magenta_stained_glass_pane name: '%translations-min-sixteen%' stack-size: 16 action: REMOVE16 slot: 20 3: material: magenta_stained_glass_pane name: '%translations-min-one%' action: REMOVE1 slot: 21 4: material: light_blue_stained_glass_pane name: '%translations-plus-one%' action: ADD1 slot: 23 5: material: light_blue_stained_glass_pane name: '%translations-plus-sixteen%' stack-size: 16 action: ADD16 slot: 24 6: material: light_blue_stained_glass_pane name: '%translations-plus-thirty-two%' stack-size: 32 action: ADD32 slot: 33 7: material: ender_pearl name: '%translations-buy%' lore: - '%translations-transaction-screen-total-price%' action: CONFIRM_TRANSACTION slot: 13 type: CONFIRM 8: slot: 31 type: SELECTED_ITEM lore: - '§5x %amount%' 10: material: BARRIER name: '&cAbort' slot: 41 action: BACK # Fill items FillGrayTopLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 0-3,9,18 FillOrangeTopLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 10 FillGrayTopRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 6-9,17,26 FillOrangeTopRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 16 FillGrayBottemRightCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 51-54,44,35 FillOrangeBottemRightCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 43 FillGrayBottomLeftCorner: material: GRAY_STAINED_GLASS_PANE name: ' ' slot: 45-48,27,36 FillOrangeBottemLeftCorner: material: ORANGE_STAINED_GLASS_PANE name: ' ' slot: 37 shopstand-buy-screen: menu-size: 1 items: 1: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 1 hideDefaultLore: true action: INSTA_BUY slot: 0 2: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 4 hideDefaultLore: true action: INSTA_BUY slot: 1 3: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 10 hideDefaultLore: true action: INSTA_BUY slot: 2 4: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 16 hideDefaultLore: true action: INSTA_BUY slot: 3 5: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 32 hideDefaultLore: true action: INSTA_BUY slot: 4 6: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 64 hideDefaultLore: true action: INSTA_BUY slot: 5 7: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 128 hideDefaultLore: true action: INSTA_BUY slot: 6 8: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 256 hideDefaultLore: true action: INSTA_BUY slot: 7 9: material: '%selected_item%' name: '%translations-shopstand-click-to-buy%' lore: - '%translations-shopstand-total-price%' stack-size: 512 hideDefaultLore: true action: INSTA_BUY slot: 8 shopstand-sell-screen: menu-size: 1 items: 1: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 1 hideDefaultLore: true action: INSTA_SELL slot: 0 2: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 4 hideDefaultLore: true action: INSTA_SELL slot: 1 3: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 10 hideDefaultLore: true action: INSTA_SELL slot: 2 4: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 16 hideDefaultLore: true action: INSTA_SELL slot: 3 5: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 32 hideDefaultLore: true action: INSTA_SELL slot: 4 6: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 64 hideDefaultLore: true action: INSTA_SELL slot: 5 7: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 128 hideDefaultLore: true action: INSTA_SELL slot: 6 8: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 256 hideDefaultLore: true action: INSTA_SELL slot: 7 9: material: '%selected_item%' name: '%translations-shopstand-click-to-sell%' lore: - '%translations-shopstand-total-price%' stack-size: 512 hideDefaultLore: true action: INSTA_SELL slot: 8 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#visual-transaction-limits) Visual transaction limits: Visual transaction limits help the player visually see when the min/max amount of the item they can purchase/sell within the transaction screens by selecting the amount using the ADD/REMOVE buttons has been reached by updating the buttons The min/max amounts are defined by either the [max/min buy/sell](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-buy) limits of the item, or the maximum stack size of the shop item Copy visual-transaction-limits: # The action to take when min/max amount is reached # Valid actions are NONE, RENAME, REMOVE # RENAME will rename the item buttons, whereas REMOVE will remove the button from the transaction screen for the time the limit is reached action: REMOVE # If disabled, the ADD/REMOVE buttons will not change (depending on the action specified above) for the initial amount of the item only, # where the initial amount is the amount which is preselected when first opening the buy/sell screens # When enabled, for example a unstackable item will not show or have renamed ADD/REMOVE buttons even if the user did not click any buttons initial-amount: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#navigation-bars) Navigation bars: These settings allow you to change the navigation bars(bottom row) of a GUI which carry the buttons like next/prev page. These can however be disabled which allows to create your own nav bar. There are 6 seperate navigation bars you can modify differently from each other. * The main GUI located in /shop * Shop screens, which apply for all shops unless overriden per shop in the [sections config](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) * The sell GUI located in /sellgui * The transaction menus (Buy/sell and buy stacks screen) * The navigation bar used for transaction screens opened by ShopStands * Shop search navigation bar used in /shop search _**\*Premium feature**_ ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252FVD3rEMP1iDDU1mhVBXin%252FSchermafbeelding%25202021-11-02%2520180005.png%3Falt%3Dmedia%26token%3De648adb2-232a-4366-8eb4-b8b544ce7781&width=768&dpr=4&quality=100&sign=27450f3e&sv=2) Example of a customized main menu navigation bar #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#general-options) General options: * enabled: - A boolean to enable/disable this navigation bar * fill-item: - Creates a item which automatically fills the empty slots within the navigation bar * See more info [here](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#fill-item) on all the item options you may use for fill items #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#available-item-options-1) **Available item options:** * material: - Specifies the item type * slot: - The slot within the navigation bar, must be a number between 1-9 * name: - Specifies the item name * lore: - Specifies the item lore * skullowner: - Specifies a skull owner * paginated: - Can be used on next/prev page buttons * enabled: Whether the paginated option is enabled (Default for prev/next page buttons) * orElse: - Configures the item to use when the main item isn't displayed * All item options are accepted, if not specified it will use the fill item * skull-texture: - Specifies a custom skull texture _**\*Premium feature**_ * NBTData: - Specifies the NBT data of the item (1.8-1.20.4) _**\*Premium feature**_ * components: - Specifies the NBT data of the item (1.20.5+) _**\*Premium feature**_ * commands: **\-** The commands executed when the player clicks the item _**\*Premium feature**_ * The action of the item needs to be set to **COMMAND** for this to work * You may use the **%player%** placeholder * CustomModelData: - Sets the CustomModelData of the item _**\*Premium feature**_ * action: - Action upon clicking items * **TOGGLE\_MODE**, **PAGE\_BACK**, **PAGE\_NEXT**, **BACK, CLOSE** * _**Premium only:**_ **COMMAND, CHANGE\_SEARCH\_MODE, CYCLE\_CURRENCY, SEARCH** Copy # The navigation bar that appears in the main menu main-menu-nav-bar: enabled: true fill-item: material: GRAY_STAINED_GLASS_PANE name: ' ' items: player_profile: material: player_head slot: 1 skullowner: '%player_name%' name: '%player_name%' back_button: material: barrier slot: 9 name: '%translations-cancel%' action: BACK # The navigation bar that appears in every shop category shops-nav-bar: enabled: true fill-item: material: GRAY_STAINED_GLASS_PANE name: ' ' items: player_profile: material: player_head slot: 1 skullowner: '%player_name%' name: '%player_name%' page_back_button: material: red_stained_glass_pane slot: 4 name: '%translations-previous-page%' action: PAGE_BACK paginated: enabled: true orElse: material: structure_void name: '&cNo previous page to go to' action: NONE current_page: material: paper slot: 5 name: '%translations-current-page%' page_next_button: material: blue_stained_glass_pane slot: 6 name: '%translations-next-page%' action: PAGE_NEXT paginated: enabled: true orElse: material: structure_void name: '&cNo next page to go to' action: NONE back_button: material: barrier slot: 9 name: '%translations-back%' action: BACK # The navigation bar that appears in the buy/sell screens and the buy stacks screen transaction-screen-nav-bar: fill-item: material: GRAY_STAINED_GLASS_PANE name: ' ' items: player_profile: material: player_head slot: 1 skullowner: '%player_name%' name: '%player_name%' back_button: material: barrier slot: 9 name: '%translations-back%' action: BACK # The navigation bar that appears in the /sellGUI screen sellgui-nav-bar: fill-item: material: GRAY_STAINED_GLASS_PANE name: ' ' items: info-item: material: NETHER_STAR slot: 5 name: "&a&lSellGUI" lore: - "&6Drop items in to sell" - "&6upon closing, everything will be sold." - "&eItems that couldn't be sold" - "&ewill be given back to you." ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#disable-back-button) Disable back button: Some server owners may want to setup their shop so player(s) must click on a NPC/shop stand to open a specific shop section, but not go back to the main shop menu. If so, it is possible to disable the back button in some cases. Copy #------------------------------------DisableBackButton-------------------------------------------------- # Disables the ability to go back to the previous shop menu disable-back: # When enabled, the back button will be disabled on direct shop command(/shop
) direct-shop-command: false # When enabled, the back button will be disabled on direct shop command executed from console(/shop
) # Useful for NPC shops which are opened using /shop
to prevent the player returning to the main menu direct-shop-command-console: false # When enabled, the back button won't be usable for any subsections located inside any shops with a disabled back button sub-sections: false [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#global-messages) **Global Messages:** --------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#player-join-message) **Player Join Message:** Do you want ESGUI to send a special join message when players join the server? Set this to `true` to enable this feature, `false` to disable. This join message can be configured with the `joinmessage:` setting. You can use [minecraft color codes](https://www.digminecraft.com/lists/color_list_pc.php) with in this message. Note: This sentence must always begin and end with a double-quote character. Copy #---------------------------------------JoinMessage----------------------------------------------------- # Here you can enable or disable the JoinMessage enable-joinmessage: false ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#level-event) **Level event:** If enabled you can set the amount of money a player will get when he reaches levels 5, 10, and 15 by changing the amount behind the option: `leveleventmoney5/10/15:` And you can set the money for reaching level 20, 25 and 30 respectively: `leveleventmoney20/25/30:` The message sent to the player is the `levelevent-message:`, you may change this message to whatever you like. [Color codes](https://www.digminecraft.com/lists/color_list_pc.php) are supported. Copy #-----------------------------------------------LevelEvent---------------------------------------------- # Here you can enable or disable the LevelEvent enable-levelevent: false # Here you can set the amount of money a player gets when he is level 5, 10, 15 leveleventmoney5/10/15: 10 # Here you can set the amount of money a player gets when he is level 20, 25, 30 leveleventmoney20/25/30: 50 [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings) Spawner **Settings**: ----------------------------------------------------------------------------------------------------------------------- **The settings below are only affective when you've set the** [**spawner provider**](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-provider) **to DEFAULT.** ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-events) **Spawner events:** #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#break-event) Break event: When `**enable-spawnerbreak: true**` is enabled, you can mine spawner-blocks with a pickaxe and the spawner with the entity will be returned to the player breaking it. Set to `false` to disable this within ESGUI. (advanced compatibility and troubleshooting) #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#place-event) Place event: If `**enable-spawnerplace:**` is set to `false`, then you will not be able to place spawners and assign the correct mob to them with ESGUI. Copy # If you set this to 'false' you can only place spawners that are bought, you won't be able to get them back with an (Silk Touch) pickaxe. enable-spawnerbreak: true # When this option is set to false, you will no longer be able to place spawners bought from the shop with the EconomyShopGUI spawner system. enable-spawnerplace: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings-1) Spawner settings: #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-exp) Spawner EXP: `**player-placed-spawners-drop-exp: false**` is disabled by default to prevent EXP duping from constantly re-placing the block. vanilla Minecraft gives some EXP when it is broken. Copy # This option will disable/enable the XP dropped when a spawner is broken. player-placed-spawners-drop-exp: false #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#change-spawner-type) Change spawner type: This option defaults to **false** This option allows you to disable players changing the spawner using spawn eggs. Copy # This option disallows players to right-click a spawner with a spawn egg to change its spawned type when disabled allow-spawner-type-change: false ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-break-tools) Spawner Break Tools: These settings allow you to change which tools are allowed to break a spawner and drop it. This allows you to set a unlimited amount of allowed tools The `enchantments` option allows you to give the tool multiple enchantments, the tool must have ATLEAST the enchantments set. Meaning that when the pickaxe, stick, ... has more/higher enchantments then set, the spawner will still be dropped. Note: These are the internal ESGUI spawner-break/place settings and **do not apply if** 3rd party plugin compatibility is enabled/working ie: SlikSpawners, UltimateStacker, ...) Copy # Set the items that are allowed to break a spawner # If a spawner gets broken with another item then listed here, the spawner will not be given to the player spawner-break-tools: 1: material: DIAMOND_PICKAXE enchantments: - "SILK_TOUCH" 2: material: IRON_PICKAXE enchantments: - "SILK_TOUCH" - "EFFICIENCY:2" # This means that the pickaxe needs ATLEAST efficiency 2 for a spawner to be mined 3: material: NETHERITE_PICKAXE enchantments: - "SILK_TOUCH" [PreviousAbout YAML (YML files)](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) [NextSections](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) Last updated 2 days ago Was this helpful? --- # API Usage | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#introduction) Introduction: ------------------------------------------------------------------------------------------- Latest version:[![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2Fjitpack.io%2Fv%2FGypopo%2FEconomyShopGUI-API.svg&width=300&dpr=4&quality=100&sign=1e06166f&sv=2)](https://jitpack.io/#Gypopo/EconomyShopGUI-API) If any issues are found, you may submit a issue on [the issue tracker on github](https://github.com/Gypopo/EconomyShopGUI-API) . The [API](https://github.com/Gypopo/EconomyShopGUI-API) has been added since version 3.9/1.12 of EconomyShopGUI, this means the server where the API is used needs to have the same or later version of EconomyShopGUI installed. As of now, the [API](https://github.com/Gypopo/EconomyShopGUI-API) is similar for the free and premium version, meaning that if the server running the API has EconomyShopGUI Premium installed that this will just work fine, the same for the free version. However, if you plan on using the [API](https://github.com/Gypopo/EconomyShopGUI-API) for servers with the free or premium version, you should add a softdepend to your plugin.yml for both versions. [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#integrating-with-the-api) Integrating with the API: ------------------------------------------------------------------------------------------------------------------- Integrating with the API is very simple. Just add the repository and dependancy to the pom.xml when using maven or the build.gradle when using gradle. And don't forget to make EconomyShopGUI load before your plugin inside the plugin.yml just like so `softdepend: [EconomyShopGUI, EconomyShopGUI-Premium]!` maven [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-maven) gradle [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-gradle) Copy jitpack.io https://jitpack.io com.github.Gypopo EconomyShopGUI-API VERSION provided Copy allprojects { repositories { ... maven { url 'https://jitpack.io' } } } dependencies { implementation 'com.github.Gypopo:EconomyShopGUI-API:VERSION' } [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#examples) Examples: ----------------------------------------------------------------------------------- When integrated with the API, calling methods is as simple as: Copy EconomyShopGUIHook.someMethod(); To see an official example on how to use the API in a working plugin, you can see our AutoSellChests project at my Github here: [https://github.com/Gypopo/AutoSellChests/blob/main/src/main/java/me/gypopo/autosellchests/scheduler/MainScheduler.java#L97](https://github.com/Gypopo/AutoSellChests/blob/main/src/main/java/me/gypopo/autosellchests/scheduler/MainScheduler.java#L97) ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#getting-item-prices-using-one-api-call) Getting item prices using one API call: Since this API method only has been added since EconomyShopGUI v6.3 and EconomyShopGUI Premium v5.6, it is required to use any version above this or support [manually checking for item prices](https://wiki.gpplugins.com/economyshopgui/api/api-usage#getting-the-price-of-a-shopitem-manually) . Buy transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-transaction) Sell transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-transaction) This method automatically checks the following and returns an empty optional if not met: * ShopItem is found inside shop (EconomyShopGUIHook#getShopItem(ItemStack) != null) * ShopItem does not have an item error (ShopItem#hasItemError()) * ShopItem is not a display item (ShopItem#isDisplayItem()) * ShopItem is buyable (EconomyShopGUIHook#isBuyAble(ShopItem)) * Amount of items is smaller then maximum buy limit (ShopItem#isMaxBuy(int)) * If there is enough stock available (EconomyShopGUIHook#getItemStock(ShopItem, UUID)) * Checks only when the player is online (OfflinePlayer#isOnline()) * Player does have permissions for EconomyShopGUI.shop.
* Player does have permissions for this specific shop item EconomyShopGUI.shop.
.item. * Player does meet the requirements of this item Copy Optional optional = EconomyShopGUIHook.getBuyPrice(owner, new ItemStack(Material.COBBLESTONE)); if (!optional.isPresent()) return -1; // The item was able to be sold, according all item limits BuyPrice price = optional.get(); This method automatically checks the following and returns an empty optional if not met: * ShopItem is found inside shop (EconomyShopGUIHook#getShopItem(ItemStack) != null) * ShopItem does not have an item error (ShopItem#hasItemError()) * ShopItem is not a display item (ShopItem#isDisplayItem()) * ShopItem is sellable (EconomyShopGUIHook#isSellAble(ShopItem)) * Amount of items is smaller then maximum sell limit (ShopItem#isMaxSell(int)) * If there is enough sell stock available (EconomyShopGUIHook#getSellLimit(ShopItem, UUID)) * Checks only when the player is online (OfflinePlayer#isOnline()) * Player does have permissions for EconomyShopGUI.shop.
* Player does have permissions for this specific shop item EconomyShopGUI.shop.
.item. * Player does meet the requirements of this item Copy Optional optional = EconomyShopGUIHook.getSellPrice(owner, new ItemStack(Material.COBBLESTONE)); if (!optional.isPresent()) return -1; // The item was able to be sold, according all item limits SellPrice price = optional.get(); The above method returns a BuyPrice or SellPrice object if a shop item meets all requirements, which we will convert into the price of the item: Before returning the price of the item, it is required to update any stock limits present on the item. **This should only be done if the item(s) are bought/sold from/to shop(not when this method is used to only check the price of the items).** Copy price.updateLimits(); // Update all item limits set on items After that, we can safely return the requested price(s): Since the premium version of the plugin supports multiple item prices per item, this method returns a Map with prices by default to ensure version compatibility. Multiple prices [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-multiple-prices) Single price [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-single-price) If your code supports multiple prices, getting the Map of prices is as easy as: Copy return price.getPrices(); If your code supports only one economy provider/one economy type like Vault currency's for example: Copy return price.getPrice(EconomyType.getFromString("VAULT")); This returns -1 if there is no Vault price configured for this shop item. ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#receiving-the-shopitem-object) Receiving the ShopItem object: Note that the player isn't a required argument, but using a player as argument automatically makes the API validate the following and return null if not met: * Wether this ShopItem is sell able (EconomyShopGUIHook#isSellAble(ShopItem)) * Whether this ShopItem has a item error (ShopItem#hasItemError()) * Whether this ShopItem is a display item (ShopItem#isDisplayItem()) * Wether the player has permissions for this item (EconomyShopGUI.shop.
) * The premium version of the API will also check for per item permissions * Whether the player meets the shop item requirements (Premium only) Copy ShopItem shopItem = EconomyShopGUIHook.getShopItem(player, item); if(shopItem == null) { return -1; // ShopItem does not exist/is not found, or the player doesn't have permissions } ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#getting-the-price-of-a-shopitem-manually) Getting the price of a ShopItem manually: The following method can be used to get the price for the player: Note that in EconomyShopGUI, items can have different economy types, and this method will always return the price of the current ShopItem's economy type. So it is important to always check for the ShopItem's economy type(ShopItem#getEcoType()) before adding it to a player's balances. Because for example, the returned amount could be experience points instead of Vault currency, and you do not want to mix them up when deposting the amount to the player's balance! It is recommended to use the [API methods](https://wiki.gpplugins.com/economyshopgui/api/api-usage#using-different-ecotypes) to deposit/withdraw the ShopItem's EcoType from the player. To completely support EconomyShopGUI's features: Shop items may have item limits, meaning that it is required to check for any limits before purchasing/selling the item thru the API because this may not be allowed by the configuration of this shop item. It is also required to update the limits after. Your code should check the following **before** purchasing items to completely support EconomyShopGUI's features: * [Max transaction limits](https://wiki.gpplugins.com/economyshopgui/api/api-usage#max-transaction-limits) * [Item stock/limits](https://wiki.gpplugins.com/economyshopgui/api/api-usage#item-stock-limits) * [Multiple prices](https://wiki.gpplugins.com/economyshopgui/api/api-usage#multiple-prices) And **after** purchasing/selling items your code should: * [Update stock/limits](https://wiki.gpplugins.com/economyshopgui/api/api-usage#updating-item-stock) Note that in EconomyShopGUI Premium, items can have multiple prices per item. And getting the item's primary price like below, will create errors. It is hardly recommended to retrieve an item's [advanced pricing](https://wiki.gpplugins.com/economyshopgui/api/api-usage#multiple-prices) when using your API for public use! This method will also calculate any discounts/sell multipliers, pricing multipliers and dynamic pricing for the player. Buy price [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-price) Sell price [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-price) Copy /** * Gets an shop item's buy price. * * @param shopItem The shopItem to get the price from * @param player Player to check for multipliers * @param item The item to get the buy price for * @return The buy price of the item */ EconomyShopGUIHook.getItemBuyPrice(shopItem, item, player, item.getAmount()); Copy /** * Gets an shop item's sell price. * * @param shopItem The shopItem to get the price from * @param player Player to check for multipliers * @param item The item to get the sell price for * @return The sell price of the item */ EconomyShopGUIHook.getItemSellPrice(shopItem, item, player, item.getAmount()); #### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#max-transaction-limits) Max transaction limits: It is recommended to check for maximum transaction limits before purchasing/selling items thru the API, so your plugin respects any limits set on the shop item. **Ignoring this might leave unexpected results when any limits are set.** These [max transaction limits](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-buy) are a maximum amount the player can purchase at once, it is not to be confused with [limited stock](https://wiki.gpplugins.com/economyshopgui/basics/limited-items) which is a premium only feature. Buy transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-transaction-1) Sell transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-transaction-1) Copy shopItem.isMaxBuy(amountToBuy); Copy shopItem.isMaxSell(amountToSell); This method returns a boolean, if this returns false, it means that the amount given as argument is larger then the maximum transaction amount, so the item should not be bought/sold and the action should be cancelled. #### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#item-stock-limits) Item stock/limits: Similar to max transaction limits, limited stock should be checked before the item can be bought/sold from the server, so your plugin respects any stock limits set on the shop item. **Ignoring this might leave unexpected results when any limits are set.** Altough this is a premium only feature, calls made to the API of the free version of EconomyShopGUI will simply return 0 to ensure version compatibility. Buy transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-transaction-2) Sell transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-transaction-2) Copy if (shopItem.getLimitedStockMode() != 0) { int stock = EconomyShopGUIHook.getItemStock(shopItem, player.getUniqueId()); if (item.getAmount() > stock) return -1; // Stock limit reached, the item may not be purchased } Copy if (shopItem.getLimitedSellMode() != 0) { int stock = EconomyShopGUIHook.getSellLimit(shopItem, player.getUniqueId()); if (item.getAmount() > stock) return -1; // Sell limit reached, the item may not be sold } #### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#multiple-prices-1) Multiple prices: ShopItems in EconomyShopGUI can have multiple prices per shop item, so it is required to also check for this before purchasing/selling any items to the server thru the API, so your plugin respects multiple prices set on the shop item. **Ignoring this might leave unexpected results when any limits are set.** Altough this is a premium only feature, calls made to the API of the free version of EconomyShopGUI will simply return false to ensure version compatibility. Buy transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-transaction-3) Sell transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-transaction-3) Copy Map buyPrices; if (EconomyShopGUIHook.hasMultipleBuyPrices(shopItem)) { Map prices= !player.isOnline() ? EconomyShopGUIHook.getMultipleBuyPrices(shopItem).getBuyPrices(null, item.getAmount()) : EconomyShopGUIHook.getMultipleBuyPrices(shopItem).getBuyPrices(null, (Player) player, item.getAmount()); buyPrices.addAll(prices); } else { double buyPrice = !player.isOnline() ? EconomyShopGUIHook.getItemBuyPrice(shopItem, item.getAmount()) : EconomyShopGUIHook.getItemBuyPrice(shopItem, (Player) player, item.getAmount()); buyPrices.put(shopItem.getEcoType(), buyPrice); } // Do something with the map of 'buyPrices' Copy Map sellPrices; if (EconomyShopGUIHook.hasMultipleSellPrices(shopItem)) { Map prices = !player.isOnline() ? EconomyShopGUIHook.getMultipleSellPrices(shopItem).getSellPrices(null, item, item.getAmount(), 0) : EconomyShopGUIHook.getMultipleSellPrices(shopItem).getSellPrices(null, (Player) player, item, item.getAmount(), 0); sellPrices.addAll(prices); } else { double sellPrice = !player.isOnline() ? EconomyShopGUIHook.getItemSellPrice(shopItem, item, item.getAmount(), 0) : EconomyShopGUIHook.getItemSellPrice(shopItem, item, (Player) player, item.getAmount(), 0); sellPrices.put(shopItem.getEcoType(), sellPrice); } // Do something with the map of 'sellPrices' Since not all plugins support a map of prices inside their `PricingProvider#getSellPrices(ItemStack)` method call, and since this is a map of different EcoType's. It would be rather easy to get only the price of the supported economy type your plugin supports/uses. For example, plugins that rely on a Vault based price, calling something like below would do the trick of only getting the configured Vault price(if any); Copy double vaultPrice = buyPrices.getOrDefault(EconomyType.getFromString("VAULT"), -1d); #### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#updating-item-stock) Updating item stock: Because shop items can have stock/limits or dynamic pricing set, it is required to also update these values after your plugin purchases/sells items from the shop: Altough this is a premium only feature, calls made to the API of the free version of EconomyShopGUI will simply do nothing to ensure version compatibility. Buy transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-buy-transaction-4) Sell transaction [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#tab-sell-transaction-4) Copy if (this.shopItem.getLimitedStockMode() != 0) EconomyShopGUIHook.buyItemStock(this.shopItem, this.player.getUniqueId(), this.amount); if (this.shopItem.isDynamicPricing()) EconomyShopGUIHook.buyItem(this.shopItem, this.amount); Copy if (this.shopItem.isRefillStock()) EconomyShopGUIHook.sellItemStock(this.shopItem, this.player.getUniqueId(), this.amount); if (this.shopItem.getLimitedSellMode() != 0) EconomyShopGUIHook.sellItemLimit(this.shopItem, this.player.getUniqueId(), this.amount); if (this.shopItem.isDynamicPricing()) EconomyShopGUIHook.sellItem(this.shopItem, this.amount); ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#using-different-ecotypes) Using different EcoType's: Since there are multiple economy types for items, and we cannot expect every plugin to integrate with all of them. The API allows to interact using any registered economy providers, this can be any of the [supported economy providers](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) . Copy EcoType type = shopItem.getEcoType(); EconomyProvider provider = EconomyShopGUIHook.getEcon(type); If you obtained the EconomyProvider object, you can do basic things like the following: * Get the player's balance * Copy Double balance = provider.getBalance(player); * Deposit amounts * Copy provider.depositBalance(player, amount); * Withdraw amounts * Copy provider.withdrawBalance(player, amount); [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#events) Events: ------------------------------------------------------------------------------- The API contains two events as of now which can be used to track shop transactions. ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#pretransactionevent) PreTransactionEvent: The [PreTransactionEvent](https://github.com/Gypopo/EconomyShopGUI-API/blob/main/src/main/java/me/gypopo/economyshopgui/api/events/PreTransactionEvent.java) is called **before** any shop transaction. This allows you to cancel the event(transaction) or to modify the cost of the transaction by adding certain multipliers for example. ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#posttransactionevent) PostTransactionEvent: The [PostTransactionEvent](https://github.com/Gypopo/EconomyShopGUI-API/blob/main/src/main/java/me/gypopo/economyshopgui/api/events/PostTransactionEvent.java) is called **after** any shop transaction. This allows any plugin to listern and verify that a shop transaction has come thru and check the result of the transaction. For example this event is usefull on the DiscordSRV alerts.yml. Both events contain information about what ShopItem(s) have been bought/sold, how much items in total, the total cost of the transaction, the TransactionType and the player triggering the event. ### [](https://wiki.gpplugins.com/economyshopgui/api/api-usage#shopitemsloadevent) ShopItemsLoadEvent: If your plugin requires to interact on server start with a ShopItem object, you should listern and wait for the [ShopItemsLoadEvent](https://wiki.gpplugins.com/economyshopgui/api/api-usage#shopitemsloadevent) since this event will be called when the ShopItem's become available and are pre-loaded. [PreviousLanguages](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages) Last updated 7 months ago Was this helpful? --- # Languages | EconomyShopGUI wiki [](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#how-to-change-the-language) How to change the language: -------------------------------------------------------------------------------------------------------------------------------------- * Change the file setting in the [config.yml here](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#language-option) to your preferred language if it is in the languages folder. * You can also change the [currency format \[BCP-47\] here](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#locale-option) ! * You can change all messages/shop-titles/etc as you please! * You can translate the messages to your language (or [improve translations](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#how-to-contribute-new-or-improve-existing-translations) ) to your language if not listed here. You can also [share your translations on crowd-in (instructions below)](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#how-to-contribute-new-or-improve-existing-translations) and we will add them to the plugin for new users! * You can add `\n` in your message to add a new-line/return. * All messages can contain color codes such as the [regular format](https://www.digminecraft.com/lists/color_list_pc.php) using `**&5**` or the [RGB format](https://colorspire.com/rgb-color-wheel/) using`**#9000FF**` to make it a purple color. * All messages can contain automatic gradient formatting aswell using the format of `**{message}**`. Example: `_&lPrevious Page_` Use [this](https://www.colorspire.com/rgb-color-wheel/) site to get hex colors. * [MiniMessage](https://docs.advntr.dev/minimessage/format) is supported inside all messages Since version 3.1 of EconomyShopGUI, the language files will automatically add any non existing messages to your language file. ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#currently-supported-languages) Currently supported languages: List of currently supported languages and filenames **Language:** **Filename:** Czech lang-cz.yml German lang.de.yml English (US) lang-en.yml Spanish lang-es.yml French lang-fr.yml Hungarian lang-hu.yml Italian lang-it.yml Japanese lang-jp.yml Korean lang-ko.yml Dutch lang-nl.yml Polish lang-pl.yml Portuguese lang-pt.yml Russian lang-ru.yml Slovak lang-sk.yml Turkish lang-tr.yml Ukrainian lang-uk.yml Vietnamese lang-vi.yml Chinese Simplified lang-zh\_cn.yml Chinese Traditional lang-zh\_tz.yml [](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#how-to-contribute-new-or-improve-existing-translations) How to contribute new or improve existing translations: ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The language files of EconomyShopGUI are open source and you can edit them in [our crowdin](https://crowdin.com/project/economyshopgui) . Contribute by first making a crowdin account, click the language you want to translate, select the source file, and start translating, its that easy! ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#some-guidelines-to-keep-in-mind-when-translating) Some guidelines to keep in mind when translating: * Translated messages should have the same color codes as the source string * Example: If the source message contains `**&8&l**`(Bold gray, mostly used for inventory titles) or `**&a**`(Green, mostly used in messages sent to players) as color codes, the translation should also follow these colors * Should contain the same message structure, these messages are included in the default language files and not made personally for your own server * Example: The plain message of `**Sell price: %amount%**` should not be translated to something like `**Prices: \n ➤ Sell price: %amount%**` * Commands should not be translated, only command arguments between **<>** or **\[\]** * Example: "/eshop additem **
** **** **** **\[displayname\]****"** * Where only the green parts of the command can be translated * Placeholders between **%** characters should not be translated If you are a translator on our crowdin, make sure to join [our discord server](https://discord.com/invite/nPyuB4F) and ask for the translator role so you get updates when new translations become available to translate and get access to the translators channel! ![](https://wiki.gpplugins.com/economyshopgui/~gitbook/image?url=https%3A%2F%2F4049796578-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M6QXvrDDroId1RhlXgl%252Fuploads%252Fqaa9c32OtRUMFbz11Fih%252Fimage.png%3Falt%3Dmedia%26token%3Deda84d72-15d5-4c08-a0d0-2dcbb9a81a12&width=768&dpr=4&quality=100&sign=9d1f5b12&sv=2) Current translations on Crowdin [](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#language-file-example) English Language File Example: (`lang-en.yml`) ---------------------------------------------------------------------------------------------------------------------------------------------------- * settings should be self-explanatory: Copy # Help translate this file over on our Crowdin: https://crowdin.com/project/economyshopgui #StartUp/Reload creating-latest-shops: "Creating default shops for the latest version because there was no existing layout found matching server version %version%, please use a supported server version." default-shops-created: "Default shops layout compatible with %version% created at %path%" loaded-shop-configurations: "Completed loading %total% shop configs from /shops/" default-sections-created: "Default sections layout created at %path%" loaded-section-configurations: "Completed loading %total% section configs from /sections/" updating-shop-settings: "Updating Shop settings..." creating-new-shop-config: "Creating a new shops config for '%section%' because no shops config was found while there is a sections config. Not removed correctly?" creating-new-section-config: "Creating a new sections config for '%section%' because no sections config was found while there is a shops config. Not removed correctly?" disabled-due-no-vault: "Disabled due to no Vault dependency found, please install Vault." disabled-due-no-economy: "Disabled due to no economy plugin was found, please install a plugin such as EssentialsX." update-available: "There is an update available for EconomyShopGUI, you are running v%plugin_version% but found v%latest_version%." done: "Initialized - Took %millis%ms to complete" updating-sections-config: "Updating sections config..." debug-mode-enabled: "Debug mode is enabled." economy-provider-null: "EconomyProvider is null." successfully-hooked-into-vault: "Successfully hooked up into Vault." language-file-using: "Using %languagefile% as language file." cannot-find-language-file: "Can not find language file!" minecraft-version-using: "Using minecraft version %version%..." checking-each-item: "Checking each item for wrong/missing value's..." loading-items: "Loading all items..." could-not-find-valid-version: "Could not find a valid implementation for this server version. This will cause the plugin to not have a version to use and result in lots of items/methods not working. Please use a supported minecraft version." updating-configs: "Updating the configurations because a newer version has been found..." creating-backup: "Creating a backup from the old %fileName%, the file can be found in the backups folder inside the EconomyShopGUI plugin's folder." discounts-feature-unavailable: "Discounts feature cannot be enabled because no permissions plugin was found." cannot-hook-permissions: "Failed to find a supported permissions plugin" enabled-plugin-hook: "Enabled %plugin% hook..." failed-plugin-integration: "Failed to hook into %plugin%, plugin is disabled or not found..." loading-season-modifiers: "Loading season modifiers from config..." loaded-season-modifiers: "Completed loading %total% modifier(s) for season '%season%' in world '%world%'" no-season-modifiers-found: "No season modifiers found for season %season% in config" season-change: "Detected season change in world '%world%', loading modifiers for season %season%..." economy-providers-loaded: "Completed loading %total% economy provider(s) for all %shops% shop sections." section-economy-provider-loaded: "Using '%economy%' as default economy for shop '%shop%'" #Shop prefix shop-prefix: "&9&lShop &8&l>> " #Main Shop Inventory inventory-main-shop-title: "&8&lServer Shop" profile: "&aProfile" name: "&6Name" money: "&6Balance" level: "&6Level" # SellGUI inventory inventory-sellgui-title: "&8&lSellGUI" #Buystacks Inventory title inventory-buystacks-title: "&8Buying stacks &a&l> &r&8%item%" # Transaction screen inventory-howmuchsell-title: "&8Selling &c&l> &r&8%item%" inventory-howmuchbuy-title: "&8Buying &a&l> &r&8%item%" plus-one: "&b+1" min-one: "&5-1" plus-sixteen: "&b+16" min-sixteen: "&5-16" plus-thirty-two: "&b+32" min-thirty-two: "&5-32" sell: "&aClick to sell" sell-all: "&cClick to sell all" buy: "&aClick to purchase" buy-stacks: "&cClick to buy stacks" transaction-screen-total-price: "&3%price%" transaction-screen-total-amount: "&5x %amount%" max-amount-reached: "&cMax amount reached" #All Inventory's back: "&4Back" cancel: "&4Cancel" #Previous/Next/Current page previous-page: "&dPrevious Page" next-page: "&bNext Page" current-page: "&7Page:" # ShopItem lore left-click-buy: "\n &a&lBuy Price\n &a■ &f%buyPrice%" seasonal-buy-price: "\n &a&lBuy Price\n &a■ &f&m%buyPrice%&r &f%seasonalBuyPrice%" discounted-buy-price: "\n &a&lBuy Price\n &a■ &f&m%buyPrice%&r &f%discountedPrice%" right-click-sell: "\n &c&lSell Price\n &c■ &f%sellPrice%" seasonal-sell-price: "\n &c&lSell Price\n &c■ &f&m%sellPrice%&r &f%seasonalSellPrice%" multiplied-sell-price: "\n &c&lSell Price\n &c■ &f&m%sellPrice%&r &f%multipliedPrice%" shift-right-click-sell-all: "&bShift + Right Click: Sell All" item-location-in-shop: "&8Section: %shopsection%, Index: %itemLoc%" item-cannot-be-bought: "\n &a&lBuy Price\n &a■ &fCannot be bought" item-cannot-be-sold: "\n &c&lSell Price\n &c■ &fCannot be sold" item-seasonal-price: "&e&lSeasonal price %season-icon%" decoration-lore: "\n &e&lUsage:" decoration-lore-buy: "&e ╚&e&l» &fLeft click to buy" decoration-lore-sell-all: "&e ╚&e&l» &fShift + Right Click to sell all" decoration-lore-sell: "&e ╚&e&l» &fRight click to sell" #Buy/Sell Messages discord-srv-player-transaction: "%player_name% %bought/sold% %amount% x %items% for %price%" pay-confirmation: "&aYou have successfully bought &1%amount% x &b%material% &afor &c%amounttopay%" sell-confirmation: "&aYou have successfully sold &1%amount% x &b%material% &afor &c%amounttopay%" sell-confirmation-multiple-items: "&aYou have successfully sold &1%amount% &aitems for &c%amounttopay%" no-item-to-be-sold: "&cYou do not have any of this item inside your inventory." cannot-purchase-item: "&cThis item cannot be purchased." cannot-sell-item: "&cThis item cannot be sold." player-made-transaction: "%playername% %bought/sold% %amount% x %material% for %amountofmoney% with the %buy/sell-method%." player-made-transaction-multiple-items: "%playername% %bought/sold% %items% for %amountofmoney% with the %buy/sell-method%." buy-screen: "buy screen" sell-screen: "sell screen" buystacks-screen: "buy stacks screen" sellall-screen: "sell all screen" sellall-command: "sell all command" sellgui-screen: "sell gui" quick-buy: "quick buy screen" quick-sell: "quick sell screen" auto-sell-chest: "SellChest" bought: "bought" sold: "sold" on-screen-title-sold: "&a+%price%" on-screen-title-bought: "&c-%price%" #CurrencySymbol currencysymbol: "$%price%" symbol-pricing-format: "%symbol%%price%" named-pricing-format: "%price% &l%currency-format%" # XP Currency name format xp-currency-name-singular: "XP point" xp-currency-name-plural: "XP points" #All commands command-disabled-in-world: "&cThis command is disabled inside this world." #Edit-shop subcommand descriptions editshop-add-item-subcommand-desc: "&aAdd a item to the shop." editshop-edit-item-subcommand-desc: "&aEdit an existing item in the shop." editshop-remove-item-subcommand-desc: "&aDelete a item from the shop." editshop-import-subcommand-desc: "&aImports files/settings from another location or plugin." editshop-add-hand-item-subcommand-desc: "&aAdd a item from you hand to the shop." editshop-add-section-subcommand-desc: "&aAdd a shop section to the shop." editshop-edit-section-subcommand-desc: "&aEdit an existing shop section." editshop-remove-section-subcommand-desc: "&aRemoves an existing shop section from the shop." editshop-migrate-subcommand-desc: "&aAllows to migrate data from another location or plugin." #Edit-shop subcommand syntaxes editshop-add-item-subcommand-syntax: "&a/editshop additem
[displayname]" editshop-edit-item-subcommand-syntax: "&a/editshop edititem
" editshop-remove-item-subcommand-syntax: "&a/editshop deleteitem
" editshop-import-subcommand-syntax: "&a/editshop import " editshop-add-hand-item-subcommand-syntax: "&a/editshop addhanditem
" editshop-add-section-subcommand-syntax: "&a/editshop addsection
" editshop-edit-section-subcommand-syntax: "&a/editshop editsection
" editshop-remove-section-subcommand-syntax: "&a/editshop deletesection
" editshop-migrate-subcommand-syntax: "&a/editshop migrate [flags]" #Edit-shop command messages editshop-adding-item: "&aAdding new item to shop %shop%..." editshop-add-item-successful: "&aSuccessfully added the item to shop %shop% under %itemPath%." editshop-adding-section: "&aAdding new section config for shop %section%..." editshop-add-section-successful: "&aNew section config created at %path%." editshop-editing-item: "&aUpdating the item..." editshop-edit-item-successful: "&aSuccessfully updated '%itemPath%'." editshop-editing-section: "&aUpdating section..." editshop-removing-item: "&aRemoving the item from the shop..." editshop-remove-item-successful: "&aSuccessfully removed '%itemPath%' from the shop." editshop-removing-section: "&aRemoving the section from the shop..." editshop-removed-section: "&a&aSuccessfully removed '%itemPath%' from shop." editshop-reload-shop-to-see-changes: "&aUse command /sreload to load the changes inside the shop." file-replaced: "&aThe old %fileName% has been replaced with the new file, the old file can be found inside the backups folder if you messed up something." #Edit-shop command errors section-does-not-contain-item: "&cSection '%shopsection%' does not contain the item '%itemLoc%'." no-valid-action: "&cNot a valid action '%action%'. \nAvailable actions: %actions%." no-valid-key: "&cNot a valid key '%key%'. \nAvailable keys: %keys%." action-not-valid-on-key: "&cCannot %action% the '%key%' key." edit-item-material-invalid: "&cThe material from the item you are trying to edit is invalid. '%material%'" key-already-defined: "&cThe '%key%' key is already defined on the item, you cannot add this twice." key-is-not-found: "&cThe '%key%' key cannot be removed from the item because it is not found." plugin-not-found: "&cCannot find a plugin specified with that name, please check if we do support this plugin." file-not-found: "&cCannot find a file with name %fileName% inside the plugin folder of %pluginName%." no-valid-slot-for-item: "&cThe item could not be placed at slot '%slot%'. The slot needs to be 1 - %maxShopSize%." slot-already-in-use: "&cThe slot for this section is already taken.\nAll available slots: %available-slots%" slot-needs-to-be-number: "&cThe slot of the item in the main menu needs to be a number." #Reload Command configs-reloaded: "&aAll configs reloaded." # Sellall command usages sellall-command-usages: "&aCommand usage(s):" sellall-inventory-command-usage: "&7/sellall inventory &f- &7Sells all items in your inventory" sellall-hand-command-usage: "&7/sellall hand &8[amount] &f- &7Sells all items in your hand" sellall-item-command-usage: "&7/sellall &8[amount] &f- &7Sells all items in your inventory matching the given item name" # ShopGive command shop-item-given: "&aYou were given &c%amount% &ax &6%material%" shop-item-received: "&aYou received &c%amount% &ax shop item from section &6%section% &aand item index &6%itemIndex%" #Balance Command check-balance: "&bYou currently have &c%amountofmoney%&b." check-balance-other-player: "&b%playername% &acurrently has &c%amountofmoney%&a." #Givemoney Command givemoneycommand-example: "&9/givemoney " givemoney-complete: "&aGivemoney complete." #Pay Command minimum-amount: "&cThe minimum amount to pay a player is %minimumamount%." payment-complete: "&aPayment complete." player-received-money: "&aYou received &c%amounttogive% &afrom &2%playername%&a!" need-player-and-amount: "&9You need to give a player and a amount of money." need-amount: "&9You need to give a amount of money." paycommand-example: "&9/pay " #Player breaks spawner default-spawner-name: "&9&l%spawner-type% &rSpawner" spawner-broke-and-applied-to-inventory: "&aYou successfully mined a &9%spawner-type%&a, the item is applied to your inventory." need-silk-touch: "&cYou need to use a silk touch pickaxe to mine this!" #JoinMessage join-message: "&2Welcome, your balance is &c%balance%!" #Level event level-event-message: "&2[Levels] &5Here you go, &c%amount% &5has been added to your balance!" #Item error's displayname-null: "Could not get displayname." item-name-null: "Could not get the name of the item." need-item-material: "Can not create item with a blank material value." item-material-null: "Failed to load item material like '%material%', possibly it doesn't exist or is spelled wrong." item-enchantment-null: "Could not get the enchantment of the item." need-item-enchantment: "Can not create enchantment with a blank value." item-enchantment-not-supported: "This enchantment is not supported in this minecraft version." enchantment-cannot-apply-to-item: "To apply an enchantment to the item, the material needs to be enchanted book or a tool that fits the enchantment." item-spawnertype-null: "Could not get the spawner type of the item." need-item-spawnertype: "Can not create spawner with a empty spawner-type." material-needs-to-be-spawner: "To apply a Spawner-Type(Entity-Type) to the item, the material of the item needs to be a spawner." item-potiontype-null: "Could not get the potion type of the item." need-item-potiontype: "Can not create a potiontype with a blank value." potiontype-not-supported: "This potion type is not supported in this minecraft version." material-needs-to-be-potion: "To apply an potion effect, the material needs to be a kind of a potion or a tipped arrow." cant-bind-multiple-applyments: "Can not create an item with multiple applyments like enchantments/spawner-types or potion effect types." item-error: "&cItem Error, look in the console." material-not-supported: "This item material is not supported in this minecraft version." item-needs-buy-and-sell-value: "Every item in the shop needs to have a buy/sell value." sell-value-wrong: "The sell value needs to be a decimal or a number." buy-value-wrong: "The buy value needs to be a decimal or a number." option-type-changed: "Please change option 'type' to option 'spawnertype' to create a spawner in the shop. The name of the option has changed in version 2.2 for clarity." option-meta-changed: "Please change option 'meta' to option 'displayname' to create a item with a displayname in the shop. The name of the option has changed in version 2.2 for clarity." cannot-display-shopsection: "Cannot create shop section '%shopsection%' because the slot of the item needs to be in a range from 0 - %maxInvSize%." need-recipe-material: "Cannot create the recipe material with a blank value." cannot-get-recipe-material: "Cannot create the recipe material, please check the material name for any spelling mistakes and if it exists." recipe-material-not-supported: "The given recipe material is not supported in this minecraft version." material-needs-to-be-book: "To apply an recipe to the item, the material of the item needs to be a KnowLedge book." need-skullowner: "Cannot create the PlayerHead without a specified player (Skull Owner)." material-needs-to-be-skull: "To apply an skull texture (Skull Owner) to the item, the material of the item needs to be a Player Head." material-needs-to-be-leather-armor: "To apply an color to a armor piece, the material needs to be leather armor." #Item path items-path-in-shops-config: "Item path in shops.yml: %location%" items-path-in-sections-config: "Item path in sections.yml: %location%" items-path-in-config: "Item path in config.yml: %location%" #Compatibility mineablespawners-compatibility-enabled: "Spawner provider set to MineableSpawners in config" mineablespawners-found: "MineableSpawners found, integrating..." mineablespawners-not-found: "MineableSpawners was not found" could-not-intergrate-with-mineablespawners: "Could not integrate with MineableSpawners" using-mineablespawners-spawners: "Using MineableSpawners as spawner provider..." rosestacker-compatibility-enabled: "Spawner provider set to RoseStacker in config" rosestacker-not-found: "RoseStacker was not found" could-not-integrate-with-rosestacker: "Could not integrate with RoseStacker" rosestacker-found: "RoseStacker found, integrating..." using-rosestacker-spawners: "Using RoseStacker as spawner provider..." ultimatestacker-compatibility-enabled: "Spawner provider set to UltimateStacker in config" ultimatestacker-not-found: "UltimateStacker was not found" could-not-integrate-with-ultimatestacker: "Could not integrate with UltimateStacker" ultimatestacker-found: "UltimateStacker found, integrating..." using-ultimatestacker-spawners: "Using UltimateStacker as spawner provider..." wildstacker-compatibility-enabled: "Spawner provider set to WildStacker in config" wildstacker-not-found: "WildStacker was not found" wildstacker-found: "WildStacker found, integrating..." could-not-integrate-with-wildstacker: "Could not integrate with WildStacker" using-wildstacker-spawners: "Using WildStacker as spawner provider." spawner-compatibility-enabled: "Spawner provider set to %provider% in config" spawner-provider-not-found: "%provider% was not found" spawner-provider-found: "%provider% found, integrating..." failed-spawner-provider-integration: "Could not integrate with %provider%" using-external-spawners: "Using %provider% as spawner provider." silkspawners-compatibility-enabled: "SilkSpawners compatibility has been enabled in config." silkspawners-not-found: "SilkSpawners was not found" silkspawners-found: "SilkSpawners found, integrating..." could-not-integrate-with-silkspawners: "Could not integrate with SilkSpawners." using-silkspawners-spawners: "Using SilkSpawners spawners..." using-default-spawners: "Using plugin default spawners..." #Error's cannot-find-discounted-section: "Cannot add discounts for section '%section%', either the shop section is disabled or not found." cannot-find-discounted-group: "Cannot add discounts for permission group '%permsGroup%', please check the spelling and if it exists in your permissions plugin." disabling-plugin: "Disabling the plugin..." not-spawn-able: "This entity type is not spawn able. '%spawnertype%'" real-player: "You need to be a real player to use that command." player-not-online: "&cThat player does not exist or is not online." cannot-sell-air: "&cYou cannot sell air..." no-permissions: "&cYou do not have permissions for that." no-permissions-to-open-shop: "&cYou do not have the required permission to open this shop section." cannot-do-that: "&4You can not do that!!" more-space-needed: "&cPlease make more space inside your inventory and then try again." could-not-store-all-items: "&c%amount% item(s) couldn't be added to your inventory because it is full." not-enough-space-inside-inventory: "&4You do not have enough space in your inventory, dropping the remaining items on ground." insufficient-money: "&cYou do not have enough %currency%." canceling-transaction-no-space: "&4You do not have enough space in your inventory, canceling transaction. \nPlease make more room inside your inventory and try again." no-items-in-section: "Can not open shop section %shopsection% because there are no items found!" no-item-found: "&cNo items found which can be sold." item-null: "&cThe item does not exist." item-cannot-be-sold-to-server: "&cThe item (%material%) cannot be sold to the server because the item has a error inside the shop. Please report this issue to server admins or the owner." could-not-save-config: "Could not save %fileName% config." rgb-color-formatted-wrong: "RGB colors must be formatted as: '0x000000', '#000000' or '000000' at %path%." no-shop-found: "&cCan not find a shop section called by that name" no-valid-amount: "&cNot a valid amount" restart-plugin: "Can not open the shop section, try restarting the plugin or join the discord server for support." could-not-check-for-updates: "&cCould not check for updates." cannot-update-config: "&cCannot update the config.yml configuration file." cannot-read-config: "Cannot read %fileName% config because it is mis-configured, use a online Yaml parser with the error underneath here to find out the cause of the problem and to solve it. If you cannot find the cause yourself, join our discord support server that can be found at a plugin page of EconomyShopGUI." error-occured-while-reloading: "&4A error has occurred while reloading the plugin, please look inside the console for any error message." could-not-get-the-limitedstock-mode: "Could not get the limitedstock mode: %limitedStockMode%" error-occurred-while-connecting-to-database: "A error occurred while trying to connect to the database" invalid-item-type: "&cInvalid item type for %type%" cannot-enter-shop-banned-gamemode: "&cYou cannot buy/sell items while being in %gamemode%." cannot-use-command-banned-gamemode: "&cYou cannot use this command while being in %gamemode%." cannot-load-season-modifier: "Failed to load season modifier for '%path%' because there was no loaded section/item found." invalid-season-modifier: "Invalid modifier found at '%path%', it needs to be a valid percent between -100 and 100 like '-75%', '+25%', ... Got %current%" cannot-load-economy-provider: "Failed to load economy provider for shop '%shop%' with reason '%reason%', using default..." cannot-find-economy-provider: "Could not find a economy provider for shop '%shop%' such as '%type%', using default..." cannot-find-default-economy-provider: "Could not find the economy type specified inside the config.yml such as '%economy%', trying to automatically find supported economy type..." cannot-load-default-economy-provider: "Failed to load default economy provider with reason '%reason%', trying to automatically find supported economy provider" [PreviousShops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) [NextAPI Usage](https://wiki.gpplugins.com/economyshopgui/api/api-usage) Last updated 4 months ago Was this helpful? --- # Sections | EconomyShopGUI wiki The file name defines the shop internal name and needs to match the filename for the [shop](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) config inside the shops folder [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#general-information-about-section-configurations) General information about section configurations. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Since version v6 or Premium v5 of the plugin, sections are stored in their seperate config, instead of using a single sections.yml config to store all of them. These configs store all the custom data used to create shop sections, and are shown in the Main Menu when you open the `**/shop**` GUI. It allows to configure the display item, shop title, slot in the main menu, navigation bar, economy type, the fill item and general settings on how the section behaves inside the shop. [Please read About YAML](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) before editing your files! It DOES NOT tolerate any errors! [Validate it!](https://jsonformatter.org/yaml-validator) Basic section example[](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#basic-section-example) Copy enable: true slot: 4 title: " &8>>--- &a&lFarming &r&8---<< " sub-section: false hidden: false economy: VAULT fill-item: material: "GRAY_STAINED_GLASS_PANE" nav-bar: mode: DISABLED item: material: WHEAT name: '&aClick to enter the farming shop' lore: - "0x00CB14Gather your farming supplies here!" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#all-options-you-can-use-and-their-meanings) All options you can use and their meanings. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-options-list) **Item options list:** * [**item:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-configuration) \[Required\] - Config section to configure the display item * [**slot:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-slot) _\[Required\]_ \- is the slot of the item in the main shop. (must be a number from 0 - 44 for the first page. Additional pages not supported yet. Cannot be the same slot as another section item) * [**enable:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#enabled) - Disabled or enables the shop within the plugin * [**title:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#title) \- The shop title when inside the shop. Do not confuse with the item displayname. * [**hidden:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#hidden-shop) [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#hidden-shop) _\-_ Whether or not this shop category can be seen and accessed via the main menu * [**sub-section**:](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#sub-shops) - Whether this section is considered as a sub section * [**display-item:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#display-items) \- Makes the item a displayitem. * [**economy:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#specific-currency) - Specifies the default economy used for this section * [**fill-item:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#fill-item) \- Allows to specify a fill item for this section * [**click-mappings:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#click-mappings) \- Allows to set per shop click mappings * [**dynamic-pricing:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#dynamic-pricing) \- Per section dynamic pricing settings _**\*Premium feature**_ * [**click-commands:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#click-commands) - A list of commands which run when a player enters/clicks the shop section _**\*Premium feature**_ * [**rotating-shop-settings:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#rotating-shops) \- Section to change settings for this rotating shop _**\*Premium feature**_ ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-configuration) Item configuration: * **material:** _\[Required\]_ - The type(material) of the item * **name:** - The displayname of the item * Will also be the title of the shop if no name has been specified. * Supports [chat colors](https://www.digminecraft.com/lists/color_list_pc.php) or custom [RGB values](https://colorspire.com/rgb-color-wheel/) * **lore:** - A list of messages displayed on the item * Supports [chat colors](https://www.digminecraft.com/lists/color_list_pc.php) or custom [RGB values](https://colorspire.com/rgb-color-wheel/) * **enchantments:** - The enchantments of the display item * **potiontypes**: - The potion types of the display item * **armor-trim**: - The armor trim of the display item * **enchantment-glint:** - Whether the display item has a enchantment glint effect on it * **skullowner:** - The skull owner of the item * Should be a valid player name * **armorcolor:** - A custom RGB color for leather armor * **stack-size:** - The stack size of the item * **skull-texture**: _**\*Premium feature**_ - The custom skull texture of the player head * Look on [this site](https://minecraft-heads.com/custom-heads) for examples * **NBTData:** _**\*Premium feature**_ - Sets the NBT data of the item on 1.8-1.20.4 * **components:** _**\*Premium feature**_ \- Sets the NBT data of the item on 1.20.5+ * **CustomModelData:** _**\*Premium feature**_ \- Sets the CustomModelData of the item Copy # Options to configure the section item inside the main shop GUI item: # The material of the item material: "BEACON" # The name of the item # If no shop title has been set, this will be used as a fallback name: "&cClick to enter the Example_Shop" # The lore of the item lore: - "&aThis section contains" - "&aa ton of different cool items." # Item enchantments enchantments: - "KNOCKBACK:10" - "SHARPNESS:10" - "MENDING" - "excellentenchants:BLAST_MINING:3" # Whether this item should have an enchantment glow affect enchantment-glint: true # The skull owner for this item skullowner: "Notch" # The skull texture of the item skull-texture: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjUzMGQ5YjAwZDA3NjEyNWRmOWE1YjE3ZjQzN jcwOTg0NDQyY2U1NzM5ZGViZGJkM2M1MzA0MDkyNjA1MmNhNiJ9fX0=" # Custom armor color for leather armor armorcolor: "#0022FF" # The stack-size of the item stack-size: 16 # Custom NBT data of the item on 1.8-1.20.4 NBTData: "{CustomModelData:40}" # Custom NBT data of the item on 1.20.5+ components: '{"minecraft:enchantments":{"minecraft:sharpness":5}}' # CustomModelData of the item CustomModelData: 1004 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#item-slot) Item slot: * The position/slot of the display item inside the main shop GUI * When outside the range of the [main shop size](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#mainshop-size) , the slot will be automatically changed to the first that is available. * Slot counts start by 0, the max slot is defined by the main shop size \* 9 Copy slot: 15 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#enabled) Enabled: * Defines whether this shop should be loaded inside the plugin * Disabled shops won't be loaded, which allows them to be re-enabled at any time later Copy enable: false ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#title) Title: * The shops title seperate from the item display name * Showed on top of the inventory when browsing the shop contents * If not specified, the item's display name will be the title of the shop * If no item display name is specified, the shop will get a invalid title. * Supports [chat colors](https://www.digminecraft.com/lists/color_list_pc.php) or custom [RGB values](https://colorspire.com/rgb-color-wheel/) ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#hidden-shop) Hidden shop: * Whether this shop section can be seen and accessed via the main shop * If a section is hidden, it will be only accessible through the direct shop command (/shop
) Copy hidden: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#sub-shops) Sub shops: * Whether this shop is a subsection * Subsections will be hidden from the main menu and cannot be opened via commands Copy sub-section: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#display-items) Display items: * Makes this section a simple display item to decorate the main shop GUI * Display items won't have a section linked and nothing will happen when a player clicks it inside the main shop GUI, neither will this section be accessible via /shop. Copy display-item: true ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#fill-item) Fill item: * A fill item will fill empty spots inside the shop category for this section Copy fill-item: material: "GRAY_STAINED_GLASS_PANE" name: ' ' lore: - "&8I'm a fill item" ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#click-mappings) Click mappings: * Allows specifying custom click actions for different click types on shop items * These settings will override the [global settings](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#click-mappings) from config.yml Copy # Possible actions: BUY, SELL, SELL_ALL # Possible click types: LEFT, SHIFT_LEFT, RIGHT, NONE click-mappings: BUY: LEFT SELL: RIGHT SELL_ALL: SHIFT_RIGHT ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#specific-currency) Specific currency: * Sets the economy used within this section, all items will be able to be bought/sold using this economy type. * Unless a [specific item economy](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#economy) is specified. _**\*Premium only feature**_ * This option uses the same format as the [default economy](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider) specified inside the config.yml Copy economy: ULTRA_ECONOMY:Gems ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#dynamic-pricing) Dynamic-pricing: * **enabled:** * Allows to enable or disable dynamic pricing inside this section * Note that this only allows to disable DP in this section, you will have to enable [**global dynamic pricing**](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#dynamic-pricing) for this to work. * **max-stock:** * The same as the DP max stock setting inside the config.yml, but instead this will strictly define the rate at which prices change when players buy items IN THIS SECTION instead of having a difficulty setting based on the item's price. * This is known to be more precise, lower values mean faster price changes compared to higher values. Copy dynamic-pricing: enabled: false max-stock: 50000 ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#click-commands) Click commands: You may use the placeholder **%player%** to get the player name or **%uuid%** * Click commands are triggered upon when the player clicks the section * **close-menu:** * When enabled, the shop won't open when clicked. * This allows click commands to redirect the player to a different GUI for example. * If disabled, the shop will open like normal while the click commands get executed in the background. Copy close-menu: true click-commands: - "minecraft:give %player% gold_nugget 3" - "minecraft:give %player% blue_wool 6" - "minecraft:give %player% yellow_wool 6" ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#rotating-shops) Rotating shops: Rotating shops require the `shop-type` option to be set to **ROTATING** Rotating shops have a different config style compared to regular shop category's, and so, per page settings are configured inside the section config instead of the shops config Rotating shops, unlike regular shop category's, have only a limited amount of items displayed each time. Every interval/frequency a new set of random items will be choosen to display. * Rotation setting, either `**interval**` or `**frequency**`: * The `**interval**` option allows to specify a custom interval for when the next rotation with different items will be displayed * Interval periods are formatted using * **d** \- Specifies the days * **h** \- Specifies the hours * **m** \- Specifies the minutes * **s** \- Specifies the seconds * Example of a 12 hours, 30 minutes and 15 seconds interval: `12h 30m 15s` * The `**frequency**` option allows to use a custom cron schedule for when the next items will be displayed at a fixed interval * Frequency's are specified using a cron schedule * See more info [here](https://wiki.gpplugins.com/economyshopgui/basics/limited-items#fixed-frequency) on using the build in cron schedulers system * Some examples include: * Every 30 minutes: `frequency: 0 0/30 * * * ?` * Every day at 12AM midnight: `frequency: 0 0 24 * * ?` * The `**can-repeat**` option sets whether or not items have a random chance to display * If disabled, items cannot be repeated across all intervals of this shop * The amount of rotations is determined by how many available items there are in this shop, divided by the amount of display slots. Example for a shop with 24 items and 3 display slots: 24/3=8 rotations before items can repeat again * When enabled, allows items to be randomly displayed(per item chances can be set using the [display-chance](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-chance) item option). * Items can also only be displayed once **per** rotation, instead of once for **all** rotations * The `**broadcast**` option sets whether to announce a global message into chat when a new rotation of items gets loaded * The `**gui-rows**` option, similar to the option inside the shop config files allows a per page size to be set * The `**display-slots**` option creates display slots for this shop page * For example if a rotating shop has 3 display slots in total, but 24 randomly configured items. Every X interval a new set of 3 random items is displayed. Copy shop-type: ROTATING rotating-shop-settings: #interval: 12h 30m 15s frequency: 0 0/30 * * * ? can-repeat: true broadcast: false # The different pages inside this section pages: page1: gui-rows: 3 display-slots: - 12 - 16 page2: gui-rows: 3 display-slots: - 10 - 14 Complete example section config (Including premium item options)[](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml#complete-example-section-config-including-premium-item-options) Copy # This is an example section file which is only a reference for how section configs should be created in /sections/.yml # The file name defines the shop internal name and needs to match the filename for the section inside the shops folder # Example: # /sections/Food.yml -> /shops/Food.yml # /sections/Workstations.yml -> /shops/Workstations.yml # # If this does not match, an example section will be created with name '.yml', so make sure it matches! # Defines whether this section should be loaded at all enable: true # The slot of the section item inside the main shop screen slot: 5 # This is a required option # The title of the shop different from the shop name title: "&c&lExample_Shop" # Defaults to the item name if empty # Whether this shop section can be seen and accessed via the main shop # If a section is hidden, it will be only accessible through the direct shop command (/shop ) hidden: false # Whether this shop is a subsection, # subsections will be hidden from the main menu and cannot be opened via commands sub-section: false # Makes this section a simple display item to decorate the main shop GUI # Display items won't have a section linked and nothing will happen when a player clicks it inside the main shop GUI, # neither will this section be accessible via /shop display-item: true # The economy used within this section, this is the same format as the config.yml uses # See a list of all available economy types here: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider economy: "ITEM:material:EMERALD name:&a&lGems" # If click commands are used within this section, should we close the shop after the click commands have been executed? # If disabled with click commands, the shop will open like normal while click commands are being executed in the background. close-menu: false # Click commands are triggered upon every time a player clicks the section item to enter the shop click-commands: - "/eco give %player% 1" - "minecraft:give %player% gold_nugget 3" # When global DynamicPricing is enabled inside the config.yml these options can be used dynamic-pricing: # Can be used to disable DP in this section # Note that global DP needs to be enabled to disable this, it is not possible to enable DP for this section alone enabled: false # The same as the DP max stock setting inside the config.yml, but instead this will strictly define the rate at which prices change # when players buy items IN THIS SECTION instead of having a difficulty setting based on the item's price. # This is known to be more precise, lower difficulty values mean faster price changes compared to higher difficulty values max-stock: 50000 # The section fill item # This item will be added to every empty slot inside the section fill-item: material: "GRAY_STAINED_GLASS_PANE" name: ' ' lore: - "&8I'm a fill item" # The navigation bar which defaults to this section # Leave empty to make this section inherit its navigation bar from the fall-back nav bar at the config.yml nav-bar: # There are currently 3 navigation bar modes: # SELF = The section will have its own navigation bar separate from the default one inside the config.yml # DISABLED = No navigation bar will be used across this section # INHERIT = The same as leaving these options blank, in other words, the default will be used mode: "SELF" # The fill item for this navigation bar which will fill blank spots fill-item: material: "GRAY_STAINED_GLASS_PANE" name: ' ' # The items containing this navigation bar, the last 9 slots of the inventory items: 1: material: "RED_WOOL" name: '%translations-previous-page%' action: PAGE_BACK # When pagination for this item is enabled, this item will only show when the shop has more than 1 page. paginated: enabled: true # The below item will show as a placeholder for the actual navigation bar item only when the shop has one page. orElse: material: AIR slot: 4 2: material: "NETHER_STAR" name: '%translations-current-page%' slot: 5 3: material: "GREEN_WOOL" name: '%translations-next-page%' action: PAGE_NEXT paginated: enabled: true orElse: material: AIR slot: 6 # Options to configure the section item inside the main shop GUI item: # The material of the item material: "BEACON" # The name of the item # If no shop title has been set, this will be used as a fallback name: "&cClick to enter the Example_Shop" # The lore of the item lore: - "&aThis section contains" - "&aa ton of different cool items." # Item enchantments enchantments: - "KNOCKBACK:10" - "SHARPNESS:10" - "MENDING" - "excellentenchants:BLAST_MINING:3" # Whether this item should have an enchantment glow affect enchantment-glint: true # The skull owner for this item skullowner: "Notch" # The skull texture of the item skull-texture: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjUzMGQ5YjAwZDA3NjEyNWRmOWE1YjE3ZjQzN jcwOTg0NDQyY2U1NzM5ZGViZGJkM2M1MzA0MDkyNjA1MmNhNiJ9fX0=" # Custom armor color for leather armor armorcolor: "#0022FF" # The stack-size of the item stack-size: 16 # Custom NBT data of the item NBTData: "{CustomModelData:40}" # The shop type requires to be set for rotating shops, # or defaults to a shop category shop-type: ROTATING # Settings for rotating shops rotating-shop-settings: # Specifies the period for how frequently this rotating shop # changes its display items interval: 12h 30m 15s # Enables or disables randomly displayed items # Disabling this will make sure every item only displays once randomly # but without a specific display chance can-repeat: true # The different pages inside this section pages: page1: # Similar to the option in shop configs, # this option allows to specify the page size in rows gui-rows: 3 # Creates displayable slots for items # These slots will display a new set of items each rotation display-slots: - 12 - 16 page2: gui-rows: 3 display-slots: - 10 - 14 [PreviousConfig.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml) [NextShops](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml) Last updated 5 months ago Was this helpful? --- # Shops | EconomyShopGUI wiki The file name defines the shop internal name and needs to match the filename for the [section](https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml) config inside the sections folder [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#general-information-about-the-shops-configuration) General information about the shops configuration. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Since version v6 or Premium v5 of the plugin, sections are stored in their seperate config, instead of using a single sections.yml config to store all of them. These configs store all items for the specific shop category(section) which are linked to the specific sections config. This config stores all contents of the shop including shop items and per page configurations. * Custom items from other plugins are only supported with ESGUI-Premium. (Unless they are created with keys available in the Free version) We recommend you change the prices of the items to suit your server's economy. There are many different types of servers, such as skyblock, survival, factions, pvp, etc... Most servers will need to customize the shops to their needs and have different prices from other servers. If you choose to use the default configs as-is, you may. You may also check [discord #Shop-Files-Sharing](https://discord.com/invite/nPyuB4F) channel for shop files that may suit your needs. [Please read About YAML](https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files) before editing your files! It DOES NOT tolerate any errors! [Validate it!](https://jsonformatter.org/yaml-validator) * TIP: Use the contents on the right side of this page to navigate quickly! #### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#file-format-structure) File format structure: Copy ###### code formatting reference names: ###### pages: : items: : : #Single value key : #List-format must support multiple values. (lore, enchants, etc..) - - ###### example: ###### pages: page1: gui-rows: 6 title: "&dCustom title for this page" items: item1: material: PAPER name: "Egyptian Papyrus" buy: 6 sell: 2 lore: - "Papyrus from ancinet Egypt" [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#item-settings) Item settings/keys: ----------------------------------------------------------------------------------------------------------------- ### [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#item-keys-list) Item keys list: * [**material:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#material) - The item type (the [block ID or Name\_spaced name](https://www.digminecraft.com/lists/item_id_list_pc.php) given to it by Mojang) * [**buy:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy) - Price the item will cost to purchase. * [**sell:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell) - Price the item is worth when sold to the shop/server. * [**name:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#name) - The name of the item * [**displayname:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-name) \- The name shown on the item _**in the shop only**_, it is NOT applied to the given item * [**lore:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#lore) - a list of custom text applied to the item. * [**displaylore:**](https://gpplugins.gitbook.io/economyshopgui/file-configuration/shops.yml#displaylore-optional-any-item) _-_ a list of custom text applied to _**the shop item only**_, it is NOT applied to the given item. * [**hidePricingLore:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidepricinglore-optional-any-item) - hide the default pricing lore for the item * [hideDecorationLore:](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidepricinglore) - hide the usage/decoration lore per item * [**slot:**](https://gpplugins.gitbook.io/economyshopgui/file-configuration/shops.yml#slot-optional-any-item) - This option is used to determine the slot inside the shop section * [**stack-size:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#stack-size) - This option adds a custom stack size to the item * [**enchantment-glint:**](https://gpplugins.gitbook.io/economyshopgui/file-configuration/shops.yml#enchantment-glint-optional) - This option lets u use a enchantment effect on the item. * [**enchantments:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments) - a list of enchantments and level. * [**potiontypes:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types) - a list of potion types * [**spawnertype:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#spawner-type) - the mob that a spawner is set to by ESGUI when placed. \[ONLY for `spawner` material/item.\ \ * [**recipes:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#recipie)\ - the recipe(s) that a `knowledge_book` will give when used\ \ * [**skullowner:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#skull-owner)\ - the texture or player's skull that will be displayed by the `player_head` item.\ \ * [**armorcolor:**](https://gpplugins.gitbook.io/economyshopgui/file-configuration/shops.yml#armor-color-required-specific-item-any-leather-armor-piece)\ \- the rgb color of a leather armor piece.\ \ * [**duration:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ , [**colors:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ , [**fade-colors:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ , [**flicker:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ , [**trail:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ , [**shape:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#duration-colors-fade-colors-flicker-trail-shape-required-specific-item-firework)\ - these options can be used to create a firework\ \ * [**instrument:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#undefined)\ - Specifies the sound effect that comes from a Goat Horn\ \ * [**section:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sub-sections)\ \- Links the item to a shop section\ \ * [**stew-effect:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#stew-effect)\ - Gives a specific effect to a suspicious stew\ \ * [**armor-trim:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#armor-trim)\ Sets a armor trim to a armor piece\ \ * [**hidden:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidden)\ - Hides the item from the GUI but can still be sold to shop\ \ * [**max-buy:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-buy)\ - Sets the maximum amount of items which can be bought per transaction\ \ * [**max-sell:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-sell)\ - Sets the maximum amount of items which can be sold per transaction\ \ * [**min-buy:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#min-buy)\ \- Sets the minimum amount of items which is required to be bought per transaction\ \ * [**min-sell:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#min-sell)\ - Sets the minimum amount of items which is required to be sold per transaction\ \ * [**prior-lore:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#prior-lore)\ \- Whether or not to prioritize default pricing lore\ \ * [**close-menu:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#close-menu)\ \- Whether or not to close the shop GUI after a transaction has been made\ \ * [**display-item:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-items)\ - Can be used to create a different display item then the actual item received on buying/selling\ \ * [**requirements:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#requirements)\ - Specifies a list of requirements the player needs\ \ * [**ominous-strength:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#ominous-strength)\ - Changes the strength of a ominous potion\ \ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#premium-only-item-keys)\ \ Premium only item keys:\ \ * [**nbtdata:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#nbt-data)\ - highly technical data that will be applied to an item.\ \ * [**components:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#components)\ \- replaces the NBTData option for 1.20.5 and newer server versions\ \ * [**sell-commands:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands)\ \- List of commands which get executed upon selling an item.\ \ * [**requireItem:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands)\ - Whether the shop item is required to be sold before executing a sell command.\ \ * [**buy-commands:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands)\ \- List of commands which get executed upon purchasing an item.\ \ * [**giveItem:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands)\ - Whether the item is given to a player after executing the buy-commands.\ \ * [**click-commands:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#commands)\ - List of commands executed when the player clicks the shop item\ \ * [**stock-limit-global:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock)\ - The amount of stock for the server\ \ * [**refill-stock:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock)\ \- Allows the item stock limit to refill when selling items.\ \ * [**auto-restock-global:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-stock)\ - The time to restock the global item\ \ * [**stock-limit-player:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock)\ \- The amount of stock for each player individual\ \ * [**auto-restock-player:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-stock)\ \- The time to restock the player item\ \ * [**sell-limit-global:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit)\ \- A selling limit for an item set server wide.\ \ * [**auto-restock-global-sell:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#global-sell-limit)\ \- The time between reaching the sell limit and it restoring the original amount.\ \ * [**sell-limit-player:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-sell-limits)\ \- A selling limit for an item set player wide.\ \ * [**auto-restock-player-sell:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#player-sell-limits)\ \- The time between reaching the sell limit and it restoring the original amount.\ \ * [**skull-texture:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#skull-texture)\ _\-_ Adds a custom skull texture to the player head\ \ * [**economy:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#economy)\ - Allows the item to use a specific economy/currency provider\ \ * [**permission:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#permission)\ - Sets a per item permission to buy/sell\ \ * [**permission-requirement:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#permission-requirement)\ - Prevents the player from purchasing the item again when disabled\ \ * [**hideUtilLore:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hide-util-lore)\ \- Hides the limited item stock and limited sell lore\ \ * [**dynamic-pricing:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#dynamic-pricing)\ \- Used to disable DynamicPricing per item\ \ * [**buy-prices:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy-prices)\ - Used to add multiple payment options to a single item\ \ * [**sell-prices:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell-prices)\ \- Used to add multiple sell prices to a single item\ \ * [**ignored-tags:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#ignored-tags)\ - Used to ignore certain NBTTags for sold items\ \ * [**transactionMessage:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#transaction-message)\ - Whether to send a transaction confirmation message to the player after the item has been purchased/sold from shop\ \ * [**display-chance:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-chance)\ - Allows specific items in rotating shops to have a custom display chance\ \ * [**item-flags:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#item-flags)\ - Adds various settings to the item to hide default lore\ \ * [**CustomModelData:**](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#custommodeldata)\ \- Sets the CustomModelData of the item\ \ \ If the `**displayname**` or `**name**` is empty or not set, the item will have the vanilla name.\ \ When only key `**name**` is specified and no `**displayname**` key, the item will use the name specified in the shop when you hover over it and when the item is bought.\ \ When setting the `**sell/buy**` key to any negative number, the item cannot be bought/sold in the shop. (You can also remove the buy/sell price from the item for the same effect)\ \ Creating a item with **no** buy and sell price will make it a _filler_ item which you can use to decorate your shop.\ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#breakdown)\ \ Item keys breakdown:\ \ \ --------------------------------------------------------------------------------------------------------------\ \ * A simple buy/sell able shop item only needs 3 keys specified: [`**material**`](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#material)\ , [`**buy**`](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy)\ price, and [`**sell**`](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell)\ price. Everything else is optional.\ \ \ Copy\ \ pages:\ page1: # The page index\ gui-rows: 6 # Amount in rows (1 row is 9 slots)\ title: " &8<=== &aExample page &c1 &8===> "\ items:\ 1: # The item index (can be anything, not just numbers)\ material: milk_bucket\ buy: 20\ sell: 2\ page2: # The page index\ gui-rows: 2 # Amount in rows (1 row is 9 slots)\ title: " &8<=== &aExample page &c2 &8===> " # Per page title\ items:\ 1: # The item index (can be anything, not just numbers)\ material: gold_ingot\ buy: 9000\ sell: 2800\ \ Leaving a buy/sell price unspeficied for the item will make it unbuyable/unsellable\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#material)\ \ Material:\ \ * This is the item or block ID that will be listed/sold in the shop.\ \ * It MUST be a [valid name\_spaced item](https://www.digminecraft.com/lists/item_id_list_pc.php)\ for your version of Minecraft!\ \ * The material must be a valid item ID. Some lists to get these ID's from:\ \ * [1.16 and below](https://www.digminecraft.com/lists/item_id_list_pc.php)\ \ * [1.18 items](https://minecraftitemids.com/)\ \ * [1.19 items by CommandLeo](https://docs.google.com/spreadsheets/d/1-Jf8VpmG-V2ytZ0ppAEDtVSaVYEjQ-CYAZMt-eQMNxQ/edit#gid=984941200)\ \ \ * The 'Name Space' ID of an item is the code-given-name of the item.\ \ * It cannot have spaces or special characters and may contain underscores (\_).\ \ * Ex: `material: "experience_bottle"`\ \ * The ID is NOT case-sensitive.\ \ * Direct plugin compatibility: _**\*Premium feature**_\ \ * ItemsAdder items: `material: "ia:"`\ \ * HeadDatabase items: `material: "hdb:"`\ \ * Items from MMOItems: `material: "MMOItem:."`\ \ * Items from ExecuteableItems: `material: "ei:"`\ \ * Oraxen items: `material: "oraxen:"`\ \ * Brewery/BreweryX `material: "brewery:."`\ \ * Nexo items: `material: "nexo:"`\ \ * Slimefun items: `material: "sf:"`\ \ * MythicMobs items: `material: "mythicmobs:"`\ \ * CraftEngine items: `material: "craftengine:"`\ \ * Items from EcoItems: `material: "ecoitems:"`\ \ \ \ For compatibility reasons: any name given to items after the 1.13 'the flattening' update will work in the supported 1.8 - 1.12 versions of minecraft.\ \ You can create a dummy _spacer_ item in a shop by setting it's material to AIR (empty slot)\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#buy)\ \ Buy:\ \ * This is the price or cost of the item that the player will have to pay to purchase or buy the item.\ \ * This can be any number.\ \ * This is the amount that will be removed or taken from the player's balance (stored in your vault-compatible economy plugin)\ \ * This value is only shown in the shop, and not on any bought item\ \ \ Setting this to Any Negative Number will disable it, making it Not Purchasable/Not Buyable. Ex: `buy: -1`\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sell)\ \ Sell:\ \ * This is the value of the item when sold to the server.\ \ * This can be any number\ \ * This is the amount that will be given or paid to the player when the item is sold to the server (money is added to the player's balance.)\ \ * This value is only shown in the shop, and not on any bought item\ \ \ Setting this to Any Negative Number will disable it, making it Not Sellable. Ex: `sell: -1`\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#name)\ \ Name:\ \ * This will specify a name for the item when it is bought from shop AND when no `displayname` option is specified it will also be the name for the item when hovering over it in shop.\ \ * It may contain [Chat-Codes](https://www.digminecraft.com/lists/color_list_pc.php)\ [(Color/Formatting)](https://www.digminecraft.com/lists/color_list_pc.php)\ or [RGB colors](https://colorspire.com/rgb-color-wheel/)\ .\ \ \ Copy\ \ #Example item with a name that is only shown in the shop, AND a name that is on the item bought.\ pages:\ pages1:\ items:\ 1:\ material: milk_bucket\ buy: 20\ sell: 2\ displayname: "&f&lGot Milk?" #this is what is shown in the shop.\ name: "&bWe got &f&lMilk!" #this is the name that will be on the item when purchased/bought.\ \ Only specifing option `**name**` on the item will make it use the same displayname when hovering over it AND the name for the item when it is bought.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-name)\ \ Displayname:\ \ * Do not confuse this option with `name` since this option will ONLY set the name for the display item inside the shop(When hovering over the item)\ \ * It will NOT be on the item when purchased/bought.\ \ * It may contain [Chat-Codes](https://www.digminecraft.com/lists/color_list_pc.php)\ [(Color/Formatting)](https://www.digminecraft.com/lists/color_list_pc.php)\ or [RGB colors](https://colorspire.com/rgb-color-wheel/)\ .\ \ \ Copy\ \ #Example item with a display name that is only shown in the shop, and not on the item bought\ pages:\ pages1:\ items:\ 1:\ material: milk_bucket\ buy: 20\ sell: 2\ displayname: "Got Milk?"\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#lore)\ \ Lore:\ \ * Create custom text and info about the item!\ \ * It may contain [Chat-Codes](https://www.digminecraft.com/lists/color_list_pc.php)\ [(Color/Formatting)](https://www.digminecraft.com/lists/color_list_pc.php)\ or [RGB colors](https://colorspire.com/rgb-color-wheel/)\ .\ \ * You may use placeholder `%buyPrice%/%sellPrice%`\ \ \ Copy\ \ #Example item with a name that is only shown in the shop, AND a name that is on the item bought.\ pages:\ pages1:\ items:\ 1:\ material: netherite_shovel\ buy: 2000000\ sell: 5000\ displayname: "&c&lDevil's Paw"\ name: "&c&lDevil's Paw"\ lore:\ - "&5This is the severed hand of"\ - "&5the devil himself. Be careful,"\ - "&5who can say what unholy powers"\ - "&5it may still contain..."\ \ The `**lore/displaylore**` key work the same as the `**name/displayname**` key but instead it specifies the lore. Meaning that when only `**lore**` is specified, the item will use the lore as the lore when hovering over the item AND when you buy the item.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#displaylore)\ \ Displaylore:\ \ * Do not confuse this option with `lore` since this option will ONLY set the lore for the display item inside the shop(When hovering over the item)\ \ * Create custom text and info about the item!\ \ * It may contain [Chat-Codes](https://www.digminecraft.com/lists/color_list_pc.php)\ [(Color/Formatting)](https://www.digminecraft.com/lists/color_list_pc.php)\ or [RGB colors](https://colorspire.com/rgb-color-wheel/)\ .\ \ * You may use placeholder `%buyPrice%/%sellPrice%`\ \ \ Copy\ \ pages:\ pages1:\ items:\ 1:\ material: AMETHYST_SHARD\ buy: 10\ sell: 5\ lore: # This is the lore of the item when bought from shop\ - '&cNotch'\ displaylore: # This is the lore of the item when hovering over it in shop\ - '&1Gypopo'\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidepricinglore)\ \ HidePricingLore:\ \ * Option `**hidePricingLore**` will do what the name suggests, it will hide the default pricing lore of the item so you could add your own for example\ \ * This will hide the pricing lore even if the item is still purchase/sell-able\ \ * This option comes in handy when you want to make _dummy/display_ items\ \ \ Copy\ \ pages:\ page1:\ items:\ 1:\ material: LAVA_BUCKET\ buy: 200\ sell: 75\ hidePricingLore: true # This will make the prices not visible for the player\ 2:\ material: WATER_BUCKET\ buy: -1\ sell: -1\ hidePricingLore: true # This will hide the default 'This item cannot be bought/sold' lore\ \ This option allows to hide the default pricing lore as a **per item** setting but to fast forward it you can empty out the lore inside the [language file](https://wiki.gpplugins.com/economyshopgui/file-configuration/languages#language-file-example)\ which will do the same but for **every** item\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidedecorationlore)\ \ HideDecorationLore:\ \ * The `**hideDecorationLore**` will hide the usage/decoration lore per item\ \ \ Copy\ \ pages:\ page6:\ items:\ clean_item:\ material: TOTEM_OF_UNDYING\ buy: 7500\ sell: 725\ hidePricingLore: true\ hideDecorationLore: true\ displaylore:\ - "&aComes with a heavy investment of just &f7500$"\ - "&abut can save lives when on hand, which is worth it if you ask me."\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#slot)\ \ Slot:\ \ * Option `**slot**` determines the position of the item inside the shop page\ \ * **TIP**: It is possible to display one item at multiple positions by specifying multiple slots\ \ * Example: `slot: 1-9,36-45` which will display the same item at all slots from 1 thru 9 and 36 thru 45\ \ * Example: `slot: 20,24-28,30,31` which will display the same item at slot 20, all slots from 24 thru 28, slot 30 and 31\ \ \ \ Copy\ \ pages:\ pages1:\ gui-rows: 6\ items:\ 1:\ material: chainmail_chestplate\ buy: 25\ sell: 10\ name: "&d&lKnight's armor piece"\ slot: 11\ 2:\ material: iron_chestplate\ buy: 35\ sell: 15\ name: "&d&lKnight's armor piece"\ slot: 13\ 3:\ material: diamond_chestplate\ buy: 50\ name: "&d&lKnight's armor piece"\ slot: 15\ 4:\ material: netherite_chestplate\ buy: 100\ name: "&d&lKnight's armor piece"\ slot: 17\ 999:\ material: LIGHT_BLUE_STAINED_GLASS_PANE\ name: '&bFill item'\ slot: 1-10,18,19,27,28,36,37,38-45\ \ The slot of items need to be in range of the shop page size, if not, the item will not be able to load with a error in console.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#stack-size)\ \ Stack size:\ \ * Option `**stack-size**` sets the stack size of the shop item\ \ * When for example the stack size is set to 5, when the player purchases 2 stacks of this item, they will receive 10 items in total\ \ \ Copy\ \ pages:\ pages1:\ items:\ 1:\ material: APPLE\ name: "&cA stack of 20 apples"\ buy: 200\ sell: 50\ stack-size: 20\ \ **Note:** When setting a items stack-size, the prices of the item count for the whole stack. So meaning with the item above, 10 apples would be worth $100 and sell for $25.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantment-glint)\ \ Enchantment glint:\ \ * This option lets u add a enchantment glow effect to any item to give your shop items a more personal touch.\ \ \ **Note**: This will add a 'dummy' enchantment of aqua affinity 1 to the item, but default lore will be removed.\ \ Copy\ \ pages:\ pages1: \ items:\ 1:\ material: BLAZE_ROD\ name: "&cShiny rod"\ buy: 50.0\ sell: 10.0\ enchantment-glint: true\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#enchantments)\ \ Enchantments:\ \ * Add as many enchantments as you want to an item!\ \ * `enchantments` is a yml-list-format list of [valid enchantments](https://www.digminecraft.com/lists/enchantment_list_pc.php)\ that are applied to the item when bought.\ \ * Enchantments must be in this format: `:` (without the "<>") if no level is specified (no `:1`, it will be level 1)\ \ * Enchantments [must be valid/exist in your version of MC.](https://www.digminecraft.com/lists/enchantment_list_pc.php)\ \ * To enable enchants greater than default/vanilla you must enable `allow-unsafe-enchants: true` in the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#allow-unsafe-enchants)\ \ * Custom enchants from external plugins like EcoEnchants, AdvancedEnchantments, ExcelentEnchants are directly supported using the format of `::` _\*Premium feature_\ \ * You can find [a list of enchantments for your version of MC here](https://www.digminecraft.com/lists/enchantment_list_pc.php)\ !\ \ \ Copy\ \ #Example of an Enchanted item:\ pages:\ pages1:\ items:\ 1:\ material: diamond_pickaxe\ buy: 2000000\ sell: 5000\ displayname: "&4Silky Smooth"\ name: "&4Silky Smooth"\ lore:\ - "&5The smooooothest pick!"\ enchantments:\ - "silk_touch:1"\ - "efficiency:5"\ - "ecoenchants:blast_mining:3" # Example of a custom enchant from EcoEnchants\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types)\ \ Potion Types:\ \ * Add as many potion-effects to Potions and Tipped Arrows as you want!\ \ * `potiontypes` is a yml-list-format list of [valid potion types](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types-table)\ that are applied to the item when bought.\ \ * Potion Types must be [valid vanilla potion types for your version of Minecraft](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potion-types-table)\ \ * Valid [materials](https://www.digminecraft.com/lists/item_id_list_pc.php)\ that these effects can be applied to are: `potion`, `splash_potion`, `lingering_potion`, and `tipped_arrow`.\ \ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#normal-potion-types)\ \ Normal Potion Types:\ \ Potion namespace (USE THIS)\ \ Commonly known as:\ \ Vanilla duration and strength\ \ `water`\ \ Water Bottle(No effect)\ \ 0 sec | 1\ \ `mundane`\ \ Mundane(No effect)\ \ 0 sec | 1\ \ `thick`\ \ Thick(No effect)\ \ 0 sec | 1\ \ `awkward`\ \ Awkward(No effect)\ \ 0 sec | 1\ \ `fire_resistance`\ \ Fire Resistance\ \ 180 sec | 1\ \ `harming`\ \ Instant Damage, Harming\ \ 0 sec | 1\ \ `healing`\ \ Instant Health, Instant Healing, Heal\ \ 0 sec | 1\ \ `invisibility`\ \ Invisibility\ \ 180 sec | 1\ \ `leaping`\ \ Leaping, Jumping, Jump Boost, Jump\ \ 180 sec | 1\ \ `night_vision`\ \ Night Vision\ \ 180 sec | 1\ \ `poison`\ \ Poison\ \ 45 sec | 1\ \ `regeneration`\ \ Regeneration, Healing\ \ 45 sec | 1\ \ `slow_falling`\ \ Slow Falling\ \ 90 sec | 1\ \ `slowness`\ \ Slowness\ \ 90 sec | 1\ \ `strength`\ \ Strength\ \ 180 sec | 1\ \ `swiftness`\ \ Swiftness, Speed\ \ 180 sec | 1\ \ `turtle_master`\ \ Turtle Master\ \ 20 sec | 1\ \ `water_breathing`\ \ Water Breathing,\ \ 180 sec | 1\ \ `weakness`\ \ Weakness\ \ 90 sec | 1\ \ `infested`\ \ Infested\ \ 180 sec | 1\ \ `weaving`\ \ Weaving\ \ 180 sec | 1\ \ `wind_charged`\ \ Wind Charged\ \ 180 sec | 1\ \ `oozing`\ \ Oozing\ \ 180 sec | 1\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#extended-potion-types)\ \ Extended Potion Types:\ \ Potion namespace (USE THIS)\ \ Commonly known as:\ \ Vanilla duration and strength\ \ `long_fire_resistance`\ \ Fire Resistance\ \ 480 sec | 1\ \ `long_invisibility`\ \ Invisibility\ \ 480 sec | 1\ \ `long_leaping`\ \ Leaping, Jump Boost, Jump\ \ `long_night_vision`\ \ Night Vision\ \ 480 sec | 1\ \ `long_poison`\ \ Poison\ \ 120 sec | 1\ \ `long_regeneration`\ \ Regeneration\ \ 120 sec | 1\ \ `long_slow_falling`\ \ Slow Falling\ \ 240 sec | 1\ \ `long_slowness`\ \ Slowness\ \ 240 sec | 1\ \ `long_strength`\ \ Strength\ \ 480 sec | 1\ \ `long_swiftness`\ \ Swiftness, Speed\ \ 480 sec | 1\ \ `long_turtle_master`\ \ Turtle Master\ \ 40 sec | 1\ \ `long_water_breathing`\ \ Water Breathing\ \ 480 sec | 1\ \ `long_weakness`\ \ Weakness\ \ 240 sec | 1\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#strong-level-2-potions)\ \ Strong/Level 2 Potions:\ \ Potion namespace (USE THIS)\ \ Commonly known as:\ \ Vanilla duration and strength\ \ `strong_harming`\ \ Harming II\ \ 0 sec | 2\ \ `strong_healing`\ \ Healing II\ \ 0 sec | 2\ \ `strong_leaping`\ \ Jump Boost II, Jump II, Leaping II\ \ 90 sec | 2\ \ `strong_poison`\ \ Poison II\ \ 22 or 60 sec | 2\ \ `strong_regeneration`\ \ Regeneration II\ \ 22 or 60 sec | 2\ \ `strong_strength`\ \ Strength II\ \ 90 or 240 sec | 2\ \ `strong_swiftness`\ \ Swiftness II, Speed II\ \ 90 or 240 sec | 2\ \ `strong_turtle_master`\ \ Turtle Master II\ \ 20 sec | 2\ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potions-available-but-not-craft-able)\ \ Potions available, but not craft-able:\ \ Potion namespace (USE THIS)\ \ Commonly known as:\ \ Vanilla duration and strength\ \ `luck`\ \ Luck\ \ 300 sec | 1\ \ * Luck only obtainable as a tipped\_arrow from a fletcher villager after receiving hero of the village status effect\ \ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#other-potions-but-have-no-effects)\ \ Other Potions, but have no effects:\ \ Potion namespace (USE THIS)\ \ Commonly known as:\ \ `awkward`\ \ Awkward\ \ `empty`\ \ Empty\ \ `mundane`\ \ Mundane\ \ `thick`\ \ Thick\ \ `water`\ \ Water\ \ NOTE: Potion duration listed is for a standard potion, not Tipped Arrows or lingering potions\ \ * [Additional potion type data values and info here. (source)](https://minecraft.fandom.com/wiki/Potion#Data_values)\ \ \ #### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#potions-examples)\ \ Potions Examples:\ \ Copy\ \ pages:\ pages1:\ items:\ 1:\ #a common craftable vanilla potion:\ material: POTION\ displayname: "Potion of Fire Resistance"\ buy: 11.9\ sell: 2.98\ potiontypes:\ - fire_resistance\ 2: \ #example of 'custom' potion: full list NOT Reccomended for survival servers!!\ material: POTION\ displayname: "&bSuperman Potion"\ name: "&bSuperman Potion"\ buy: 5000\ sell: 50\ potiontypes:\ - long_fire_resistance\ - long_night_vision\ - long_leaping\ - long_regeneration\ - long_strength\ - long_swiftness\ - long_water_breathing\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#spawner-type)\ \ Spawner Type:\ \ * `spawnertype` must be a [valid Name\_spaced mob for your version of minecraft.](https://www.digminecraft.com/mobs/index.php)\ \ * [All entity types that can be used on spawners can be found here](https://www.digminecraft.com/mobs/index.php)\ .\ \ * **All** `**spawner**` **material items REQUIRE this setting** to correctly apply the mob-type when placed (\*With the exception of 3rd party plugins where you have configured [NBT-data](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#nbt-data)\ on the item. \*Premium feature)\ \ * NOTE: this setting is only works if you have [spawner-break](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings)\ and [spawner-break](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#spawner-settings)\ enabled in the [config.yml](https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml)\ \ \ **Tip**: When key `**name**` has been specified on the item, the spawner will have the specified name when mined by a player! :)\ \ Copy\ \ #Example Spawner item\ pages:\ pages1:\ items:\ 1:\ material: SPAWNER\ #you MUST specify a spawner type, otherwise they will always be pig(default) spawners\ spawnertype: BLAZE\ #the 'name' will also be applied to the item when MINED if the mined spawner's mobtype is specified in ESGUI (and spawner-break is enabled in in config)\ #the name is optional, however without it, you can't tell what mob the spawner is set too without showing nbt data on your client (it will just say 'spawner' to everyone)\ name: '&6&lBlaze &fSpawner'\ buy: 125000\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#recipe)\ \ Recipes:\ \ * A list of recipes that can be applied to the item and given to the player when the item is used.\ \ * Recipe books will give/learn the recipes for a player when they activate it(right click the book).\ \ \ We will not be going in depth into recipes here. [Please consult knowledge\_book documentation here.](https://minecraft.fandom.com/wiki/Recipe_book)\ However, the majority of recipes are written as `minecraft:iron_ingot` for example.\ \ Copy\ \ #Example Knowledge Book item:\ pages:\ pages1:\ items:\ 1:\ material: Knowledge_book\ name: "Get Rusty"\ recipes: \ - "minecraft:iron_ingot"\ - "minecraft:furnace"\ - "minecraft:NETHERITE_SWORD"\ buy: 10\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#skull-owner)\ \ Skull Owner:\ \ * `skullowner` must be a valid mojang-account player's name.\ \ * If the playername is invalid/does not exist, the default/generic texture will be used.\ \ \ Copy\ \ #Example Playerhead item:\ pages:\ pages1:\ items:\ 1:\ material: player_head\ skullowner: notch\ buy: 500\ sell: 50\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#armor-color)\ \ Armor Color:\ \ * `armorcolor` must be in a valid hexadecimal format. _**Example: '0x00FF00', '#00FF00' or '00FF00'**_\ \ * See this site for a color wheel you can use: [https://www.colorspire.com/rgb-color-wheel/](https://www.colorspire.com/rgb-color-wheel/)\ \ \ Copy\ \ #Example ArmorColor item:\ pages:\ pages1:\ items:\ 1:\ material: player_head\ armorcolor: "0x00FF00"\ buy: 500\ sell: 50\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#firework-options)\ \ Firework options:\ \ * `**duration:**` is the flight duration of the firework\ \ * Valid options: `**1**`, `**2**`, `**3**` (Each value represents how much gunpowder would be used)\ \ \ * `**colors:**` a list of colors that are used inside the firework's main exploisen\ \ * Valid options are: `**White**`, `**Orange**`, `**Magenta**`, `**Light_Blue**`, `**Yellow**`, `**Lime**`, `**Pink**`, `**Gray**`, `**Light_Gray**`, `**Cyan**`, `**Purple**`, `**Blue**`, `**Brown**`, `**Green**`, `**Red**`, `**Black**`\ \ \ * `**fade-colors:**` a list of colors that are used inside the firework's fading\ \ * Valid options: `**White**`, `**Orange**`, `**Magenta**`, `**Light_Blue**`, `**Yellow**`, `**Lime**`, `**Pink**`, `**Gray**`, `**Light_Gray**`, `**Cyan**`, `**Purple**`, `**Blue**`, `**Brown**`, `**Green**`, `**Red**`, `**Black**`\ \ \ * `**flicker: true/false**` Whether or not this firework has the twinkle effect, this is the same as using glowstone when crafting\ \ * `**trail: true/false**` Whether or not this explosion has the trail effect, this is the same as using a diamond when crafting\ \ * `**shape:**` The shape of the explosion of the firework\ \ * Valid options: `**ball**`, `**ball_large**`, `**star**`, `**burst**`, `**creeper**`\ \ \ \ If you want to add fade-colors, flicker, trail or shape you need to specify atleast one color\ \ Copy\ \ pages:\ pages1:\ items:\ 1:\ material: FIREWORK\ buy: 38.50\ sell: 20\ duration: 2\ colors:\ - "cyan"\ - "purple"\ fade-colors:\ - "black"\ - "gray"\ flicker: true\ trail: true\ shape: BURST\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#instrument)\ \ Instrument:\ \ * Add this to goat horns to specify which sound they create\ \ * Valid sounds: `**PONDER**`, `**SING**`, `**SEEK**`, `**FEEL**`, `**ADMIRE**`, `**CALL**`, `**YEARN**`, `**DREAM**`\ \ \ * The item material needs to be a GOAT\_HORN for this option to work\ \ \ Copy\ \ pages:\ pages1:\ items:\ 19: \ material: GOAT_HORN\ buy: 100 \ sell: 25 \ instrument: "dream"\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#sub-sections)\ \ Sub sections:\ \ * This item option will link the item to a shop section\ \ * Upon clicking the item the player will enter the section linked\ \ \ \ Copy\ \ pages:\ pages1:\ items:\ 29:\ material: "COBBLESTONE"\ section: Cobblestones\ lore:\ - "&6&lClick to enter the CobbleStone section"\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#stew-effect)\ \ Stew effect:\ \ * Allows you to specify a potion effect on a suspicious stew\ \ \ Copy\ \ pages:\ pages1:\ items:\ Stew_1:\ material: SUSPICIOUS_STEW\ buy: 5\ sell: 2\ stew-effect: REGENERATION\ \ Potion type\ \ ID\ \ Duration\ \ `**NIGHT_VISION**`\ \ `**0**`\ \ `**5s**`\ \ `**JUMP_BOOST**`\ \ `**1**`\ \ `**6s**`\ \ `**WEAKNESS**`\ \ `**2**`\ \ `**9s**`\ \ `**BLINDNESS**`\ \ `**3**`\ \ `**8s**`\ \ `**POISON**`\ \ `**4**`\ \ `**12s**`\ \ `**SATURATION**`\ \ `**6**`\ \ `**0.35s**`\ \ `**FIRE_RESISTANCE**`\ \ `**7**`\ \ `**4s**`\ \ `**REGENERATION**`\ \ `**8**`\ \ `**8s**`\ \ `**WITHER**`\ \ `**9**`\ \ `**8s**`\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#armor-trim)\ \ Armor Trim:\ \ * Allows the armor piece to have a preset armor trim effect\ \ * `type:` sets the armor trim material/type\ \ * Valid values are: **AMETHYST**, **COPPER**, **DIAMOND**, **EMERALD**, **GOLD**, **IRON**, **LAPIS**, **NETHERITE**, **QUARTZ**, **REDSTONE**\ \ \ * `pattern:` sets the armor trim pattern\ \ * Valid values are: **COAST**, **EYE**, **DUNE**, **RIB**, **HOST**, **RAISER**, **SENTRY**, **SHAPER**, **SILENCE**, **SNOUT**, **SPIRE**, **TIDE**, **VEX**, **WARD**, **WAYFINDER**, **WILD, FLOW, BOLT**\ \ \ * See this site for a armor trim generator: [https://minetrim.com/](https://minetrim.com/)\ \ \ Copy\ \ pages:\ page5:\ items:\ ArmorTrim1:\ material: NETHERITE_CHESTPLATE\ buy: 750\ sell: 200\ armor-trim:\ type: GOLD\ pattern: WARD\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#hidden)\ \ Hidden:\ \ * Whether or not to hide the item from displaying in shop.\ \ \ Hidden items can still be sold to shop using /sellgui or /sellall.\ \ Copy\ \ pages:\ pages1:\ items:\ Hidden1:\ material: "ENCHANTED_GOLDEN_APPLE"\ hidden: true # The item is not displayed in the food section\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-buy)\ \ Max buy:\ \ * When set to **\-1**, allows players to purchase the item by just clicking it in shop without opening the buy screen!\ \ * Sets the maximum amount the item can be bought per transaction.\ \ \ Since EconomyShopGUI v6.0.0 and EconomyShopGUI Premium v5.0.0 max-buy will require to be set to -1 instead of 1 to allow insta purchases.\ \ Copy\ \ pages:\ pages1:\ items:\ Item5:\ material: STONE\ stack-size: 32 # Will instant buy 32 stone without entering the buy screen\ max-buy: -1 # When set to -1, players will skip the buy screen\ buy: 5\ sell: 2.5\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#max-sell)\ \ Max sell:\ \ * When set to **\-1**, allows players to sell the item by just clicking it in shop without opening the sell screen!\ \ * Sets the maximum amount the item can be sold per transaction.\ \ \ Since EconomyShopGUI v6.0.0 and EconomyShopGUI Premium v5.0.0 max-sell will require to be set to -1 instead of 1 to allow insta sells.\ \ Copy\ \ pages:\ pages1:\ items:\ Item6:\ material: STONE_CUTTER\ max-sell: 5 # Will only allow you to sell 5 items at a time\ buy: 5\ sell: 2.5\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#min-buy)\ \ Min buy:\ \ * Sets a minimum amount of items which have to be bought per transaction\ \ \ Note that the minimum buy amount will also set the default stack-size of the item, though, unlike setting the stack-size option on the item manually, this will not change the item price\ \ Copy\ \ pages:\ pages1:\ items:\ Item5:\ material: ARROW\ min-buy: 20\ buy: 0.2\ sell: 0.08\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#min-sell)\ \ Min sell:\ \ * Sets a minimum amount of items which have to be sold per transaction\ \ * Example: Trying to sell 3 slime balls while the `min-sell` option has been set to 5, will not sell the slime balls\ \ \ \ Note that the minimum buy amount will also set the default stack-size of the item, though, unlike setting the stack-size option on the item manually, this will not change the item price\ \ Copy\ \ pages:\ pages1:\ items:\ Item5:\ material: SLIME_BALL\ min-sell: 5\ buy: 0.2\ sell: 0.08\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#prior-lore)\ \ Prior lore:\ \ * Sets whether or not to prioritize item lore above default pricing lore\ \ * When enabled, will _prioritize_ item lore defined with [lore](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#lore)\ or [displaylore](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#displaylore)\ \ * When disabled, the item's pricing lore will be displayed on top of item lore\ \ * This defaults to _false_\ \ \ Copy\ \ pages:\ pages1:\ items:\ Mob5:\ material: SPAWNER\ spawner-type: SKELETON\ buy: 8000\ displaylore:\ - "&c--------------"\ - "&2A magic block which can spawn skeletons"\ - "&c--------------"\ prior-lore: true # Displaylore will be above the pricing lore\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#close-menu)\ \ Close menu:\ \ * Will close the shop GUI when this item has been purchased/sold\ \ \ Copy\ \ pages:\ pages1:\ items:\ Test1:\ material: STONE\ buy: 40\ stack-size: 128\ max-buy: 1 # Will enable quick-buy\ close-menu: true # Closes the menu when purchased\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#display-items)\ \ Display Items:\ \ * Display items are different then the actual item received upon buying/selling\ \ * Can be used to create a misleading shop item to trick players into buying a completely different item\ \ \ Copy\ \ pages:\ pages1:\ items:\ misleading_shopitem:\ material: APPLE\ buy: 2\ sell: 0.5\ displaylore:\ - '#FFC400&lA delicious apple'\ display-item:\ material: GOLDEN_APPLE\ displayname: '#FFC400&lA delicious apple'\ \ This item will appear as a golden apple in shop, but will be a regular apple when purchased.\ \ ### \ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#requirements)\ \ Requirements:\ \ * Sets a list format of requirements for this specific shop item\ \ * A player requires to meet all item requirement before they will be able to purchase/sell the item\ \ * Multiple requirements can be used on a single shop item, making it required for the player to meet all of the requirements\ \ * Since different requirements with the same type may have a different meaning from each other, especially placeholder requirements, it is possible to **set the lore/denied message per item requirement**!\ \ * Example of custom lore for a specific requirement:\ \ * ::::\ \ * The custom lore is shown on a shop item to let the player know they didn't met the item requirement\ \ * Multiple lore lines can be created using '\\n', example:\ \ * PLACEHOLDER::%player\_biome%==SWAMP::&cYou are not in the correct biome\\n&cThis item requires to be inside a %requirement% biome\ \ \ \ * Example of custom denied message for a specific requirement:\ \ * The custom denied message is send to the player upon clicking the shop item\ \ * A custom denied messsage is only supported on placeholder type requirements\ \ * ::::::\ \ \ \ \ A list of currently supported requirements is as follows:\ \ Requirements\ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#tab-requirements-1)\ \ Premium only requirements\ \ [](https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml#tab-premium-only-requirements)\ \ Type\ \ Description\ \ Format\ \ Format example\ \ World time\ \ Requires the time of the world the player is located in, to be inside the specified time range\ \ TIME::-\ \ TIME::08:00-14:45\ \ Quest\ \ Requires the player to complete a quest from a supported Quest plugin \*1\ \ QUEST::\ \ QUEST::bones-quest1\ \ Region\ \ Requires the player to be in a certain region from a supported region plugin \*2\ \ REGION::\ \ REGION::warp\_shop\ \ \*1 - Currently supported Quest plugins are [Quests by PikaMug](https://www.spigotmc.org/resources/quests.3711/)\ and [Quests by LMBishop](https://www.spigotmc.org/resources/quests-1-8-1-21-set-up-goals-for-players.23696/)\ \ \*2 - Currently supported region plugins are [WorldGuard](https://dev.bukkit.org/projects/worldguard)\ \ Type\ \ Description\ \ Format\ \ Format example\ \ Item\ \ Requires the player to have a specific item in its inventory\ \ ITEM::\ \ ITEM::material:tripwire\_hook name:&6Secret Key\ \ Player permission\ \ Requires the player to have/not have a certain permission\ \ PERMISSION::**!**\ \ PERMISSION::essentials.fly\ \ Player level\ \ Requires the level of the player to be higher or equal to the requirement\ \ LEVEL::\ \ LEVEL::35\ \ Player playtime\ \ Requires the player's playtime to be higher or equal to the requirement\ \ PLAYTIME::