Difference between revisions of "Template:Monster/Documentation"

From GodWiki
Jump to navigation Jump to search
Line 66: Line 66:
====Sea creatures (Beasties)====
====Sea creatures (Beasties)====
''('''Note:''' Setting {{para|sea-names}} will categorize the article into the [[:Category:Beasties|Beasties]] category.)''
''('''Note:''' Setting {{para|sea-names}} will categorize the article into the [[:Category:Beasties|Beasties]] category.)''
;{{para|sea-names}} <small>{{nobold|or {{para|names}}}}</small> : ''Optional'' — Set to <code>1</code>/<code>one</code> or <code>2</code>/<code>two</code> to indicate how many names the Beastie has, which represents its "type". (''Required'' with {{para|sea|yes}}, default: ''Unknown''.)
;{{para|sea-names}} <small>{{nobold|or {{para|names}}}}</small> : ''Optional'' — Set from <code>1</code>/<code>one</code> to <code>5</code>/<code>five</code> to indicate which strength level the Beastie has, which represents its "type". (''Required'' with {{para|sea|yes}}, default: ''Unknown''.)
===Subtype switches===
===Subtype switches===

Revision as of 13:57, 9 July 2019

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

Parameter quick-start

The following is essential documentation for users of this template. Comprehensive documentation follows this section.

Boss types

The following codes can be used as arguments to |boss-type=.
|boss-type= Boss Type displayed Notes
above Above-Ground
dig or ug Underground
quest Mini-Quest
1 or 1ab 1-Ability Dungeon AKA "Level 1" / "Class C" (old system)
2 or 2ab 2-Ability Dungeon AKA "Level 2" / "Class B"
3 or 3ab or tb 3-Ability Dungeon AKA "Level 3" / "Treasure Boss" / "Class A"
dungeon Dungeon (unknown/generic)

Implied subtypes

It is no longer required that |pet=yes, |boss=yes, or |sea=yes be used to create an infobox of the associated subtype. Setting a value for any of the associated subtype parameters (|boss-type= for bosses, |pet-levels= or |pet-feature= for pets, or |sea-names= for beasties) will imply the setting of the subtype switch.

The |type=yes switches may still be used, to activate the features for that type of infobox when none of the subtype parameters are being set.


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.
The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc. Be reasonably exact but don't go overboard by using any taxonomy. (default: Unknown)
The habitat the monster is generally found in. (default: Unknown)
A brief description of the monster's appearance. (default: Unknown)
Optional – The monster's latin name. If set, will be listed directly underneath the article title at the top of the infobox. Automatically italicized.
Optional — The monster's typical health.
To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
Optional — Only include if the monster actually has a Death Rattle.
|artifact=Artifact Name
Optional — Only include if the monster actually has its own artifact. Will automatically link to the Godwiki article for that artifact.
|totem=Guild Name
Optional — The Guild which has this monster as its totem monster. Will automatically link to the Godwiki article for that Guild.
(Note: Setting |totem= will categorize the article into the Totem Monsters category.)
Optional — Date or dates when the monster was Wanted in the Godville Times.
In the field, write the word "Day" or "Days" and add the 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.

Subtype parameters


(Note: Setting |boss-type= will categorize the article into the Boss-Monsters category.)

Optional — See the boss types table.


(Note: Setting |pet-levels= or |pet-feature= will categorize the article into the Pets category.)

|pet-levels= or |levels=
Optional — The range of levels the hero must be in to be able to tame the pet.
|pet-feature= or |pet-features=, |feature=, |features=
Optional — Only include if the pet actually has a feature listed in its stats.

Sea creatures (Beasties)

(Note: Setting |sea-names= will categorize the article into the Beasties category.)

|sea-names= or |names=
Optional — Set from 1/one to 5/five to indicate which strength level the Beastie has, which represents its "type". (Required with |sea=yes, default: Unknown.)

Subtype switches

|boss=yes, |pet=yes, |sea=yes,
Optional — If set to a positive value (such as yes, y, true, 1, etc.), activate the appropriate sub-category, title change, and categorization. Useful when none of the parameters related to the sub-type can be set.

Template functionality

Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.

Examples of Use

Empty quick-start template

This has the most commonly used parameters ready to fill in. Paste this into an article for a quick start on your monster infobox. Unused parameters will be ignored (or appear as "Unknown").

| image =   <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| description = 
| latin =   <!-- a Latin-style species name, if known/made-up -->
| class = 
| habitat = 
| boss-type =   <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See table for details. -->
| pet-levels = <!-- Hero levels at which the pet can be tamed -->
| pet-feature =   <!-- Rideable, Sailing, Dungeon, etc. --> 
| sea-names = <!-- From 1 to 5, the strength level the Beastie has -->


Monsters of Godville
Class Demon
Habitat Hell, Swamps, and Old Shoes
Health 55
Death Rattle I'll be back!
Artifact Hell's Hailstone
Wanted on Day 1574 g.e.
Totem for James' Guild ⚜️ 
Description An evil red thing with an attitude
| image = Example.jpg
| class = Demon
| habitat = Hell, Swamps, and Old Shoes
| description = An evil red thing with an attitude
| health = 55
| rattle = I'll be back!
| artifact = Hell's Hailstone
| totem = James' Guild
| wanted = Day [https://web.archive.org/
http://godvillegame.com/news 1574]


Pets of Godville
Class Important
Habitat Bottled water streams
Totem for Example guild ⚜️ 
Description Aquatic mammal
Tame at levels 18-33
Features Unknown
| image = Significantotter.jpg
| description = Aquatic mammal
| class = Important
| habitat = Bottled water streams
| pet-levels = 18-33
| totem = Example guild


Boss-Monsters of Godville
Class Squid
Habitat Dungeons and cubicles
Description A supervising future teller
Boss Type 3-Ability Dungeon
Part Level Level 3
| image = Bosstradamus.jpg 
| class = Squid 
| habitat = Dungeons and cubicles 
| description =  A supervising future teller
| boss-type = 3ab


Beasties of Godville
Class Serrated Starfish
Habitat The surface of the water
Description A weaponized starfish
Type Single-Named
Strength Level 1: 10-19 HP
| image = ninjastar.jpg 
| class = Serrated Starfish 
| habitat = The surface of the water
| description = A weaponized starfish
| sea-names = 1