Difference between revisions of "Template:Artifact/Documentation"

From GodWiki
Jump to navigation Jump to search
(Wrote the documentation.)
 
(→‎Activatable parameters: update with new effect)
(33 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The artifact template categorizes an article as an [[artifact]] article and it supplies information about it.
+
As well as automatically categorizing an article into [[:Category:Artifacts]], this template supplies some standard information about the subject of the article. For details on how to create an artifact article, refers to the [[Creators Manual]] and the [[Guideline: Artifact Articles]].
  
'''Parameters:'''
+
==Parameters==
  
* '''image''' - ''Optional but preferable'' The full image file name.
+
; {{para|image|<var>filename</var>}} : ''Optional but preferred'' — The full image file name.
 +
: If an image is not supplied, a placeholder will be used, and by default the template will place the {{tlx|picture}} hatnote before the infobox. Disable this if necessary with {{para|ignore-no-image|yes}} ''(see below)''.
 +
:;{{para|caption|<var>Image description</var>}} : ''Optional'' — Use only if {{para|image}} is also set. Text of a descriptive caption to display beneath the image.
 +
; {{para|type|<var>Normal,Bold,Healing,Activatable</var>}} : '''''Required''''' — The type of the item. (Default: ''Unknown'')
 +
:: ''('''Note''': Setting {{para|type}} to <code>Bold</code>, <code>Healing</code>, or <code>Activatable</code> will also categorize the article into the [[:Category:Bold Artifacts|Bold Artifacts]], [[:Category:Healing Artifacts|Healing Artifacts]], or [[:Category:Activatable Artifacts|Activatable Artifacts]] category, respectively.)''
  
* '''type''' - The type of the item. This can be normal, bold, healing, or activatable.
+
;{{para|description}} : '''''Required''''' — A brief description of the item. (Default: ''Unknown'')
  
* '''description''' - A brief description of the item.
+
;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for.
  
* '''value''' - ''Optional'' The average amount of money this item can be sold for.
+
; {{para|monster|<var>Monster Name</var>}} : ''Optional'' — Only include if the artifact actually has its own [[Monsters' Artifacts|associated monster]]. Will automatically link to the Godwiki article for that monster.
 +
:: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)''
  
* '''monster''' - ''Optional'' Only include if the artifact actually has its own [[Monsters' Artifacts|associated monster]].
+
===Activatable parameters===
 +
For artifacts of {{para|type|activatable}}, the following additional parameters can be set:
 +
;{{para|cost|<var>godpower</var>}}: ''Optional'' – Indicates the activation cost. Possible values are:
 +
::{{para|cost|0}} – Requires no godpower to activate (can also be: <code>free</code>,<code>none</code>,<code>0%</code>)
 +
::{{para|cost|50}} – Requires 50% of godpower to activate (can also be: <code>50%</code>)
  
* '''position''' - ''Optional'' The position of the template on the page. By default set to "right," although you may set it to "left" or "center."
+
;{{para|effect|<var>Activation effect</var>}}: ''Optional'' – A brief description of the artifact's effect when activated. Free-form text field, preferably one of the entries on the following table.
 +
: {|class="wikitable"
 +
|-
 +
! Type !! Formatted !! Wikicode
 +
|-
 +
| Aboveground boss
 +
| Summon an [[Boss-monsters#Aboveground_Boss-Monsters|aboveground Boss monster]]
 +
| <code><nowiki>Summon an [[Boss-monsters#Aboveground_Boss-Monsters|aboveground Boss monster]]</nowiki></code>
 +
|-
 +
| Underground boss
 +
| Start search for an [[Boss-monsters#Underground_Boss-Monsters|underground Boss monster]]
 +
| <code><nowiki>Start search for an [[Boss-monsters#Underground_Boss-Monsters|underground Boss monster]]</nowiki></code>
 +
|-
 +
| Teleport to random town
 +
| Teleport to a random [[Town]]
 +
| <code><nowiki>Teleport to a random [[Town]]</nowiki></code>
 +
|-
 +
| Teleport to the Arena
 +
| Send to the [[Arena]]
 +
| <code><nowiki>Send to the [[Arena]]</nowiki></code>
 +
|-
 +
| Mini-quest
 +
| Send on a [[Mini-quest]]
 +
| <code><nowiki>Send on a [[Mini-quest]]</nowiki></code>
 +
|-
 +
| Bold items into Golden bricks
 +
| Transform bold items into [[Golden bricks]]
 +
| <code><nowiki>Transform bold items into [[Golden bricks]]</nowiki></code>
 +
|-
 +
| Fuse 3000 gold or kill monster
 +
| Fuse 3000 coins into a [[Golden brick]] or kill a monster
 +
| <code><nowiki>Fuse 3000 coins into a [[Golden brick]] or kill a monster</nowiki></code>
 +
|-
 +
| Artifacts gift
 +
| Grant some [[Artifacts]]
 +
| <code><nowiki>Grant some [[Artifacts]]</nowiki></code>
 +
|-
 +
| Black Boxes
 +
| Affect in a good or a bad way ([[Black boxes]])
 +
| <code><nowiki>Affect in a good or a bad way ([[Black boxes]])</nowiki></code>
 +
|-
 +
| Heal
 +
| Fully restore {{hero or heroine}}'s [[Health]]
 +
| <code><nowiki>Fully restore {{hero or heroine}}'s [[Health]]</nowiki></code>
 +
|-
 +
| Aura
 +
| Grant an [[Aura]]
 +
| <code><nowiki>Grant an [[Aura]]</nowiki></code>
 +
|-
 +
| [[Hammer of realignment]] (Unique so far)
 +
| Accentuate the {{hero or heroine}}'s [[personality]]
 +
| <code><nowiki>Accentuate the {{hero or heroine}}'s [[personality]]</nowiki></code>
 +
|-
 +
| Restore GP
 +
| Restore 50% of [[Godpower]]
 +
| <code><nowiki>Restore 50% of [[Godpower]]</nowiki></code>
 +
|-
 +
| Add accumulator charge
 +
| Add an [[Accumulator]] charge
 +
| <code><nowiki>Add an [[Accumulator]] charge</nowiki></code>
 +
|-
 +
| Random friends
 +
| Add a random God to your [[Friends]] List
 +
| <code><nowiki>Add a random God to your [[Friends]] List</nowiki></code>
 +
|-
 +
| [[Invite to Godville]] (Unique so far)
 +
| Add an Invite to your [[Friends]] List
 +
| <code><nowiki>Add an Invite to your [[Friends]] List</nowiki></code>
 +
|-
 +
|Skill replacement
 +
|Replace one of the {{hero or heroine}}'s [[skills]].
 +
|<code><nowiki>Replace one of the {{hero or heroine}}'s [[skills]].</nowiki></code>
 +
|}
  
* '''wanted'''  - ''Optional'' Add the particular date or dates the monster was wanted in the [[Godville Times]].  In the field, write the word "Day" or "Days" and add the [https://web.archive.org/web/20141229212110*/http://godvillegame.com/news web.archive.org] link of the g.e. day or days the monster was in the godville times. Don't write the letters "g.e." as those are automatically added.
+
===Template functionality===
 +
; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox.
  
Example of Usage:
+
; {{para|top|<var>no</var>}} : ''Optional'' — Set to <code>no</code> to disable the automatic placement of the {{tlx|Top}} template on the article.
  
<pre><nowiki>{{monster</nowiki>
+
==Example of Use==
 +
Quick blank template:
 +
 
 +
<pre>{{artifact
 +
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
 +
| caption = <!-- A caption to display below the image. -->
 +
| type = <!-- Set to one of: Normal, Bold, Healing, or Activatable. Will show "Unknown" if not set -->
 +
| description = <!-- A short description of the artifact. -->
 +
| value = <!-- Average selling value -->
 +
| monster = <!-- If this is only found on a specific monster, list it here -->
 +
}}</pre>
 +
 
 +
{{artifact
 +
| image = Example.jpg
 +
| caption = Example
 +
| type = Normal
 +
| description = A completely everyday and normal item.
 +
| value = 55
 +
| monster = Generic Enemy
 +
}}
 +
<pre>{{artifact
 
| image = Example.jpg
 
| image = Example.jpg
 +
| caption = Example
 
| type = Normal
 
| type = Normal
 
| description = A completely everyday and normal item.
 
| description = A completely everyday and normal item.
 
| value = 55
 
| value = 55
 
| monster = Generic Enemy
 
| monster = Generic Enemy
| position =
+
}}</pre>
| wanted = Day <nowiki>[https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]</nowiki>
+
{{clear}}
<nowiki>}}</nowiki></pre>
 
  
 
+
{{artifact
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>
+
| image = Example.jpg
 +
| caption = Example
 +
| type = Activatable
 +
| description = Can be activated
 +
| cost = 50
 +
| effect = Something good or bad
 +
}}
 +
<pre>{{artifact
 +
| image = Example.jpg
 +
| caption = Example
 +
| type = Activatable
 +
| description = Can be activated
 +
| cost = 50
 +
| effect = Something good or bad
 +
}}</pre>
 +
{{clear}}
 +
<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>

Revision as of 19:30, 3 December 2020

As well as automatically categorizing an article into Category:Artifacts, this template supplies some standard information about the subject of the article. For details on how to create an artifact article, refers to the Creators Manual and the Guideline: Artifact Articles.

Parameters

|image=filename
Optional but preferred — The full image file name.
If an image is not supplied, a placeholder will be used, and by default the template will place the {{picture}} hatnote before the infobox. Disable this if necessary with |ignore-no-image=yes (see below).
|caption=Image description
Optional — Use only if |image= is also set. Text of a descriptive caption to display beneath the image.
|type=Normal,Bold,Healing,Activatable
Required — The type of the item. (Default: Unknown)
(Note: Setting |type= to Bold, Healing, or Activatable will also categorize the article into the Bold Artifacts, Healing Artifacts, or Activatable Artifacts category, respectively.)
|description=
Required — A brief description of the item. (Default: Unknown)
|value=
Optional — The average amount in gold coins this item can be sold for.
|monster=Monster Name
Optional — Only include if the artifact actually has its own associated monster. Will automatically link to the Godwiki article for that monster.
(Note: Setting |monster= will categorize the article into the Monsters' Artifacts category.)

Activatable parameters

For artifacts of |type=activatable, the following additional parameters can be set:

|cost=godpower
Optional – Indicates the activation cost. Possible values are:
|cost=0 – Requires no godpower to activate (can also be: free,none,0%)
|cost=50 – Requires 50% of godpower to activate (can also be: 50%)
|effect=Activation effect
Optional – A brief description of the artifact's effect when activated. Free-form text field, preferably one of the entries on the following table.
Type Formatted Wikicode
Aboveground boss Summon an aboveground Boss monster Summon an [[Boss-monsters#Aboveground_Boss-Monsters|aboveground Boss monster]]
Underground boss Start search for an underground Boss monster Start search for an [[Boss-monsters#Underground_Boss-Monsters|underground Boss monster]]
Teleport to random town Teleport to a random Town Teleport to a random [[Town]]
Teleport to the Arena Send to the Arena Send to the [[Arena]]
Mini-quest Send on a Mini-quest Send on a [[Mini-quest]]
Bold items into Golden bricks Transform bold items into Golden bricks Transform bold items into [[Golden bricks]]
Fuse 3000 gold or kill monster Fuse 3000 coins into a Golden brick or kill a monster Fuse 3000 coins into a [[Golden brick]] or kill a monster
Artifacts gift Grant some Artifacts Grant some [[Artifacts]]
Black Boxes Affect in a good or a bad way (Black boxes) Affect in a good or a bad way ([[Black boxes]])
Heal Fully restore hero's Health Fully restore {{hero or heroine}}'s [[Health]]
Aura Grant an Aura Grant an [[Aura]]
Hammer of realignment (Unique so far) Accentuate the hero's personality Accentuate the {{hero or heroine}}'s [[personality]]
Restore GP Restore 50% of Godpower Restore 50% of [[Godpower]]
Add accumulator charge Add an Accumulator charge Add an [[Accumulator]] charge
Random friends Add a random God to your Friends List Add a random God to your [[Friends]] List
Invite to Godville (Unique so far) Add an Invite to your Friends List Add an Invite to your [[Friends]] List
Skill replacement Replace one of the hero's skills. Replace one of the {{hero or heroine}}'s [[skills]].

Template functionality

|ignore-no-image=yes
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.
|top=no
Optional — Set to no to disable the automatic placement of the {{Top}} template on the article.

Example of Use

Quick blank template:

{{artifact
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| caption = <!-- A caption to display below the image. -->
| type = <!-- Set to one of: Normal, Bold, Healing, or Activatable. Will show "Unknown" if not set -->
| description = <!-- A short description of the artifact. -->
| value = <!-- Average selling value -->
| monster = <!-- If this is only found on a specific monster, list it here -->
}}
Artifacts of Godville
Artifact/Documentation
Example.jpg
Example
Type 🧷Normal
Value 55
Associated Monster Generic Enemy
Description A completely everyday and normal item.
{{artifact
| image = Example.jpg
| caption = Example
| type = Normal
| description = A completely everyday and normal item.
| value = 55
| monster = Generic Enemy
}}
Artifacts of Godville
Artifact/Documentation
Example.jpg
Example
Type ⚙️Activatable
Description Can be activated
Activation
Cost 50% of godpower
Effect Something good or bad
{{artifact
| image = Example.jpg
| caption = Example
| type = Activatable
| description = Can be activated
| cost = 50
| effect = Something good or bad
}}