Add Shopkeepers to your PocketMine-MP world! Allow the creation of simple barter stores between players or create adminshops!
Follow me on Twitter to remain updated!
- Players can create their own Shopkeepers and manage it
- Admin Shopkeepers
- Vanilla trade page
- Shopkeeper inventory for non-admin Shopkeepers
- Hit prevention for shopkeepers
- Easy configuration with in-game GUI
- Double trade supported
- Custom skin support
- Plugin APIs
Please consider to
Warning As of v1.2 we no longer support PocketMine-MP 4, this however does not mean that we will remove v1.0 for PMMP4, in fact it will always remain available here on GitHub at this branch!
The configuration of Shopkeepers allows you to customize some values to make it suitable for all servers.
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | bool | true | Is the plugin enabled? |
| max-entities-for-player | int | 3 | Max shopkeeper's entities for one player (PER SHOP) |
| max-entities-bypass | array | [] | Player that can bypass this limitation |
| banned-shop-names | array | [] | List of banned names |
| banned-item-names | array | [] | List of banned items (can't be sold) |
| banned-item-ids | array | [] | List of banned item ids (can't be sold) |
| enable-remote-trade🛈 | bool | false | Allow player to use the /sk trade command |
| enable-pmmpstats-datashare | bool | true | Allow the server to share some data with pmmpStats |
| enable-version-checker | bool | true | Allow the server to check the plugin version |
The base command is /shopkeepers but you can also use /sk, /skeepers and /shopk as aliases.
Here a list of all commands that you can use:
| Command | Args | Description |
|---|---|---|
| info | none | Show the plugin's informations |
| info | SHOP NAME | Show the shop configuration page |
| edit | SHOP NAME | Edit the shop recepies |
| create | SHOP NAME / NULL | Create a new shop, if the name is leaved empty will be generated |
| summon | SHOP NAME | Summon a Shopkeeper entity (as a Villager) for your Shop |
| rename | SHOP NAME and NEW NAME | [NOT AVAILABLE] Rename a current shop |
| list | none | Show all of your shops |
| history | SHOP NAME and PAGE | Show the trade history for the shopkeeper |
| trade | SHOP AUTHOR NAME and SHOP NAME | Remotely trade with a shopkeeper |
This plugin makes use of pmmpStats to create and process plugin statistics, which then includes a continuous sending of the following information to the service servers:
- Server IP and port
- Server OS version
- Server PHP version
- Server cores
- Server PocketMine-MP version
- Server version (minecraft)
- Online players
- Server Xbox auth status
The Terms of Service of pmmpStats are available here, instead the privacy polici is at this link.
You can disable information sharing with pmmpStats by setting the enable-pmmpstats-datashare value to false, by default (so even if the value is not present) it is enabled.
Yes, the v1.0 brought an epic function: now you can set a skin of a Shopkeeper.
Unfortunately players can't add a skin of a Shopkeeper for multiple reasons:
- Memory
- Memory
- Memory
- Hmm, Memory?
Anyways, to avoid abuse of this system we have made this feature usable only by the server administrator.
You should have seen something new in the Shopkeepers folder, the skins folder, and that is where all the skins should be put.
Warning
Skins MUST BE in a.pngfile!
The file name should be composed as follows: <PLAYER NAME>_<SHOP NAME>.png, for example FoxWorn3365_Fox.png is valid and will be used by the plugin.
Well, if no skin is provided the classic villager is spawned. yeee
Shopkeepers from the v1.3 implements the APIs.
$api = FoxWorn3365\Shopkeepers\Core::$api;$api->getConfigManager(Player $player) : FoxWorn3365\Shopkeepers\ConfigManager$api->getConfig(Player $player, string $shopName) : object|array|bool$api->openTradeInventoryForPlayer(Player $player, string $shopOwner, string $shopName) : void$api->setConfig(Player $player, string $shopName, object $config) : void$api->summonShopkeeper(Player $player, string $shopName) : voidThere is not really an Admin shop but you can activate this function by using the command /sk info <SHOP NAME> and then clicking on the Blaze Powder and then clicking on the red wool block that has "Admin shop" as its name
There are two ways:
- Use the command
/sk info <SHOP NAME>and then click on the chest! - Click on the Shopkeeper (Villager) entity and then click on the chest!
I want to access to the Shopkeeper's trade page but if i click the entity i access the shopkeeper's info page!
Easy: shift and click on the Shopkeeper
More easy: just hit it, it will die in only one hit!
I have ClearLag and it removes the Shopkeepers entites!
Edit the config of ClearLag changing to false this option.
We actually support a Skin System, please see here!
If the Shopkeeper is an Admin Shop it does not have an inventory!
The v1.2 implements an incredible customization system: 🎉__programming!__🎉
So, from now you can handle some Shopkeeper event! but how?
Simple, you can code inside the config with the new parser YAMLPower!
Feel free to contact me with no problem for any questions, I'll respond within a day!
Here will be listed every feature of the plugin who's not stable (so is in a BETA phase).
These features aren't active by default, you must edit the config to enable!
Remote trade is in a BETA phase because can use a lot of memory and CPU and can slow down the server.
Enable the enable-remote-trade at your own risk!
Reporting bugs to developers to the developer😢 is very important to ensure the stability of the plugin, so in order to better track and manage all reports it is incredibly necessary that they are reported via GitHub Issues.
Here is what to include in the reporting to make it perfect:
- The complete crash error
If it is not complete how do we know how it all happened?
- All files from the
plugin_data/Shopkeepersfolder
This way we can compare the error with those files to find a possible transcription error
- The plugin's version
It changes a lot from version to version, and this would help us a lot to understand where to look for
- (OPTIONAL) The plugin download source
Knowing where you downloaded the plugin from might help, always better to know some information
- (OPTIONAL) The
Shopkeepers.phar
"Last wade", in case we can analyze the source
Any contribution is greatly appreciated because you help me to lighten my workload, so here are some small guidelines to follow when you want to contribute:
- Clear code
I don't want to see things like this:
class Fox {
protected $fox; // WHAT'S THE TYPE?????'?'Q'2'wqiadw sdfbuhwhwrf jhs
function create($int, $bruh) { $bruh = 10-$int+$bruh; // AAAAAAAAAA. IT'S A PUBLIC, PRIVATE OR PROTECTED FUNCTION?!?!??!?
return $bruh; // AND WHAT'S THE RETURN TYPE???? AND WHY THE CODE IS IN THE FIRST LINE????????
}
}- Update the "headers" of the file correctly
They allow new contributors to understand what the file is for without having them parse 250 lines, so update them with the true purpose of the file!
// CORRECT:
/*
* Shopkeepers for PocketMine-MP
* Add custom shopkeepers to your PocketMine-MP server!
*
* Copyright (C) 2023-now FoxWorn3365
* Relased under GNU General Public License v3.0 (https://github.com/FoxWorn3365/Shopkeepers/blob/main/LICENSE)
* You can find the license file in the root folder of the project inside the LICENSE file!
* If not, see https://www.gnu.org/licenses/
*
* Useful links:
* - GitHub: https://github.com/FoxWorn3365/Shopkeepers
* - Contribution guidelines: https://github.com/FoxWorn3365/Shopkeepers#contributing
* - Author GitHub: https://github.com/FoxWorn3365
*
* Current file: /EntityManager.php
* Description: Load and save custom entities into and from a simple string
*/
// WRONG:
/*
* Shopkeepers for PocketMine-MP
* Add custom shopkeepers to your PocketMine-MP server!
*
* Copyright (C) 2023-now FoxWorn3365
* Relased under GNU General Public License v3.0 (https://github.com/FoxWorn3365/Shopkeepers/blob/main/LICENSE)
* You can find the license file in the root folder of the project inside the LICENSE file!
* If not, see https://www.gnu.org/licenses/
*
* Useful links:
* - GitHub: https://github.com/FoxWorn3365/Shopkeepers
* - Contribution guidelines: https://github.com/FoxWorn3365/Shopkeepers#contributing
* - Author GitHub: https://github.com/FoxWorn3365
*
* Current file: /EntityManager.php
* Description: Idk make entites ez
*/utilsis reserved for Static functions and final classes
All functions in
utilsmust have all static methods and all static classes must be in that directory and namespace
- Please DESCRIBE your changes in the pull request!
I want to understand it
permissions:
shopkeepers.base:
description: "Allows users to use the base command"
default: true
shopkeepers.shop.summon:
description: "Allows users to summon player's shop"
default: true
shopkeepers.shop.create:
description: "Allow users to create a shop"
default: true
shopkeepers.shop.edit:
description: "Allow users to edit they'r shop"
default: true
shopkeepers.shop.list:
description: "Allow users to see a list of their shops"
default: true
shopkeepers.shop.remove:
description: "Allow users to despawn they'r Villager shops"
default: true
shopkeepers.shop.rename:
descritpion: "Allow users to rename they'r shops"
default: true
shopkeepers.shop.namevisible:
description: "Allow users to decide if the shopkepeer's name should be visible or no"
default: true
shopkeepers.shop.history:
description: "Allow users to view the trade history of his Shopkeepers"
default: true
shopkeepers.shop.enableDisable:
description: "Allow users to enable and disable their own Shopkeepers from the menu"
default: true
shopkeepers.shop.admin:
description: "Allows users to decide if the shopkeepers should be admin or none"
default: op
shopkeepers.shop.kill:
description: "Allow users to kill every shopkeepers, also of other players"
default: op
shopkeepers.shop.defaultGUI:
description: "Allow users to see and use the /sk command without args to open the base GUI"
default: true
shopkeepers.shop.use:
description: "Allow users to use a shopkeeper when they touch it"
default: true
shopkeepers.shop.allowRemoteInventoryOpen:
description: "Allow users to open a shopkeeper's inventory with the command /sk inventory"
default: op
shopkeepers.shop.allowRemoteTrade:
description: "Allow users to remotely trade with a shopkeeper with the command /sk trade <author> <shop>"
default: trueThe plugin needs to save store data, and unlike other plugins, it uses .json files so they are more accessible to server owners, so here is the structure.
As a reminder, the plugin saves each player's data in separate files, so there will be a PlayerName.json for each player that creates a shop.
Now, let's see the object:
{
"author":"<PlayerNAME>",
"enabled":true,
"admin":false,
"title":"<ShopNAME>",
"namevisible":false,
"history":base64EncodedHistoryOfTransactions,
"inventory":[],
"items":[
{
"buy":nbtSerializedItem,
"buy2":?nbtSerializedItem,
"sell":nbtSerializedItem
}
]
}| Name | Type | Description |
|---|---|---|
| author | string | The username of the shop author |
| enabled | bool | Is the shop enabled? This option can be changed by the player in the menu config |
| admin | bool | If the shop is an Admin shop, so you don't have to put items in the inventory and you won't earn anything |
| title | string | The real name of the shop |
| namevisible | bool | Should the shop name be visible when summoned? |
| history | string | A base64 encoded string with all the transactions |
| inventory | array | The inventory of the shop |
| items | array | A list of all recepies (max 9) |
Thanks to Muqsit for the InvMenu virion who have contributed to the creation for this plugin!
Also this plugin helped me!
You can contact me via:
- Discord:
@foxworn - Email:
foxworn3365@gmail.com