Template:Perks/doc
Overview
Displays data about Perks, Cornerstones, and other effects based on search parameters and exclusions. There are a few ways the data can be displayed.
Parameters
All parameters are optional. If no parameters are given, a table of all 300+ Perks will be displayed, showing their icon and name linking to the Perk's page, descriptions, rarity, sources, and price when purchased from a trader.
Selection, Filtering, and Exclusion
You may combine the first three parameters to return more Perks. The result will be the union of your selections, without duplicates. Then use exclude
to remove any Perks that are unrelated to your purposes with their IDs or filter by rarity or source.
Remember that IDs are not visible int he game, so you may need to look them up first.
Parameter | Description |
---|---|
id | A list of IDs of Perks, Cornerstones, and effects, separated by commas. Since IDs are unique, each matched ID adds exactly one Perk to the table. Will not throw an error if an ID is invalid. |
name | A list of terms to search for in names. Adds all Perks with any part of their names matching those terms to the table. |
description | A list of terms to search for in descriptions. Adds all Perks with any part of their descriptions matching that string to the table. |
search | description=criteria. Using this parameter does not prevent you from or override searching by name or description too, but it kind of defeats the purpose. |
rarity | Filters any Perks found by the first search parameters by the specified rarity. Does not throw an error if you misspell the term; here are the correct options:
|
source | Filters any Perks found by the first search parameters by the specified source. Does not throw an error if you misspell the term; here are the correct options:
|
exclude | A list of IDs, separated by commas, that will be excluded from the display. Will not throw an error if an ID is invalid. |
Output Overrides
These parameters allow you to customize the appearance of the results.
Parameter | Default | Description |
---|---|---|
caption | "Perks and Cornerstones" | Captions are calculated automatically based on your search and filtering criteria. However, if you want to override the default caption for the table, you can specify it here. |
show_id | hidden | Use show_id=show if you want to show a first column in the table that shows the ID of the Perk. (In list or inline display, the ID is shown in parentheses after the Perk's name.)
|
show_rarity | shown | Use show_rarity=no if you want to hide the rarity column from the table. (In list or inline display, the rarity is never shown.)
|
show_description | shown | Use show_description=no if you want to hide the description column from the table. (In list or inline display, the description is never shown.)
|
skip_sources | not skipped | Use skip_sources=skip if you want a table that skips the section of five columns indicating the sources of the Perk. This breaks from the naming convention of the other parameters because the template logic is different.
If you want to hide individual columns to make comparisons easier, see below, but take note of two things: (1) in list or inline display, sources are never shown and (2) if you hide all of the source columns individually, without skipping the sources section, the table headings will become misaligned. |
show_source_altar | shown | Use show_source_altar=no to hide the Forsaken Altar source column.
|
show_source_cornerstone | shown | Use show_source_cornerstone=no to hide the Cornerstone source column.
|
show_source_order | shown | Use show_source_order=no to hide the Order source column.
|
show_source_relic | shown | Use show_source_relic=no to hide the Glade Event Relic source column.
|
show_source_trader | shown | Use show_source_trader=no to hide the Trader source column.
|
show_price | shown | Use show_price=no to hide the price column from the table. (In list or inline display, the price is never shown.)
|
display | a table | For use when including these Perks inside other tables or within paragraphs, the display parameter condenses the output to just the links to the pages on each Perk:
|
list_type | bullet | When displaying as a list instead of a table, you can specify list_type=number to show the list as a numbered list instead.
|
Errors
No results from search
If you specify parameters intending to select or search for terms, sometimes there is no result. This can be because you misspelled an id, rarity name, or source name or asked for a search term that was no present in any name or description—or ultimately excluded every item that was found. In this situation, the template, will instead render a plain-text message that nothing was found. (This error display is used for all display modes, table, list, or inline.)
{{Perks |id=IDs are easy to misspell }}
Yields: No matching Perks found.
Table Examples
Selecting Perks by their IDs
IDs to select are normalized, so you do not need to worry about case. Spelling, spacing, and punctuation must all be correct, however.
{{Perks |id=accidental barrels }}
Is the same as the following:
{{Perks |id=Accidental Barrels }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Legendary | Some woodworkers just can't stop working. Gain 3 ![]() ![]() |
x | Cor | x | x | x | 0 |
You can select multiple Perks this way, by separating multiple IDs by commas.
{{Perks |id=Amber for Trader Visit, Trader Interval +25, Trading Packs }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Epic | This time, it's the guild who’s going to pay you, not the other way around. Gain 10 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Rare | Traders will arrive 25% quicker. | x | x | Ord | Rel | Tra | 18 |
![]() |
Epic | Detailed notes on different traders and their wares. Gain 1 additional active trade route slot. Traders will arrive 25% quicker. | x | Cor | Ord | x | Tra | 28 |
Searching names and descriptions
The following example shows searching the same term in both name and description, but you could search different things in each field or use only one and not the other. As a shorthand, when you want to search for the same thing in both name and description, you can use the search parameter instead.
{{Perks |name=blightrot cyst |description=blightrot cyst }}
Note this is the same as this:
{{Perks |search=blightrot cyst }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Legendary | Every 3 burnt Blightrot Cysts lowers Hostility by 10. While the Hearth is corrupted, you’re unable to sacrifice resources. | x | Cor | x | x | x | 0 |
![]() |
Legendary | A crystalline filter designed to mitigate the negative environmental impact of infused rainwater. Blightrot Cysts appear 50% slower when using rain engines, but Reputation from Resolve is generated 90% slower for the next 2 Reputation Points. | x | Cor | x | x | x | 0 |
![]() |
Legendary | Blightrot spores aren't technically eggs, but they taste the same. You gain 5 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | Gain 20 ![]() |
x | Cor | x | Rel | x | 0 |
![]() |
Legendary | Global gathering speed is increased by 30%, and newly discovered resource nodes have more charges (+10 charges to small deposits, +25 charges to large deposits). Every depleted resource node spawns a Blightrot Cyst. | x | Cor | x | x | x | 0 |
Similar to selecting IDs, You can also search for multiple terms in names and descriptions by separating additional terms with commas. This allows you to combine Perks into one table that otherwise seem unrelated, and may be easier than selecting all of their IDs.
The results are combined so the number of results increases, like with an or boolean operation, and this cannot be changed.
{{Perks |name=mist,ashes }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Epic | An odd talisman made from the talons of a phoenix. Gain 2 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | You are allowed to use the legendary Mist Piercers. With such a rare gift at your disposal, the Queen's expectations are high. The content of glades will be revealed, but each discovered glade increases the Queen’s Impatience by 0.5. | x | Cor | x | x | x | 0 |
Filtering by rarity or source
Rarity and source are filters, not selectors. If you do not select any Perks by id, name, or description, then the entire list of Perks is returned. If you then specify a rarity or source, the results are then filtered to your selections. For example, if the term you searched for in the description returns 20 Perks, but you only filter to source=trader
, then only a few of those Perks that match the description will be displayed, the ones that can be purchased from traders.
{{Perks |description=amber |source=trader }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Epic | A shady, but lucrative deal. Gain 10 ![]() |
x | Cor | x | x | Tra | 29 |
![]() |
Rare | A strange talisman made from an extremely rare gemstone - blue Amber. Grants 1 additional cornerstone reroll charge. | x | x | x | x | Tra | 20 |
You can also filter by rarity instead of source. For example, if the term you searched for in the description returns 20 Perks, but you only filter to rarity=Legendary
, then only 6 Legendary Perks that match the description will be displayed, the ones with that rarity.
{{Perks |description=amber |rarity=legendary }}
Yields:
Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | ||||
![]() |
Legendary | Apparently, there is a technique for extracting crystals similar to Amber from rainwater. Gain 10 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | Gain 1 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | Gain 1 ![]() ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | Gain +1 to Global Resolve every time you sell goods worth 50 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | The forest recedes, as heavily guarded trade caravans pour into the settlement. Hostility is reduced by 15 points every time you sell goods worth 30 Amber, but Complex Food needs grant 1 less Resolve point. | x | Cor | x | x | x | 0 |
![]() |
Legendary | A mysterious Amber orb with a magical flame trapped within. Increases the Ancient Hearth's resistance by 150 for every woodcutter in your settlement. | x | Cor | x | x | x | 0 |
![]() |
Legendary | A joint venture with the Stormwalker Guild can be very profitable. You gain 15 ![]() |
x | Cor | x | x | x | 0 |
![]() |
Legendary | The settlement is known for being a major trade hub in the region. Gain 1 Reputation Point every time you sell goods worth 60 Amber, but fulfilling Orders awards 50% less Reputation. | x | Cor | x | x | x | 0 |
In these examples, you can see that filtering by both rarity and source may result in nothing that meets all of your criteria.
{{Perks |description=amber |rarity=legendary |source=trader }}
Yields: No matching Perks found.
Hiding rarity
{{Perks |id=Accidental Barrels |name=Barrel |show_rarity=no }}
Yields:
Name | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | |||
![]() |
5 ![]() |
x | x | Ord | x | x | 0 |
![]() |
![]() |
x | x | x | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
x | x | Ord | Rel | Tra | 15 |
![]() |
+3 to ![]() ![]() |
x | x | x | x | Tra | 24 |
![]() |
+5 to ![]() ![]() |
x | x | Ord | x | x | 0 |
![]() |
Some woodworkers just can't stop working. Gain 3 ![]() ![]() |
x | Cor | x | x | x | 0 |
Hiding descriptions
{{Perks |id=Accidental Barrels |name=Barrel |show_description=no }}
Yields:
Name | Rarity | Sources | Price | ||||
---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | |||
![]() |
Epic | x | x | Ord | x | x | 0 |
![]() |
Rare | x | x | x | Rel | x | 0 |
![]() |
Uncommon | x | x | Ord | Rel | Tra | 15 |
![]() |
Rare | x | x | x | x | Tra | 24 |
![]() |
Epic | x | x | Ord | x | x | 0 |
![]() |
Legendary | x | Cor | x | x | x | 0 |
Skipping source columns
Compare the following table with the one above. If the sources are not as relevant to your purposes, but the descriptions are (and they usually are), then you may want to skip the entire section of the table on sources with skip_sources=skip
.
{{Perks |id=Accidental Barrels |name=Barrel |skip_sources=skip }}
Yields:
Name | Rarity | Description | Price |
---|---|---|---|
![]() |
Epic | 5 ![]() |
0 |
![]() |
Rare | ![]() |
0 |
![]() |
Uncommon | +2 to ![]() ![]() |
15 |
![]() |
Rare | +3 to ![]() ![]() |
24 |
![]() |
Epic | +5 to ![]() ![]() |
0 |
![]() |
Legendary | Some woodworkers just can't stop working. Gain 3 ![]() ![]() |
0 |
You can also skip individual columns. For example, none of the following "Delivery Line" Perks are available from the Forsaken Altar or from traders, so we can safely hide those columns without hiding valuable information from the reader.
{{Perks |name=delivery line |show_source_altar=no |show_source_trader=no }}
Yields:
Name | Rarity | Description | Sources | Price | ||
---|---|---|---|---|---|---|
Cor | Ord | Rel | ||||
![]() |
Epic | 5 ![]() |
x | Ord | Rel | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 3 ![]() |
Cor | x | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 3 ![]() |
Cor | x | x | 0 |
![]() |
Epic | 3 ![]() |
Cor | x | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 4 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | Rel | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 3 ![]() |
Cor | x | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
![]() |
Epic | 5 ![]() |
x | Ord | x | 0 |
Hiding prices
When hiding the trader source column, it's probably also a good idea to hide prices, but this is not enforced.
{{Perks |name=delivery line |show_source_altar=no |show_source_trader=no |show_price=no }}
Yields:
Name | Rarity | Description | Sources | ||
---|---|---|---|---|---|
Cor | Ord | Rel | |||
![]() |
Epic | 5 ![]() |
x | Ord | Rel |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 3 ![]() |
Cor | x | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 3 ![]() |
Cor | x | x |
![]() |
Epic | 3 ![]() |
Cor | x | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 4 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | Rel |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 3 ![]() |
Cor | x | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
![]() |
Epic | 5 ![]() |
x | Ord | x |
Showing Perk ID
When you need to show the ID, remember that the table can get very wide. If showing IDs, consider carefully whether you need to show all of the other columns.
{{Perks |id=Accidental Barrels |name=Barrel |show_id=show }}
Yields:
ID | Name | Rarity | Description | Sources | Price | ||||
---|---|---|---|---|---|---|---|---|---|
Alt | Cor | Ord | Rel | Tra | |||||
Barrels 5pm | ![]() |
Epic | 5 ![]() |
x | x | Ord | x | x | 0 |
Barrel Recipes | ![]() |
Rare | ![]() |
x | x | x | Rel | x | 0 |
Ale +2 | ![]() |
Uncommon | +2 to ![]() ![]() |
x | x | Ord | Rel | Tra | 15 |
Ale +3 | ![]() |
Rare | +3 to ![]() ![]() |
x | x | x | x | Tra | 24 |
Ale +5 | ![]() |
Epic | +5 to ![]() ![]() |
x | x | Ord | x | x | 0 |
Accidental Barrels | ![]() |
Legendary | Some woodworkers just can't stop working. Gain 3 ![]() ![]() |
x | Cor | x | x | x | 0 |
Custom caption
{{Perks |caption=Every Uncommon Perk in the game |rarity=uncommon |show_rarity=no |show_source_altar=no |show_source_cornerstone=no }}
Yields:
Name | Description | Sources | Price | ||
---|---|---|---|---|---|
Ord | Rel | Tra | |||
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 16 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | x | Tra | 22 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 17 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 18 |
![]() |
Traders will arrive 15% quicker. | Ord | Rel | Tra | 14 |
![]() |
+2 to ![]() ![]() |
x | Rel | Tra | 16 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 15 |
![]() |
+2 to ![]() ![]() |
x | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
Any Builder can carry 5 additional items. | Ord | Rel | x | 0 |
![]() |
Builders construct buildings 50% faster. | x | x | Tra | 12 |
![]() |
Any Farmer can carry 5 additional items. | Ord | x | Tra | 16 |
![]() |
Planting crops is 30% faster. | x | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 16 |
![]() |
+1 to ![]() ![]() |
Ord | x | Tra | 14 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+1 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
Any Woodcutter can carry 5 additional items. | x | Rel | x | 0 |
![]() |
A necklace made out of tiny bones. Scouts work 10% faster on Glade Events. | x | x | Tra | 14 |
![]() |
Harvesting crops is 25% faster. | Ord | Rel | Tra | 12 |
![]() |
All buildings have their storage capacity increased by 10. | x | x | Tra | 12 |
![]() |
+2 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | x | Tra | 18 |
![]() |
+3 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 14.4 |
![]() |
+1 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
+3 to ![]() ![]() |
x | Rel | x | 0 |
![]() |
Woodcutting is a lot easier. Woodcutters' Camp production is 15% quicker. | Ord | Rel | Tra | 12 |
![]() |
+1 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+1 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+1 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | x | 0 |
![]() |
Workers assigned to Glade Events can carry 5 more items. | Ord | Rel | Tra | 16 |
![]() |
Scouts can open chests 40% faster. | x | x | Tra | 14 |
![]() |
Planting crops is 25% faster. | Ord | x | Tra | 12 |
![]() |
The property of the deceased is seized for the benefit of the whole settlement. Gain 20 random goods every time a villager dies. | Ord | x | x | 0 |
![]() |
Useful tools for creating drainage ditches. Villagers move 10% faster on roads. | Ord | Rel | Tra | 12 |
![]() |
+1 to ![]() ![]() |
Ord | x | x | 0 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 18 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | Tra | 12 |
![]() |
+2 to ![]() ![]() |
Ord | Rel | x | 0 |
List Examples
Bulleted
This example reproduces the table above, when searching by id and name, in a list format.
{{Perks |id=Accidental Barrels |name=barrel |display=list }}
Yields:
- Barrel Delivery Line
- Barrel Schematics
- Bigger Barrels
- Bigger Barrels
- Bigger Barrels
- Over-Diligent Woodworkers
Numbered
{{Perks |id=Accidental Barrels |name=barrel |display=list |list_type=number }}
Yields:
- Barrel Delivery Line
- Barrel Schematics
- Bigger Barrels
- Bigger Barrels
- Bigger Barrels
- Over-Diligent Woodworkers
List with IDs
{{Perks |id=Accidental Barrels |name=barrel |display=list |show_id=show }}
Yields:
- Barrel Delivery Line ('Barrels 5pm')
- Barrel Schematics ('Barrel Recipes')
- Bigger Barrels ('Ale +2')
- Bigger Barrels ('Ale +3')
- Bigger Barrels ('Ale +5')
- Over-Diligent Woodworkers ('Accidental Barrels')
Inline examples =
{{Perks|id=Accidental Barrels|display=inline}}
Yields the following, shown in the middle of a paragraph to highlight its usefulness. When you lack any kind of vessel, look for Over-Diligent Woodworkers to get some for free every time you make Planks!
{{Perks|id=Accidental Barrels|display=inline|show_id}}
You can also show the ID of the Perk alongside the link, like Over-Diligent Woodworkers ('Accidental Barrels'), if your readers need to see it too.
View templates
The functionality of the Perks template is accomplished through the Wiki data model. This Template:Perks calls the controller module, which in turn interfaces with the data model module. The view is handled entirely by these additional templates:
Template | Purpose |
---|---|
Template:PerksCornerstonesTable | Primary, default table header template |
Template:PerksCornerstonesTable/row | Default table row template |
Template:PerksCornerstonesTable/end | Table markup closing |
Template:PerksCornerstonesTable/SkipSources | Table header template, but without the sources columns |
Template:PerksCornerstonesTable/row/SkipSources | Table row template, but without the sources columns |
Template:PerksCornerstonesList/item | List version row template (there is no list header template) |