Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artulloss/hotbar
A versatile and fully featured hotbar plugin for PMMP!
https://github.com/artulloss/hotbar
hotbar mcbe mcpe plugin pocketmine-mp-plugin pocketmine-plugins
Last synced: 2 months ago
JSON representation
A versatile and fully featured hotbar plugin for PMMP!
- Host: GitHub
- URL: https://github.com/artulloss/hotbar
- Owner: artulloss
- License: mit
- Created: 2018-10-12T16:10:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-09T20:02:53.000Z (almost 3 years ago)
- Last Synced: 2024-09-26T10:21:37.978Z (3 months ago)
- Topics: hotbar, mcbe, mcpe, plugin, pocketmine-mp-plugin, pocketmine-plugins
- Language: PHP
- Homepage:
- Size: 2.01 MB
- Stars: 16
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://poggit.pmmp.io/p/Hotbar)
[](https://poggit.pmmp.io/p/Hotbar)
# Hotbar
A versatile and full featured hotbar plugin! Add items and make them execute commands, on any world!
## Configuration
The [default configuration](https://github.com/artulloss/Hotbar/blob/master/resources/config.yml) provides lots of help setting up the plugin!
#### Hotbars
Hotbars are inventory containers for the slots 1-9, you can define them in the config.yml file, and make them automatically appear in worlds using the Worlds part of the configuration.
```yaml
Worlds: # Here you can specify hotbars above and pair them with worlds
world: UniqueHotbarName
```
If you don't have them automatically appear, you can still call them by calling the command `hotbar {identifier} {player}`
*Note that this command can only be called by the console*
#### Command format
For every item you need to add commands in order to do things.
This plugin accepts multiple commands per tap, and they will be executed in the order that they're listed in.
Commands are listed in the format of commandToExecute@executor where executor must be either player, op or console.
You can also leave out the @executor part for most commands by specifying a default way for them to be run using the Default Command Options part of the config.
```yaml
Default CommandOptions: player # or op or console
```
#### Replaceable in commands
You can use these in your commands to make references to the player!
These are capitalization sensitive, so make sure to type them as shown here!
```
{player} IGN of the player
{tag} Name tag of the player
{level} The players level
{x} The players X
{y} The players Y
{z} The players Z
```
#### Locking Inventories
You may wish to block a player from modifying their inventory when they have a hotbar, the "Locked Inventory" part of the config allows for this:
```yaml
Locked-Inventory:
- example
- world
```
Locked inventories are unable to have items moved in them, and players with locked inventories can't pickup items or arrows.
*Note that items will be locked until the Hotbar is removed from the player.*
#### The Hotbar Command
Previously, the hotbar command could only be used by the console, however now there is "hotbar" permission that allows a user to access the command.
There are a few uses of the hotbar command.
To remove a hotbar simply type the command
```
hotbar {clear} {player}
```
where player is the players name. The brackets around clear are to make sure you don't name a world that by mistake, in which case it will clear rather than send the hotbar. This will also unlock the players inventory and allow them to move items.
To send a hotbar to a player you can use the command like so
```
hotbar {hotbarName} {player}
```
Where {hotbarName} represents the name of the hotbar and {player} is the players name (leave out the brackets here)
You are also able to list all hotbars using the list argument:
```
hotbar {list}
```
#### Cooldown
The cooldown is to "fix" the player interact spam bug, which is a client side issue on Windows 10, I recommend the default value, but you can set it as high/low as you'd like.
#### API
This plugin comes with a full API and allows for the creation of Hotbars that use closures to execute code as well as hotbars that execute commands. To make use of this a plugin would simply need to create a new ClosureHotbar or CommandHotbar and then do
```php
// Make sure $player is an instance of the Player class
$player->getServer()->getPluginManager()->getPlugin('Hotbar')->getHotbarUsers()->assign($player, $hotbar);
```
#### Plugin extensions
Make a plugin that uses the API from this? Open an issue and I'll add it to the list
So far:
- [FloatingHotbar](https://github.com/artulloss/FloatingHotbar) makes the item you're holding float in front of you
#### Demo of this plugin
To see this plugin in action, you can join my server: versai.pro 19132
#### Support?
Add Discord: adam#9876