Features
Detailed features description
Quests
Quests are build from layer to layer. The plugin supports 5 layers:
- Quest Types
- Quest Objectives
- onAccept
- onDrop
- onComplete
Quest Types
Every quest has and is only able to have 1 quest type.
| Quest Types: | Description: | |
|---|---|---|
| Single | The most basic form, only once completable. | |
| Timed | Also known as Daily quests, these quests are repeat able every * minutes. | |
| Chain | Also known as story line quests, When completing the next assigned follows. |
Quest Objectives
Every quest can have an endless amount of objectives but a minimum of one. You are free to choose if an objective is required. If an objective is required and the player did NOT complete it, he will NOT be rewarded.
The " * " modifier (any modifier) allows the objective to listen to any kind of block/mob/enchant etc..
| Objective Types: | Description: | Has " * " Modifier |
|---|---|---|
| Collect | Collect * of specified item. | No |
| Break | Break specified item * times. | Yes |
| Place | Place specified item * times. | Yes |
| Damage | Damage specified item * times. | Yes |
| Enchant item | Enchant specified item * times. | Yes |
| Kill mob (IG: killmob) | Kill specified mob * times. | Yes |
| Kill player (IG:killplayer) | Kill specified player * times. | Yes |
| Tame | Tame specified mob * times. | Yes |
| Castbobber | Catch specified mob * times with your rod. | No |
| Walkto | Walk to a certain point | No |
onAccept
When the player is trying to accept the quest you can ask for different types of penalties/rewards, set a teleport point and insert the message('s) before or after Accepting.
| Penalty Types: | Description: | |
|---|---|---|
| Economy(Money) | The player has to pay * currency to accept. | |
| Permission | The player needs * permission to accept | |
| Blocks | The player needs to pay * amount of specified item. | |
| Potion Effect | The player will need the * potion effect. |
| Reward Types: | Description: | |
|---|---|---|
| Economy(Money) | The player will receive * currency when accepting. | |
| Permission | The player will reveive * permission when accepting | |
| Blocks | The player will receive * amount of specified item. | |
| Potion Effect | The player will receive the * potion effect. |
onComplete
When the player is trying to complete the quest you CAN set a teleport point and insert the completion message('s). You CAN'T give penalties. Rewards will be given from the objectives the player completed.
onDrop
When the player is trying to drop the quest you can ask for different types of penalties, set a teleport point and insert the completion message('s). No rewards onDrop.
| Penalty Types: | Description: | |
|---|---|---|
| Economy(Money) | The player has to pay * currency to drop. | |
| Permission | The player needs * permission to drop | |
| Blocks | The player needs to pay * amount of specified item. | |
| Potion Effect | The player will need the * potion effect. |
Rewards and penalties
Rewards and penalties have a very special task within quests because they will decide if the player wants to accept/comeplete the quest. Rewards and penalties are given after certain action was performed. The quest creator should be aware that when he adds an onAccept reward, he should also add an onDrop reward. Adding the onDrop reward will make sure the player can't accept and drop the quest endlessly receiving his onAccept reward every time he accepts it.
- Economy
- The economy reward will use your economy plugin (supported by Vault) to reward your players currency (money). An economy penalty will withdraw the specified amount from the player.
- Permission
- Permission rewards will add the permission to the player. When a permission reward is set as penalty the plugin will check the player for the permission. If the player does not has the permission he/she will not pass the penalty.
- Blocks
- Block rewards will reward blocks to the player. When selected as penalty it will remove the blocks from the players inventory.
- Potion Effects
- Potion effect will award the specified potion effect to the player for the specified amount of time. Potion effect penalties will check if the player has the potion effect. There is an optional feature allowing you to remove the potion effect when the penalty passes.
- Server sided commands
- Commands can be handed out as reward and penalty. In both cases the command gets executed. The command will be run by the console, this means the command MUST be able to be executed by the console. To use a specific player name use "$player".
- Experience
- Experience can be given in amount and levels. When the experience is handed out as a reward the player will receive the experience. When the experience is handed out as a penalty it will be withdrawn from the player.
NPCs
NPCs are the only way to accept and complete quests. NPC features grow steadily as the suggestions flow on. The aim is to have them as functional as possible inside of the MMORPG questing NPC theme.
| Feature: | Description: | |
|---|---|---|
| Prefix/Name/Suffix | Used to give a name to the NPC | |
| Introduction message | NPCs have an introduction message upon right clicking. | |
| Quest holder | NPCs have a minimum of 1 Quest, no maximum. | |
| Looking position | Selected looking position if the NPC is not interacting | |
| Looking around | The NPC looks to nearby player/mobs,This can be combined with "Fighting mobs" | |
| Fighting mobs | The NPC attacks nearby aggressive mobs,This can be combined with "Looking around" | |
| Hold items | NPCs are able to hold any item without an damage value (Example: 5:1). | |
| Wear armor | NPCs wear armor | |
| Custom Skins | NPCs can change skins using Spout |
Books
Because RPG-NPC makes use of the chat interface the users chat will be spammed quite quickly. To prevent this from happening most things were added to books. At the moment there are 3 kinds of books:
- Quest log book
- Quest information book
- Quest list book
Quest log book
The quest log book saves the rewards the player received for every quest. If the player is not wearing his log book while completing the quests it will not be recorded.
| Holds information about: |
|---|
| Rewards/Total Rewards |
Quest information book
The information book is used to get the necessary quest information from the NPCs or the players quest list. If the player want to write quest information using his quest list he/she has to use the command "/Quest info <QuestNumber>"(More info)
| Holds information about: |
|---|
| The specified quest |
| Objectives/Objective completion |
| Teleportation |
| Penalties/Rewards |
Quest list book
The quest list book updates every time AFTER the player opened it. The quest list books is necessary for the player to manage his quest and see his general status and progressions.
| Holds information about: |
|---|
| Statistics |
| Timed quest cooldowns |
| Active quest list |
| Complete quest list |
Spout
To increase the possibilities of RPG-NPC some features require the Spout plugin and Spoutcraft (Client).
| Feature | Description |
|---|---|
| NPC skins | Spoutcraft users are able to see custom NPC skins |