Shopkeepers

⚠️ We are not in any way related to the Shopkeepers plugin for Bukkit!

Introduction video

Watch the video on YouTube

Features

• Players can create theyr 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

Compatibility

Shopkeepers is made to be multi-version, in fact I announce with great joy that the plugin is available for both PocketMine-MP 5 and PocketMine-MP 4!

Warning
The Shopkeepers version for PocketMine-MP 4 is available exclusively here on GitHub since InvMenu has versions that are not compatible with each other! The branch can be found here

Commands

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:

F.A.Q.

How to create an Admin shop

There 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

How to see a Shopkeeper's inventory

There are two ways:

• Use the command /sk info <SHOP NAME> and then click on the chest at the center of the GUI
• Click on the Shopkeeper (Villager) entity

I want to access to the Shopkeeper's trade page but if i click the entity i access the inventory!

Easy: shift and click on the Shopkeeper

How to despawn a Shopkeeper

More easy: just hit it, it will die in only one hit!

Bug reporting

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:

1. The complete crash error

If it is not complete how do we know how it all happened?

2. All files from the plugin_data/Shopkeepers folder

This way we can compare the error with those files to find a possible transcription error

3. 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

4. (OPTIONAL) The plugin download source

Knowing where you downloaded the plugin from might help, always better to know some information

5. (OPTIONAL) The Shopkeepers.phar

"Last wade," in case we can analyze the source

Contribution guide

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 TYPEjQuery321030619179516671513_1687468620179???'?'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
 */

• utils is reserved for Static functions and final classes

All functions in utils must 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

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.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

Developers: shop object

The 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>",
    "admin":false,
    "title":"<ShopNAME>",
    "namevisible":false,
    "inventory":[],
    "items":[
        {
            "buy":nbtSerializedItem,
            "sell":nbtSerializedItem
        }
    ]
}

Special thanks

Thanks to Muqsit for the InvMenu virion who have contributed to the creation for this plugin!
Also this plugin helped me!

Roadmap

• [x] Update the item object because now it's the old one
• [x] Make if the ContainerClose packet is received unset the $this->trades->{PLAYER} object because otherwise is OP!
• [x] Updated the item object with nbt
• [x] Working Admin shop (without inventory)
• [x] Inventory saving correctly
• [x] Player shop
• [x] Shopkeeper's inventory updating when players buy
• [x] Shopkeeper deny a trade if the inventory is without the item
• [ ] Online shopkeeper editor
• [ ] Online shopkeeper shop (yes, you will be able to make shopping from your phone on the subway!)

Contacts

You can contact me via:

• Discord: @foxworn
• Email: [email protected]