Difference between revisions of "Template:Npc/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
m (Added additional documentation.)
Line 15: Line 15:
 
|BriefDescription=<br />
 
|BriefDescription=<br />
 
|OtherInfo=<br />
 
|OtherInfo=<br />
|NPCIntro=<br />
+
|NPCShopIntro=<br />
 
|Vendor=<br />
 
|Vendor=<br />
 
|QuestDescription=<br />
 
|QuestDescription=<br />
Line 33: Line 33:
 
== Parameters ==
 
== Parameters ==
 
; Name
 
; Name
: The name of the NPC
+
: Required. The name of the NPC.
 
; ImageName
 
; ImageName
: Name of the image (may include extension at a later date)
+
: Required. Name of the image (may include extension at a later date).
 
; Description
 
; Description
: Description of the NPC
+
: Optional. This caption comes from the in-game text above the NPC's head.
 
; Zone
 
; Zone
: Zone the NPC is located in with brackets
+
: Required. Zone or Dungeon where the NPC can be found.
 
; Location
 
; Location
: Where in the zone the npc is located
+
: Required. A short description of where the NPC is located in the previously listed Zone or Dungeon.
 
; BeastSpeak
 
; BeastSpeak
: Yes if they talk to beasts, No if they do not
+
: Optional. Yes if they talk to beasts, No if they do not. Some NPCs may be "Yes (No Wolves)"
 
; SkillsTrainer
 
; SkillsTrainer
: Bracketed coma separated list of skills they train
+
: Optional. Bracketed coma separated list of skills trained by the NPC.
 
; IsVendor
 
; IsVendor
: Yes if they are a vendor, No if they are not
+
: Required. ''Yes'' if they are a vendor, ''No'' if they are not
 
; NPCQuote
 
; NPCQuote
; This quote should be something informative about the NPC, or express their personality
+
: Optional. This quote should be something informative about the NPC, or express their personality.
 
; BriefDescription
 
; BriefDescription
:  
+
: Required. Add a brief description of the NPC
 
; OtherInfo
 
; OtherInfo
:  
+
: Optional. Add other information about the NPC. Lore, relationships, ect.
; NPCIntro
+
; NPCShopIntro
:
+
: Optional. This is used for a sentence describing what the NPC sells in their shop.
 
; Vendor
 
; Vendor
: List of items that the NPC sells, using the "vendor item row" template for each item
+
: Optional. List of items that the NPC sells, using the "vendor item row" template for each item
 
: <nowiki>{{vendor item row| item = Beakers | cost = 300}}</nowiki>
 
: <nowiki>{{vendor item row| item = Beakers | cost = 300}}</nowiki>
 
; QuestDescription
 
; QuestDescription
:
+
: Optional. Provide information on the types of quests an NPC might provide. "[[Marna]] offers a variety of quests that send adventurers across the [[Serbule]] region."
 
; RewardOverview
 
; RewardOverview
:  
+
: Optional. A sentence describing the types of favor rewards offered. "Marna rewards her friends with Storage space and items."
 
; Rewards
 
; Rewards
:
+
: Optional. Spoiler tagged rewards describing rewards gained just through leveling up favor. <nowiki>{{Spoiler|Reward at {{Favor|Comfortable}}.|
 +
:{{Item|Lembas Brick}} x2
 +
}}</nowiki>
 
; TrainingDescription
 
; TrainingDescription
:
+
: Optional. A brief description of the type of training an NPC offers.
 
; Training
 
; Training
: list of skills and individual recipes that are trainable
+
: Optional. A list of skills and individual recipes that are trainable.
 
; Services
 
; Services
:  
+
: Optional. List some of the services offered by the NPC. Consignment, Storage, Bartering, or unique options. Rappanel plays music if paid, and Ashk the Answerer tells fortunes that grant buffs.
 
; Consignment
 
; Consignment
:
+
: Optional. Used only if the NPC offers consignment.
 
; Storage
 
; Storage
:
+
: Optional. Used only if the NPC offers storage.
 
; Bartering
 
; Bartering
:
+
: Optional. Used only if the NPC offers storage.
 
; HangOuts
 
; HangOuts
:  
+
: Optional. Lists the Hang Out options the NPC offers.
 
; Events
 
; Events
:
+
: Optional. Used if the NPC has an event-based behavior changes.
 
; Conversations
 
; Conversations
:  
+
: Optional. List long conversations the NPC may have.
  
  

Revision as of 16:16, 31 August 2019

Description

Use this template whenever you

Syntax =

{{npc
|Name=
|ImageName=
|Description=
|Zone=
|Location=
|BeastSpeak=
|SkillsTrainer=
|IsVendor=
|NPCQuote=
|BriefDescription=
|OtherInfo=
|NPCShopIntro=
|Vendor=
|QuestDescription=
|RewardOverview=
|Rewards=
|TrainingDescription=
|Training=
|Services=
|Consignment=
|Storage=
|Bartering=
|HangOuts=
|Events=
|Conversations=
}}

Parameters

Name
Required. The name of the NPC.
ImageName
Required. Name of the image (may include extension at a later date).
Description
Optional. This caption comes from the in-game text above the NPC's head.
Zone
Required. Zone or Dungeon where the NPC can be found.
Location
Required. A short description of where the NPC is located in the previously listed Zone or Dungeon.
BeastSpeak
Optional. Yes if they talk to beasts, No if they do not. Some NPCs may be "Yes (No Wolves)"
SkillsTrainer
Optional. Bracketed coma separated list of skills trained by the NPC.
IsVendor
Required. Yes if they are a vendor, No if they are not
NPCQuote
Optional. This quote should be something informative about the NPC, or express their personality.
BriefDescription
Required. Add a brief description of the NPC
OtherInfo
Optional. Add other information about the NPC. Lore, relationships, ect.
NPCShopIntro
Optional. This is used for a sentence describing what the NPC sells in their shop.
Vendor
Optional. List of items that the NPC sells, using the "vendor item row" template for each item
{{vendor item row| item = Beakers | cost = 300}}
QuestDescription
Optional. Provide information on the types of quests an NPC might provide. "Marna offers a variety of quests that send adventurers across the Serbule region."
RewardOverview
Optional. A sentence describing the types of favor rewards offered. "Marna rewards her friends with Storage space and items."
Rewards
Optional. Spoiler tagged rewards describing rewards gained just through leveling up favor. {{Spoiler|Reward at {{Favor|Comfortable}}.| :{{Item|Lembas Brick}} x2 }}
TrainingDescription
Optional. A brief description of the type of training an NPC offers.
Training
Optional. A list of skills and individual recipes that are trainable.
Services
Optional. List some of the services offered by the NPC. Consignment, Storage, Bartering, or unique options. Rappanel plays music if paid, and Ashk the Answerer tells fortunes that grant buffs.
Consignment
Optional. Used only if the NPC offers consignment.
Storage
Optional. Used only if the NPC offers storage.
Bartering
Optional. Used only if the NPC offers storage.
HangOuts
Optional. Lists the Hang Out options the NPC offers.
Events
Optional. Used if the NPC has an event-based behavior changes.
Conversations
Optional. List long conversations the NPC may have.


Notes