Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shock95/auctionhouse
Feature-packed auction house plugin for PocketMine-MP (pmmp)
https://github.com/shock95/auctionhouse
auction-house auctionhouse minecraft pmmp pocketmine pocketmine-mp
Last synced: about 1 month ago
JSON representation
Feature-packed auction house plugin for PocketMine-MP (pmmp)
- Host: GitHub
- URL: https://github.com/shock95/auctionhouse
- Owner: Shock95
- License: gpl-3.0
- Created: 2020-01-02T00:55:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T20:44:16.000Z (7 months ago)
- Last Synced: 2024-10-09T23:04:16.173Z (about 1 month ago)
- Topics: auction-house, auctionhouse, minecraft, pmmp, pocketmine, pocketmine-mp
- Language: PHP
- Size: 658 KB
- Stars: 43
- Watchers: 7
- Forks: 35
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AuctionHouse [](https://poggit.pmmp.io/p/AuctionHouse) [](https://poggit.pmmp.io/p/AuctionHouse)
Feature-packed AuctionHouse plugin for PocketMine-MP
## Overview
AuctionHouse allows players to list their items for sale and purchase items that others have listed for sale
---
## Features
>- Chest GUI
>- Admin tools
>- Categories
>- Config (See below)
>- Multi-lang support
>- Cancel listings
>- Listing cooldown
>- Custom events
>- Economy plugin support
>- MySQL and SQLite database support
>- Custom listings limit per player (See permissions)
>- Customizable messages
---
## Download
Download the plugin from [Poggit](https://poggit.pmmp.io/p/AuctionHouse) or [GitHub releases](https://github.com/Shock95/AuctionHouse/releases)
---
## Config
Click to open
```yaml
---
# DO NOT EDIT THIS VALUE, INTERNAL USE ONLY.
config-version: 5
# Sets the prefix for this plugin.
prefix: "[&l&6Auction House&r]"
# Minimum price required to create a listing
min-price: 0
# Maximum price a listing can have (-1 = No limit)
max-price: -1
# Sets the default language for the plugin, you can edit text and messages in this file.
default-language: en_US
# Sets the amount of hours a listing is active before being automatically cancelled and expired.
expire-interval: 48
# Sets the price it costs to list an item on the auction house.
listing-price: 0
# Sets a cooldown between listing items in seconds
listing-cooldown: 0
# Allows or blocks players in creative mode from selling items.
creative-sale: false
# Maximum amount of listings a player can have by default
max-listings: 45
# Shows item lore on the auction house
show-lore: true
# Days to automatically delete expired listings (0 to disable)
expired-duration: 15
# Formats price with commas (ex. 1,000,000)
price-formatted: true
# Items that cannot be listed on the auction. Refer to https://minecraftitemids.com/ or https://minecraft-ids.grahamedgecombe.com/ for a list of item ids.
blacklist:
- '1000' # Example items
- '1234:5'
- 'minecraft:air'
# AH sign triggers
sign-triggers:
- "[AuctionHouse]"
- "[AH]"
# Menu button items
buttons:
stats: "minecraft:chest"
back: "minecraft:paper"
previous: "minecraft:paper"
next: "minecraft:paper"
info: "minecraft:book"
howto: "minecraft:emerald"
return_all: "minecraft:redstone_block"
player_listings: "minecraft:diamond"
expired_listings: "minecraft:poisonous_potato"
admin_menu: "minecraft:redstone"
confirm_purchase: "minecraft:stained_glass_pane:5"
cancel_purchase: "minecraft:stained_glass_pane:14"
...
```
---
## Commands
| Command | Description |
|---------------------------------|:------------------------------------------------------------------------------------|
| /ah | AuctionHouse main command, opens the shop menu if there are no specified parameters |
| /ah shop | Opens the shop menu |
| /ah sell **[price]** | Allows player to sell an item on the auction house |
| /ah listings | Shows all active listings of the player |
| /ah listings **[player]** | Allows player to see active listings of a specific player |
| /ah category | Allows player to open the category menu |
| /ah admin | Allows player to open the admin menu (OP Command) |
| /ah admin relistall | Allows player to relist all items in the auction house (OP Command) |
| /ah admin returnall | Allows player to return all items in the auction house back to players (OP Command) |
| /ah admin listings **[player]** | Allows player to see all listings of a specific player (OP Command) |
| /ah reload | Allows player to reload config files (OP command) |
| /ah about | Shows plugin version |
---
## API
### Events
| Event | Description |
| ------------- | -------------- |
| [shock95x\auctionhouse\event\AuctionStartEvent](https://github.com/Shock95x/AuctionHouse/blob/master/src/shock95x/auctionhouse/event/AuctionStartEvent.php) | Called when an auction is started |
| [shock95x\auctionhouse\event\AuctionEndEvent](https://github.com/Shock95x/AuctionHouse/blob/master/src/shock95x/auctionhouse/event/AuctionEndEvent.php) | Called when an auction has ended |
| [shock95x\auctionhouse\event\ItemListedEvent](https://github.com/Shock95x/AuctionHouse/blob/master/src/shock95x/auctionhouse/event/ItemListedEvent.php) | Called when an item is listed by player (cancellable) |
| [shock95x\auctionhouse\event\ItemPurchasedEvent](https://github.com/Shock95x/AuctionHouse/blob/master/src/shock95x/auctionhouse/event/ItemPurchasedEvent.php) | Called when an item is purchased by player (cancellable) |
| [shock95x\auctionhouse\event\MenuCloseEvent](https://github.com/Shock95x/AuctionHouse/blob/master/src/shock95x/auctionhouse/event/MenuCloseEvent.php) | Called when a menu is closed by player |
## Contributing
You can contribute to this project by creating or modifying a language file and opening a PR!
### Contributors
- [Shock95](https://github.com/Shock95) (English)
- [ipad54](https://github.com/ipad54), [No4NaMe](https://github.com/No4NaMe), [XackiGiFF](https://github.com/XackiGiFF) (Russian)
- [Unickorn](https://github.com/Unickorn), Chaosfelix4451 (German)
- [xAliTura01](https://github.com/xAliTura01) (Turkish)
- [NotEnriko](https://github.com/NotEnriko) (Indonesian)
-
## Virions Used
- [InvMenu](https://github.com/Muqsit/InvMenu) (Muqsit)
- [libasynql](https://github.com/poggit/libasynql) (SOFe)
- [await-generator](https://github.com/SOF3/await-generator) (SOFe)
- [Commando](https://github.com/Paroxity/Commando) (CortexPE + Paroxity)
- [UpdateNotifier](https://github.com/ifera-mc/UpdateNotifier) (Ifera)