Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nglam2911/invcraft
A 6x6 crafting table plugin with customable recipe.
https://github.com/nglam2911/invcraft
pocketmine-mp pocketmine-mp-plugin
Last synced: about 21 hours ago
JSON representation
A 6x6 crafting table plugin with customable recipe.
- Host: GitHub
- URL: https://github.com/nglam2911/invcraft
- Owner: NgLam2911
- License: mit
- Created: 2020-12-27T04:34:06.000Z (almost 4 years ago)
- Default Branch: rewrite
- Last Pushed: 2024-09-03T15:16:09.000Z (24 days ago)
- Last Synced: 2024-09-26T10:21:38.732Z (about 21 hours ago)
- Topics: pocketmine-mp, pocketmine-mp-plugin
- Language: PHP
- Homepage:
- Size: 929 KB
- Stars: 15
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Invcraft - A 6x6 crafting table plugin for PocketMine-MP
Feel free to report any bugs or suggest new features in [Issues](https://github.com/NgLam2911/InvCraft/issues)
# Command & Permission
## Command
- `/invcraft` - Open InvCraft main menu
- aliases: `/ic`
- permission: `ic.command`
## Permission
- `ic.command` - Allow player to use `/invcraft` command including view and craft items
- `ic.admin` - Allow player to use add, edit, remove recipes (will show additional options in menu for admin)
# News in this version
- [X] MySQL, SQLite database support.
- [X] Multi-pattern matching like vanilla crafting table.
- [X] Work with any items, including custom items (if you have a plugin that can create custom items).
# Planned for future update
- [ ] Languages support
- [ ] Custom ingredients, result process
- [ ] Any meta match, EX: Any planks
- [ ] Transfer NBT from ingredients to result
- [ ] Custom, advanced API for developers
And more...
# Build from s a u c e
You can use pharynx to build this plugin, if pharynx is in your server path and you have cloned this repo into your plugins folder, you can use following cmd:
```bash
php -dphar.readonly=0 pharynx.phar -c -i plugins/InvCraft -p=plugins/InvCraft.phar
```
or you can find the lastest build in [Poggit](https://poggit.pmmp.io/ci/NgLam2911/InvCraft/InvCraft)
### This rewrite version is NOT compatible with the old version, i currently dont have any idea for converting old recipes to the new format, so you have to create them again.
# For developers (API Doc)
## Recipes API
```php
use NgLam2911\InvCraft\crafting\Recipe;
use NgLam2911\InvCraft\InvCraft;
$recipeManager = InvCraft::getInstance()->getRecipeManager();
// Create a new recipe
$recipe = new Recipe();
$recipeManager->addRecipe($recipe);
// Remove a recipe
$recipeManager->removeRecipe();
// Get a recipe
$result = $recipeManager->getRecipe();
```
## Handle when a player craft an item
```php
use NgLam2911\InvCraft\event\InvCraftItemEvent;
// EventsListener.php
public function onCraft(InvCraftItemEvent $event) {
$player = $event->getPlayer();
$recipe = $event->getRecipe();
$result = $event->getResult();
// Do something here
}
```