https://github.com/QuickShop-Community/QuickShop-Hikari
QuickShop is a shop plugin that allows players to easily sell/buy any items from a chest without any commands. In fact, none of the commands that QuickShop provides are ever needed by a player.
https://github.com/QuickShop-Community/QuickShop-Hikari
Last synced: 6 days ago
JSON representation
QuickShop is a shop plugin that allows players to easily sell/buy any items from a chest without any commands. In fact, none of the commands that QuickShop provides are ever needed by a player.
- Host: GitHub
- URL: https://github.com/QuickShop-Community/QuickShop-Hikari
- Owner: QuickShop-Community
- License: other
- Created: 2022-02-12T07:08:31.000Z (over 4 years ago)
- Default Branch: hikari
- Last Pushed: 2026-08-03T00:03:31.000Z (7 days ago)
- Last Synced: 2026-08-03T02:08:35.755Z (7 days ago)
- Language: Java
- Homepage: https://modrinth.com/plugin/quickshop-hikari
- Size: 92.6 MB
- Stars: 150
- Watchers: 2
- Forks: 124
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
- awesome-minecraft - QuickShop-Hikari
README
[codacy]: https://www.codacy.com/gh/Ghost-chu/QuickShop-Hikari/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Ghost-chu/QuickShop-Hikari&utm_campaign=Badge_Grade
[codeFactor]: https://www.codefactor.io/repository/github/ghost-chu/quickshop-hikari
[codeScore]: https://app.codiga.io/public/project/32011/QuickShop-Hikari/dashboard
[license]: https://github.com/Quickshop-Community/QuickShop-Hikari/blob/hikari/LICENSE
[contributors]: https://github.com/Quickshop-Community/QuickShop-Hikari/graphs/contributors
[fossaStatus]: https://app.fossa.com/projects/git%2Bgithub.com%2FGhost-chu%2FQuickShop-Hikari?ref=badge_shield
[fossaStatusLarge]: https://app.fossa.com/projects/git%2Bgithub.com%2FGhost-chu%2FQuickShop-Hikari?ref=badge_large
[quickshop-hikari]: https://github.com/QuickShop-Community/QuickShop-Hikari
[qsh-doc]: https://quickshop-community.github.io/QuickShop-Hikari-Documents/
[quickshop-potato]: https://github.com/PotatoCraft-Studio/QuickShop-Reremake/
[quickshop-ghostchu]: https://github.com/Ghost-chu/QuickShop-Reremake
[quickshop-original]: https://github.com/KaiKikuchi/QuickShop
[codemc]: https://ci.codemc.io/job/Ghost-chu/job/QuickShop-Hikari/
[clearlagg]: https://www.spigotmc.org/resources/68271/
[worldguard]: https://dev.bukkit.org/projects/worldguard
[nocheatplus]: https://www.spigotmc.org/resources/nocheatplus.26/
[openinv]: https://dev.bukkit.org/projects/openinv
[modrinth]: https://modrinth.com/plugin/quickshop-hikari
[worldedit]: https://dev.bukkit.org/projects/worldedit
[optional_modules]: https://ci.codemc.io/job/Ghost-chu/job/QuickShop-Hikari/
[googlejava]: https://google.github.io/styleguide/javaguide.html
[adoptium]: https://adoptium.net/
[bStats-site]: https://bstats.org
[bStats-plugin]: https://bstats.org/plugin/bukkit/QuickShop-Hikari/14281
[codacyBadge]: https://app.codacy.com/project/badge/Grade/a04ef7174d9f4e65b60ae28b09222809
[codeFactorBadge]: https://www.codefactor.io/repository/github/ghost-chu/quickshop-hikari/badge
[codeScoreBadge]: https://api.codiga.io/project/32011/score/svg
[licenseBadge]: https://img.shields.io/github/license/Ghost-chu/QuickShop-Hikari.svg
[contributorsBadge]: https://img.shields.io/github/contributors/Ghost-chu/QuickShop-Hikari
[passedTests]: https://img.shields.io/jenkins/tests?compact_message&jobUrl=https://ci.codemc.io/job/Ghost-chu/job/QuickShop-Hikari
[fossaStatusBadge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FGhost-chu%2FQuickShop-Hikari.svg?type=shield
[fossaStatusImageLarge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FGhost-chu%2FQuickShop-Hikari.svg?type=large
[JavaVersion]: https://img.shields.io/badge/Java-Versions_21+_-orange.svg
[MinecraftVersion]: https://img.shields.io/badge/Minecraft-Java%20Edition%201.20%2B-blueviolet
[bStatsImage]: https://bstats.org/signatures/bukkit/QuickShop-Hikari.svg
[Ver]: https://img.shields.io/modrinth/v/ijC5dDkD?label=version
# QuickShop-Hikari
[![codacyBadge]][codacy]
[![codeScoreBadge]][codeScore]
[![licenseBadge]][license]
[![contributorsBadge]][contributors]
![passedTests]
[![fossaStatusBadge]][fossaStatus]
![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 ([QuickShop-Community/QuickShop-Hikari][quickshop-hikari]) is a fork
from [PotatoCraft-Studio's version][quickshop-potato] which itself is a fork from the [Reremake][quickshop-ghostchu] of
the [original QuickShop][quickshop-original].
Visual example
```
KaiKikuchi/QuickShop
└── Ghost-chu/QuickShop-Reremake
└── PotatoCraft/QuickShop-Reremake
└── QuickShop-Community/QuickShop-Hikari # <-- We are here
```
QuickShop Hikari was originally maintained by Ghost-Chu but has later been given to creatorfromhell and put under the
QuickShop-Community Organisation.
It has the goal to modernize the core content of QuickShop and adapt it to the latest versions of Minecraft.
## Community & Support
- [Discussions](https://github.com/Quickshop-Community/QuickShop-Hikari/discussions)
- [Bug Tracker](https://github.com/Quickshop-Community/QuickShop-Hikari/issues)
- [Discord](https://discord.gg/Bu3dVtmsD3)
- [QQ Group:`966701484`](https://qm.qq.com/q/iDp63bZBSg)
## 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/PacketEvents 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.
- 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][modrinth]
## Automated System Restrictions
This repository is subject to the terms in EULA.md.
Access and use by AI agents, automated code-generation systems,
machine-learning systems, and automated analysis tools is prohibited
without explicit written permission.
## Compatibility Modules
You can download optional modules [here][modrinth] for compatibility with other plugins.
Feel free to explore additional compatibility modules in our [Wiki][qsh-doc].
## 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](.contributing/contributing.md) 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.
Please be aware of any requirements outlined in the projects's GPLv3 and AGPLv3 licenses.
If you make good changes to the project would we apreciate Pull requests for them to merge.
### Compile and Debugging
To compile and debug QuickShop, please do the following steps:
1. Make sure you're using Java 21. You can get the latest Java versions from the [Adoptium project][adoptium].
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 Java21+ 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][bstats-site].
You may opt-out by setting `privacy.type.STATISTIC` and `privacy.type.RESEARCH` to `true` in the config.yml.
[![bStatsImage]][bStats-plugin]
## License
Quickshop-Hikari is dual licensed under GPLv3 and AGPLv3. New contributions will follow the updated license of AGPLv3.
[![fossaStatusImageLarge]][fossaStatusLarge]
## Developer API
QuickShop-Hikari offers an API for you to use features such as retrieving active shops of a player.
### Maven
```xml
codemc
https://repo.codemc.io/repository/maven-public/
com.ghostchu
quickshop-bukkit
VERSION HERE
provided
shaded
```
### Gradle
```groovy
repositories {
maven { url = "https://repo.codemc.io/repository/maven-public/" }
}
dependencies {
compileOnly "com.ghostchu:quickshop-bukkit:VERSION HERE"
}
```
### Hook into the API
```java
public class MyPlugin extends JavaPlugin {
@Override
public void onEnable() {
QuickShopAPI api = QuickShopAPI.getInstance();
QuickShop instance = QuickShopAPI.getPluginInstance();
QuickShop anotherWayToGetInstance = QuickShop.getInstance();
}
}
```