View source for Help:How to edit item acquisition

In Path of Exile there are quite a few items dropping in various places, some are random and some are restricted to certain areas. As the number of items and areas where it drops increases the harder it is to maintain multiple pages with the same information. To minimize the number of pages to manually edit it's been decided to store drop restriction information on the item pages only. Other pages then have to query for that information from a database. This will reduce repetitive edits across the wiki and increase accuracy for less popular pages.

==What's the mechanic?==
{{tlx|Item acquisition}} is supposed to show various ways the item can be obtained, if the {{tlx|item}}:
* '''only drops in a specific area''' then add the <code>area id</code> to <code>|drop_areas=</code>
* '''is obtained through other items''' such as prophecy rewards, divination card rewards or vendor recipes use <code><nowiki>|recipe<i>_part<j>_<item_page/amount>=</nowiki></code> (do not use this for generic recipes)
* '''drops from certain monsters''' use <code>|drop_monsters=</code>. 
* '''drops from another mechanic''', use <code>|drop_text=</code>.
* it will also add quest and vendor reward information based on the data in [[Module:Quest reward]].

For items that follow regular drop mechanics, no changes to the item template are required.

See {{tlx|Item}} for more information about how the parameters are used.

==Editing & retrieving area id==
===When to edit the area id===
Drop restrictions for the area id should only be used for cases the item can only '''specifically''' appear in a particular area.

This means if it is obtained from specific monsters found in specific areas, that information should go to <code>drop_text</code> and not <code>drop_areas</code>. Likewise, for items that just happen to have a high drop level requirement, this parameter should not be used.

At the time of writing only [[Divination cards]] and [[atlas bases|atlas base items]] have drop area restrictions.

===Get the area id===
Before being able to specify how an item is acquired (say from a map), you will need to make note of the place's <code>area id</code>. 

It can be found on the wiki page for the area, in an infobox beside the <code>Id</code> column. For example, for {{il|Graveyard Map}} the id is <code>MapWorldsGraveyard</code>. 

[[File:Graveyard_id.png]]

You cannot add the item into the area, instead you add the area to the item.

Please note that area ids for [[War for the Atlas]] and newer map series are identical.

===Edit the item page===
To add or modify where an item is acquired, you must edit the {{tlx|Item}} infobox on that item's page (e.g. {{il|Her Mask}}). 

First edit the page using <code>Edit Source</code> or <code>Edit</code> (make sure to switch it to <code>Source Editing</code> in the editor dropdown menu)

[[File:Her mask edit buttons.png]]

===Edit the Item infobox data===
Find the section starting with <code>{{Item</code>, and the first line that reads <code>drop_areas =</code>.

This is a comma separated list of area ids. Add the new area id you made note of above (say <code>MapWorldsGraveyard</code> for the [[Graveyard Map]]) to the list. Do '''not replace''' old areas, they're still relevant for old areas. The tables will filter them out instead in the future.

[[File:Her_mask_drop_areas_edit.png]]

===Save your changes===
Save your changes, specifying where you got the information in the <code>Summary</code> box (e.g. Personal drop)

Thank you for contributing to the wiki!

==Adding vendor recipes and upgrade paths==

Vendor recipes and upgrade paths can be added as parameter to the {{tlx|Item}} template by using the <code><nowiki>|recipe...</nowiki></code> set of parameters. Those parameters must be edited on the page the vendor recipe or upgrade path produces, and not the ingredients. After the recipe has been correctly added, it will show up on all ingredient pages accordingly using the {{tlx|item acquisition}} template.

For example, {{il|Hyrri's Bite}} can be created by selling a normal {{il|Sharktooth Arrow Quiver}}, a rare {{il|Onyx Amulet}}, a {{il|Rain of Arrows}} with at least 1% quality and an {{il|Orb of Chance}}. It can however also be obtained via the divination card {{il|Jack in the Box}} as random draw.

===Sets===

This means we'll have two sets to add to the <code><nowiki>|recipe...</nowiki></code> parameters. Naturally we start each set at 1 and increment by one for each:
<pre>
|recipe1
|recipe2
</pre>

The sets will appear in the order given here, so set1 will appear before set2 in the {{tlx|Item acquisition}} template. Generally we go from most-specific to least-specific here, meaning that we add the vendor recipe first (because it's specific to Hyrri's Bite) and the divination card last (because it can drop any unique item with just a tiny chance of one of those being a Hyrri's Bite),

===Groups===

Groups are used to for each particular ingredient in a recipe. The vendor recipe for hyrri's bite has 4 ingredients:

<pre>
|recipe1_part1
|recipe1_part2
|recipe1_part3
|recipe1_part4
|recipe2
</pre>

Now we need to tell the template which items we're looking for. There 3 ways to do this;
* by item name using <code>..._item_name</code>
* by the page on the wiki using <code>..._item_page</code>
* by the metadata id using </code>..._item_id</code>

Generally speaking the name works as long there is only one item with a name. If there isn't, we need to use page (for cases like Two-Stone Rings for example, which has 3 variants). In our case we don't have any pages with duplicates, so we can simply use the name:

<pre>
|recipe1_part1_item_name = Sharktooth Arrow Quiver
|recipe1_part2_item_name = Onyx Amulet
|recipe1_part3_item_name = Rain of Arrows
|recipe1_part4_item_name = Orb of Chance
|recipe2
</pre>

The template now knows which items are being used, but now how many of them. Now we just add the amount with the <code>_amount</code> parameter for each group:

<pre>
|recipe1_part1_item_name = Sharktooth Arrow Quiver
|recipe1_part1_amount    = 1
|recipe1_part2_item_name = Onyx Amulet
|recipe1_part2_amount    = 1
|recipe1_part3_item_name = Rain of Arrows
|recipe1_part3_amount    = 1
|recipe1_part4_item_name = Orb of Chance
|recipe1_part4_amount    = 1
|recipe2
</pre>

There are some special conditions for some of items we haven't covered yet. The conditions are just additional text that is displayed to the user for additional information about the recipe. Those are added with the <code>_notes</code> parameter. These arguments can also contain other templates, for example the colour template {{tlx|c}}. 

It's easier for people to recognize that we mean normal and rare items when we use the colour. Compare:
* normal vs {{c|normal|normal}} <nowiki>{{c|normal|normal}}</nowiki>
* rare vs {{c|rare|rare}} <nowiki>{{c|rare|rare}}</nowiki>

There is nothing noteworthy about the Orb of Chance so we just leave the parameter out.

With all that in mind, we can now add the notes:

<pre>
|recipe1_part1_item_name = Sharktooth Arrow Quiver
|recipe1_part1_amount    = 1
|recipe1_part1_notes     = {{c|normal|normal}}
|recipe1_part2_item_name = Onyx Amulet
|recipe1_part2_amount    = 1
|recipe1_part2_notes     = {{c|rare|rare}}
|recipe1_part3_item_name = Rain of Arrows
|recipe1_part3_amount    = 1
|recipe1_part3_notes     = 1%+ quality
|recipe1_part4_item_name = Orb of Chance
|recipe1_part4_amount    = 1
|recipe2
</pre>

We're done with the first set at this point. Next we add Jack in the Box, similar to above we fill out the parameters. This is set 2 and the groups naturally start at 1 again with Jack in the Box being the only item being added.

<pre>
|recipe1_part1_item_name = Sharktooth Arrow Quiver
|recipe1_part1_amount    = 1
|recipe1_part1_notes     = {{c|normal|normal}}
|recipe1_part2_item_name = Onyx Amulet
|recipe1_part2_amount    = 1
|recipe1_part2_notes     = {{c|rare|rare}}
|recipe1_part3_item_name = Rain of Arrows
|recipe1_part3_amount    = 1
|recipe1_part3_notes     = 1%+ quality
|recipe1_part4_item_name = Orb of Chance
|recipe1_part4_amount    = 1
|recipe2_description     = random {{c|unique|unique}} item
|recipe2_part1_item_name = Jack in the Box
|recipe2_part1_amount    = 4
</pre>

That's it! Now we just need to place that within the {{tlx|Item}} template on the page. See also [[{{FULLPAGENAME}}#Edit the item page]]

==Common issues==
{{main|Path of Exile Wiki:Known issues}}
* When previewing pages, templates that queries data cannot display data that hasn't already been stored to the database. Make sure the page edit is correct and save the page anyway.
* Sometimes pages that queries data doesn't update immediately. [[Null edit]] the page to force an immediate update.

[[Category:Tutorials]]