Upstream
/
ShopChest
mirror of https://github.com/EpicEricEE/ShopChest.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Page: Home
Pages
Configuration Developer API Home
1 Home
Eric B edited this page 2020-03-01 18:26:51 +01:00
Table of Contents

Icon

Build Status

ShopChest is a command based chest shop plugin. Buying and selling is done simply by clicking the chest. A hologram above it displays all sorts of information about the shop. Due to the large amount of possible customization, this plugin can fit every server.

Why ShopChest?

  • Very simple shop interaction and creation
  • No struggle with complex attributes or flags, it just copies the item in your hand
  • Visually pleasing with hologram and floating item
  • Shops are protected from explosions and hoppers
  • Floating items are protected from water, lava, pistons, zombies, getting picked up, despawning and ClearLag (and similar)
  • Supports almost every protection plugin available including WorldGuard, Towny, PlotSquared, etc.
  • Everything is translatable
  • Support for MySQL and SQLite including logging capabilities
  • Vault integration for economy and permissions
  • Extensive list of configurable options

Installation

  • Download the latest stable version of this plugin, or get a possibly unstable development build with the latest feature set here
  • Put the downloaded file into your server's plugins folder
  • Install the latest version of Vault
  • Install an economy plugin that hooks into Vault (e.g. Essentials, AConomy, SaneEconomy, etc.)
  • After starting the server, a folder called ShopChest is created in the plugins folder, containing the configuration files and shop database

Usage

A complete guide on how to use the plugin's features can be found here.

  • By default, a player can buy from a shop by right-clicking the chest, and sell to a shop by left-clicking the chest.
    • When the player is sneaking while clicking the chest, a stack of the product is bought or sold at once.
  • A player can create a shop by entering the command /shop create <amount> <buy-price> <sell-price> and clicking a chest they are permitted to create a shop on. Usually, that is any chest they can open.
    • The item that the player is holding in their hand will become the product of the shop
    • <amount> is the amount of items that can be bought or sold at once
    • <buy-price> is the price, a player pays for buying the product from the shop
    • <sell-price> is the price, the vendor pays for buying the product from the player
  • A player can remove a shop by entering the command /shop remove and clicking one of their shops.
  • A player can retrieve more information about a shop by entering /shop info and clicking a shop, or by clicking a shop with the configured shop info item (a stick by default)

Configuration

Information about the plugin's customization possibilities can be found in the configuration documentation.

For Developers

ShopChest artifacts are hosted on the CodeMC maven repository

<repositories>
    <repository>
        <id>codemc-repo</id>
        <url>https://repo.codemc.io/repository/maven-public/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>de.epiceric</groupId>
        <artifactId>ShopChest</artifactId>
        <version>1.13-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

For more information about the ShopChest API, check the documentation or the javadoc.