Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endermanbugzjfc/quest
Opening the source from one of my cancelled commission.
https://github.com/endermanbugzjfc/quest
dialog dialogue npc plugin pm pm4 pocketmine quest
Last synced: 2 months ago
JSON representation
Opening the source from one of my cancelled commission.
- Host: GitHub
- URL: https://github.com/endermanbugzjfc/quest
- Owner: Endermanbugzjfc
- License: apache-2.0
- Created: 2023-01-21T00:45:19.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T03:30:40.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T17:22:39.789Z (3 months ago)
- Topics: dialog, dialogue, npc, plugin, pm, pm4, pocketmine, quest
- Language: PHP
- Homepage: https://poggit.pmmp.io/ci/Endermanbugzjfc/Quest/Quest/
- Size: 41 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quest
Opening the source from one of my cancelled commission.
Demo video: https://www.youtube.com/watch?v=_aDHyfgpFiE
# Features
- Config-customizable quests.
- Categorizable quests.
- NPC dialogue with popping text.
- Automatically installs SimpleNPC.
## [Example quest config](https://github.com/Endermanbugzjfc/Quest/blob/18a61d4c14d73971e5d9248ac76a64bde0452596/resources/quests/farming/15.yml)
```yaml
name: Harvest 750 carrots and 100 potatoes
dialog:
title: Farmer
content:
|-
Harvest 750 carrots, 100 potatoes and come back.
buttons:
- label: Claim
quest:button_remove: [ ]
task:
# quest:collect = Remove the item once obtain
quest:obtain:
minecraft:carrot:
amount: 750
minecraft:potato:
amount: 100
reward:
quest:commands:
- givemoney {player} 5000
```
## Task types
# API
- [Register](https://github.com/Endermanbugzjfc/Quest/blob/18a61d4c14d73971e5d9248ac76a64bde0452596/src/Endermanbugzjfc/Quest/Quest.php#L83-L87) your [TaskInterface](https://github.com/Endermanbugzjfc/Quest/blob/master/src/Endermanbugzjfc/Quest/tasks/TaskInterface.php) to add custom tasks.
# Potential problems
- The popping text of NPC dialogue might bloat the server network and lag players. There is currently NO interface to disable the popping text. (But a "Skip" button is provided to players.)