Minecraft GUI Shop Plugin

A Spigot plugin to allow Minecraft servers to easily create in-game GUI shops

Problem


This project initially started when some friends were unhappy with other GUI shop plugins, either because they were too clunky, non-free options, or just simply didn't do what they wanted.


Objectives


📝 Create an extensive system to allow users to easily configure in game shops, allowing them to set categories, choose which items to sell, and set prices

🛒 Present the shop in an appealing and easy to use GUI in-game

⚙️ Provide additional features to make the experience better for players, such as automation capabilities

⬆️ Ensure the plugin is backwards compatible with every popular Minecraft version


How it works


The plugin uses a system of YAML configuration files to structure the in-game shop. These are designed to be readable and easy for users to tweak. Each category has its own file, containing its settings and any items that should be sold in that category.

Internally, the plugin makes use of Maven to easily adjust code depending on which Minecraft version the user's server is running. This is an important detail as some players prefer older versions, and this allows everyone to use the same .jar file, regardless of version.

Additional features were added to enrich both the player and admin experience, including:

  • Quick sell options that check the player's inventory for any sellable items
  • Shortcut commands to quickly open to a specific category in the shop
  • Chests that players could place in the world, that would periodically be queried to sell their contents, allowing players to automate income from farms
  • The ability to make categories permission-based, allowing for special shops only accessible to donator ranks for example


Tools


JavaSpigotYAMLMaven

See it in action



Built with Gatsby, Netlify CMS, and Bulma by newtjam.

Check out the specifics here.