Alchemist: Difference between revisions
(Probably all incorrect, but still...) |
|||
| Line 45: | Line 45: | ||
===Default Configuration=== | ===Default Configuration=== | ||
Mouseover each section to view it's description. | Mouseover each section to view it's description. | ||
<nowiki></nowiki># Alchemist NPCs Configuration | |||
<nowiki></nowiki>{{H:title|Recipes Block|recipes:}} | |||
{{H:title|Name of 1st recipe|example-recipe:}} | |||
{{H:title|Result section. Defines what happens when "example recipe" is used|result:}} | |||
{{H:title|What potion effect is the result|effect: fire-resistance}} | |||
{{H:title|Duration of the effect|duration: 120}} | |||
{{H:title|Amplifies the strength of the results|amplifier: 1}} | |||
{{H:title|Sent in splash form?|splash: true}} | |||
{{H:title|Ingredients section. Defines what ingredients are needed for this potion. All have to be present|ingredients:}} | |||
{{H:title|ID of ingredient. NOT item/block ID|'0':}} | |||
{{H:title|Name of the ingredient|name: wool}} | |||
{{H:title|Amount required|amount: 64}} | |||
{{H:title|Data value of the ingredient|data: 6}} | |||
{{H:title|ID of the ingredient. NOT item/block ID|'1':}} | |||
{{H:title|Name of the ingredient|name: log}} | |||
{{H:title|Amount required|amount: 12}} | |||
{{H:title|Data value of the ingredient|data: 2}} | |||
{{H:title|Name of 1st recipe|regen:}} | |||
{{H:title|Result section. Defines what happens when "example recipe" is used|result:}} | |||
{{H:title|What potion effect is the result|effect: regeneration}} | |||
{{H:title|Duration of the effect|duration: 60}} | |||
{{H:title|Amplifies the strength of the results|amplifier: 1}} | |||
{{H:title|Sent in splash form?|splash: true}} | |||
{{H:title|Ingredients section. Defines what ingredients are needed for this potion. All have to be present|ingredients:}} | |||
{{H:title|ID of ingredient. NOT item/block ID|'0':}} | |||
{{H:title|Name of the ingredient|name: glass-bottle}} | |||
{{H:title|Amount required|amount: 1}} | |||
{{H:title|Data value of the ingredient|data: 0}} | |||
{{H:title|ID of the ingredient. NOT item/block ID|'1':}} | |||
{{H:title|Name of the ingredient|name: water-bucket}} | |||
{{H:title|Amount required|amount: 1}} | |||
{{H:title|Data value of the ingredient|data: 0}} | |||
<nowiki></nowiki>{{H:title|Messages block|messages:}} | |||
{{H:title|Message sent to the player when they right click on the Alchemist|initialization-message: <nowiki><e>Hello there, <player>. Give me what I need and I will brew you a potion!</nowiki>}} | |||
{{H:title|Message sent to the player if the brewing was successful|success-message: <nowiki><e>I have combined the ingredients to concoct a potion of <a><potion><e>.</nowiki>}} | |||
{{H:title|Message sent to the player if they are still in the cool down period|cooldown-not-expired: You've already had your turn. Come back later!}} | |||
<nowiki></nowiki>{{H:title|Time a player has to wait until they can use the alchemist again|cooldown-in-seconds: 60}} | |||
==Valid Results== | |||
* ''regeneration'' - Regenerates health | |||
* ''fire-resistance'' - Adds resistance to the effects of fire | |||
Revision as of 00:48, 24 February 2012
 Alchemist
| ||||||||||||
How to Use
General Information
Alchemists provide the ability to create custom recipes for potions. You can customize these recipes in the configuration file. A default recipe is provided as an example.
Keep in mind, there is no way to view an alchemist's current recipe ingredients using this plugin. This is intentional, as you, the server admin, should be allowed total freedom to decide how you display recipes. You could show the ingredients using signs, another plugin, or not at all.
Interaction
Right-clicking the alchemist with the proper ingredients will remove them from your hand and give them to the alchemist. Once the recipe has been completely fulfilled, the alchemist will drop a potion around it's location. If the user walks too far away, the alchemist will stop brewing the potion and any items that were given to it will be lost.
Commands
To use alchemist commands, you must have an NPC selected and be the owner of that NPC. There are no permission nodes required for commands.
| Alchemist Commands | |||||
|---|---|---|---|---|---|
| Command | Description | ||||
| /alchemist help | Show the help menu | ||||
| /alchemist recipe | Show the alchemist's current recipe | ||||
| /alchemist recipe [name] | Set an alchemist's current recipe. | ||||
Permissions
To use alchemists, you only need one permission node. The permission node alchemist.interact allows a player to interact with an alchemist.
Configuration
The configuration file for Alchemists is found in /plugins/Alchemist/config.yml and is generated automatically when not present.
Default Configuration
Mouseover each section to view it's description.
# Alchemist NPCs Configuration recipes: example-recipe: result: effect: fire-resistance duration: 120 amplifier: 1 splash: true ingredients: '0': name: wool amount: 64 data: 6 '1': name: log amount: 12 data: 2 regen: result: effect: regeneration duration: 60 amplifier: 1 splash: true ingredients: '0': name: glass-bottle amount: 1 data: 0 '1': name: water-bucket amount: 1 data: 0 messages: initialization-message: <e>Hello there, <player>. Give me what I need and I will brew you a potion! success-message: <e>I have combined the ingredients to concoct a potion of <a><potion><e>. cooldown-not-expired: You've already had your turn. Come back later! cooldown-in-seconds: 60
Valid Results
- regeneration - Regenerates health
- fire-resistance - Adds resistance to the effects of fire