Skip to content

Latest commit

 

History

History
271 lines (174 loc) · 9.09 KB

README.md

File metadata and controls

271 lines (174 loc) · 9.09 KB
Raw

QuickShop-Hikari

codacyBadge codeScoreBadge licenseBadge contributorsBadge passedTests fossaStatusBadge

JavaVersion MinecraftVersion Ver

Introduction

QuickShop Hikari is a Shop plugin that allows players to create Chest Shops to easily sell and buy items, without the need for any commands.
In fact, all commands in QuickShop are not even needed for normal gameplay.

This version of QuickShop (Ghost-chu/QuickShop-Hikari) is a fork from PotatoCraft-Studio's version which itself is a fork from the Reremake of the original QuickShop.

QuickShop Hikari is maintained by Ghost-Chu and has the goal to modernize the core content of QuickShop and adapt it to the latest versions of Minecraft.

Community & Support

Discussions
Bug Tracker
Discord

Features

  • Easy to use
  • Toggleable Display Item on top of the chest.
  • NBT Data, Enchantment, Tool Damage, Potion, and Mob Egg support.
  • Unlimited chest support.
  • Blacklist support & bypass permissions.
  • Shops that buy and sell items at the same time (Using double chests).
  • Customizable permission checks.
  • UUID support.
  • Better shop protection.
  • i18n support for displayed Item names.
  • i18n support for displayed Enchantment names.
  • A cool item preview.
  • World/region protection plugins support.
  • ProtocolLib based Virtual Display Item support.
  • Powerful API.
  • Optimized performance.
  • MiniMessage syntax support.
  • H2 (local) or MySQL (remote) datasource support.
  • Supports custom inventory! Use the InventoryWrapper API.
  • Optimized for Paper, but also runs on Spigot (Though slower and with a more "hacky" approach).
  • Advanced Transaction System. Undo any Inventory/Economy operation with a shop when it failed to prevent duplications and exploits.
  • Per-shop permission management.
  • Shop benefits between shop owner and other players!
  • And much much more!

Downloads

Obtain the latest version from Modrinth

Compatibility Modules

You can download optional modules here for compatibility with other plugins.

ClearLagg

  • Stops clearlagg from deleting the Display Item on any Shop.

NoCheatPlus

  • Prevents NCP's anti-cheat checks from triggering when creating a shop.

OpenInv

  • Allow the usage of a Player's Ender Chest as Shop inventory by using /quickshop echest.

Worldedit

  • Removes Shops that got deleted during a WorldEdit operation, to reduce "Ghost Shops".

Worldguard

  • Flag-based shop control.

Contributing

Contributions to QuickShop-Hikari are welcome and encouraged! Whether you're fixing a bug, adding a new feature, or improving documentation, we would love your help.

However, to ensure the project stays consistent and manageable, we ask that you follow our contributing guidelines before submitting a pull request.

Please make sure to:

  • Sign the Contributor License Agreement (CLA) if this is your first contribution when it appears in the Pull Request.
  • Follow the coding standards and branch naming conventions outlined in the guidelines.
  • Use the required IntelliJ plugins like Final Obsession, and Lombok for code quality and consistency.

Thank you for your contributions!

Distributing forks

You're allowed to create your fork to share. No permission is needed.
Though it would be nice if you could pull-request your changes into this repository when they are good ones.

Compile and Debugging

To compile and debug QuickShop, please do the following steps:

  1. Make sure you're using Java 17 or 18. You can get the latest Java versions from the Adoptium project.
  2. Compile the main project without a signature by using mvn install -Pgithub with the GitHub Profile selected.
  3. Put the compiled jar into your Test-server's plugins folder, start the server and begin debugging!

To compile the QuickShop and debug it by yourself, please follow these steps:

  1. Make sure you're using Java17+ JDK in your PATH.
  2. Compile main-project without signature by using profile: mvn install -Pgithub with github profile selected.
  3. Start your server and go on.

bStats

QuickShop-Hikari collects certain statistic through bStats.
You may opt-out by setting disabled-metrics to true in the config.yml.

bStatsImage

License

Quickshop-Hikari is dual licensed under GPLv3 and AGPLv3. New contributions will follow the updated license of AGPLv3.

fossaStatusImageLarge

Developer API

QuickShop-Hikari offers an API for you to use features such as retrieving active shops of a player.

Maven

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

<dependencies>
<!-- QuickShop Main Module -->
<dependency>
    <groupId>com.ghostchu</groupId>
    <artifactId>quickshop-bukkit</artifactId>
    <version>VERSION HERE</version>
    <scope>provided</scope>
    <classifier>shaded</classifier>
</dependency>
</dependencies>

Gradle

repositories {
    maven { url = "https://repo.codemc.io/repository/maven-public/" }
}

dependencies {
  compileOnly "com.ghostchu:quickshop-bukkit:VERSION HERE"
}

Hook into the API

public class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        QuickShopAPI api = QuickShopAPI.getInstance();
        QuickShop instance = QuickShopAPI.getPluginInstance();
        QuickShop anotherWayToGetInstance = QuickShop.getInstance();
    }

}

Repository Activity

analytics