Getting started
Tutorial
Quest creation:
First thing to do is create a quest. Type "/RPG QuestCreate" and follow the instructions that appear in your chat. While the player is in quest creation mode he/she cannot chat. Some creation steps allow you to insert more than 1 possibility, you will loop around the/a few steps endlessly. These steps make use of the "-Next" feature to advance. To cancel any creation mode use: "-Stop".
Example: When inserting objective rewards you can endlessly add rewards, you use "-Next" to move onto the next step.
Please note that some steps have sub steps.
Example: If you choose the quest type "Timed" you will be asked to give a cooldown.
| Step | Description | Attributes | |
|---|---|---|---|
| 1. | Quest Name | Insert the quest name | Capital sensitive |
| 2. | Quest Type | Insert the quest type | Quest types |
| 3. | Objective Type | Insert the objective type | Objective types |
| 4. | Objective Goal | Insert the objective goal | Depends on type |
| 5. | Objective Amount | Insert the objective amount | |
| 6. | Objective Rewards | Insert the objective rewards | P(ermission)/E(conomy)/B(lock) |
| 7. | Objective Requisite | Insert the objective requisite | Yes or No |
| 8. | onAccept Messages | Insert the onAccept messages | |
| 9. | onAccept Penalty | Insert the onAccept penalties | P(ermission)/E(conomy)/B(lock) |
| 10. | onAccept Rewards | Insert the onAccept rewards | P(ermission)/E(conomy)/B(lock) |
| 11. | onAccept Teleport | Select the onAccept teleportation point | "-Here" |
| 12. | onDrop Messages | Insert the onDrop messages | |
| 13. | onDrop Penalty | Insert the onDrop penalties | P(ermission)/E(conomy)/B(lock) |
| 14. | onDrop Teleport | Select the onDrop teleportation point | "-Here" |
| 15. | onComplete Messages | Insert the onComplete messages | |
| 16. | onDrop Teleport | Select the onComplete teleportation point | "-Here" |
Quote from RPG NPC:Plugin: Please insert the Quest name.
Player: My first quest!
Plugin: Please insert the Quest type.
Player: Timed
Plugin: Please insert the cooldown time in minutes.
Player: 5
NPC creation:
To make sure players can use the quest you just created you'll have to add it to an NPC. Type "/RPG NPCCreate" and follow the instructions that appear in your chat. While the player is in NPC creation mode he/she cannot chat.
| Step | Description | Attributes | |
|---|---|---|---|
| 1. | NPC Name | Insert the NPCs name | |
| 2. | NPC Prefix | Insert the NPCs prefix | |
| 3. | NPC Suffix | Insert the NPCs suffix | |
| 4. | NPC Quests | Insert the NPCs quests | Existing quest |
| 5. | NPC Introduction message | Insert the NPCs Introduction message | |
| 6. | NPC looking position | Select the looking position using the specified tool | |
| 7-11. | NPC gear | Insert the NPCs gear | |
| 12. | NPC Looking effect | Insert if the NPC will be looking around | |
| 13. | NPC Fighting effect | Insert if the NPC will be Fighting |
Quest Editing
Quest editing allows the user to edit quests from in-game. Type "/RPG QuestEdit" to start editing quests. While the player is in editing modes he/she cannot chat. If the player is done he can save his/her changes with "-Save". To cancel any editing mode use: "-Stop".
Editing has 4 layers, meaning you can't change the quest type using the in-game commands. To return to layer selecting you use "-Back"
| Layer selection |
|---|
| Objectives |
| onAccept |
| onDrop |
| onComplete |
| -Save |
| -Stop |
| Objectives | ||||
|---|---|---|---|---|
| <Objective number> | Type | <New Type> | <New Goal> | |
| Goal | <New Goal> | |||
| Amount | <New Amount> | |||
| Rewards | Remove | <Reward number> | ||
| Add | <New Reward> | |||
| Set | <Reward number> | <New reward> | ||
| Required | <Yes / No> |
| onAccept | |||
|---|---|---|---|
| Messages | Remove | <Message number> | |
| Add | <Message> | ||
| Set | <Message number> | <Message> | |
| Pre-Messages | Remove | <Pre-message number> | |
| Add | <Message> | ||
| Set | <Pre-message number> | <Message> | |
| Penalties | Remove | <Penalty number> | |
| Add | <New penalty> | ||
| Set | <Penalty number> | <New Penalty> | |
| Rewards | Remove | <Reward number> | |
| Add | <New reward> | ||
| Set | <Reward number> | <New Penalty> |
| onDrop | |||
|---|---|---|---|
| Messages | Remove | <Message number> | |
| Add | <Message> | ||
| Set | <Message number> | <Message> | |
| Penalties | Remove | <Penalty number> | |
| Add | <New penalty> | ||
| Set | <Penalty number> | <New Penalty> |
| onComplete | |||
|---|---|---|---|
| Messages | Remove | <Message number> | |
| Add | <Message> | ||
| Set | <Message number> | <Message> |
Quote from RPG NPC:Plugin: Please insert the Quest name.
Player: My first quest!
Plugin: Please insert the layer you would like to edit.
Player: onAccept
Plugin: Now editing onAccept, what would you like to edit?
Player: Messages Add Go get those first woods!
Plugin: Message added.
Player: -Back
Plugin: Please select the layer.
Player: -Save
Quote from RPG NPC:Plugin: Please insert the Quest name.
Player: My first quest!
Plugin: Please insert the layer you would like to edit.
Player: onAccept
Plugin: Now editing onAccept, what would you like to edit?
Player: Penalty Add e:5
Plugin: Penalty e:5 added.
Player: -Back
Plugin: Please select the layer.
Player: -Save
NPC editing
NPC editing allows you to edit the NPC from in-game. To start editing NPCs use "/RPG NPCEdit". The changes that are made take effect when the user saves the NPC. Use "-Save" to save your changes. To cancel any editing mode use: "-Stop". Selecting your NPC is done with the tool specified in your config.yml
| NPC editing | |||
|---|---|---|---|
| Name | <New name> | ||
| Prefix | <New prefix> | ||
| Suffix | <New suffix> | ||
| Quests | Remove | <Quest number> | |
| Add | <Quest name> | ||
| Set | <Quest number> | <Quest name> | |
| IntroMessages | Remove | <Message number> | |
| Add | <Message> | ||
| Set | <Message number> | <Message> | |
| Location | Takes your location. | ||
| LookingLocation | Takes the location you are looking at. | ||
| Fighting | <New range> | ||
| Looking | <New range> | ||
| Remove | Yes |