Consider helping out in updating the wiki for 3.5.0 - see Path_of_Exile_Wiki:To-do_list/3.5.0.

Most of the game data is live. Cleanup of old things & new maps will take a bit.

Template:Mod

From Path of Exile Wiki
Jump to: navigation, search
[view] [edit] [history] [purge] Documentation icon Template documentation

The mod template is used to create a formatted mod page.

Overview

The template will do the following:

  • create an introductory sentence on the page
  • create infoboxes
  • add relevant categories to the page
  • add cargo data to the page

Custom sections should go below the template.

Parameters

All parameters should be filled in if possible to ensure it's working correctly.

Consider using PyPoE to export a template, example:

pypoe_exporter wiki mods mods --wiki <id_of_the_mod1> [id_of_the_mod2] [...] [id_of_the_mod3]

General

Parameter Type Cargo equivalent Description
id str (unique) mods.id Internal Id of the mod.
name str mods.name Name of the mod as shown in game. Can be empty.
mod_group str mods.mod_group Internal name of the mod group.
mod_type str mods.mod_type Internal name of the mod type
domain int mods.domain Domain id of the mod. See Modifiers#Mod Domain for more info.
generation_type int mods.generation_type generation_type id of the mod. See Modifiers#Mod Generation Type for mod info.
required_level int (1<=x<100) mods.required_level The level requirement of the mod.
stat_text str mods.stat_text

mods.stat_text_raw

Parsed text of the stats the mod has. In particular this means human-readable text as well as reformatted values - pretty much what the end user sees in game.
granted_buff_id str mods.granted_buff_id Id of the buff this modifier grants
granted_buff_value value mods.granted_buff_value stat value associated with the granted buff
granted_skill str mods.granted_skill Id of the skill which this mod grants
tags list of str mods.tags List of comma-separated tags the mod has (i.e. used to categorize the mod itself). Separate each tag with exactly , (1 comma and 1 space).
tier_text str mods.tier_text Tier info text that is shown with advanced item descriptions in game.

Multiple arguments

Replace <N> with the number of the argument. Start numbers with 1, and don't leave gaps. The order matters and each parameter must be specified for an individual element of N.

Stats

Parameter Type Cargo equivalent Description
stat<N>_id str mod_stats.id Internal id of the stat
stat<N>_min str mod_stats.min Minimum value for the stat. Minimum can equal maximum if there is no range.
stat<N>_max str mod_stats.max Maximum value for the stat. Minimum can equal maximum if there is no range.

Spawn weight list

List of tags and their weights for this modifier to spawn on an item. Order matters and is represented by the spawn_weights.ordinal field.

Parameter Type Cargo equivalent Description
spawn_weight<N>_tag str spawn_weights.tag Internal name of the tag used for the spawn weighting
spawn_weight<N>_value int (0<=x) spawn_weights.value Value to be used for the spawn weighting

Generation weight list

List of tags and their weight multipliers for this modifier to spawn on an item. Order matters and is represented by the generation_weights.ordinal field.

Parameter Type Cargo equivalent Description
generation_weight<N>_tag str generation_weights.tag Internal name of the tag used for the generation weighting
generation_weight<N>_value int (0<=x) generation_weights.value Value to be used for the generation weighting

Mod sell prices

Parameter Type Cargo equivalent Description
sell_price<N>_name str mod_sell_prices.name What item this modifier sells for
sell_price<N>_amount int (x>=0) mod_sell_prices.amount How many of the item this modifier sells for

Cargo tables

Cargo table declarations:

Name Declaration
mods {{Mod/cargo/main_table}}
mod_sell_prices {{Mod/cargo/mod_sell_prices}}
mod_stats {{Mod/cargo/mod_stats}}
The above documentation is transcluded from Template:Mod/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.