Caves of Qud Wiki:Style Guide: Difference between revisions

second major round of edits
(split out sprite uploading into its own article)
(second major round of edits)
Line 6: Line 6:


===Infoboxes===
===Infoboxes===
Infoboxes, boxes which summarize data relating to the article, should appear at the top-right corner of the article content. Item tooltips are also "infoboxes".
Infoboxes, boxes which summarize data relating to the article, should appear at the top-right corner of the article content. This includes item tooltips.


Infoboxes should generally summarize available information; speculation, as well as "unknown" or "n/a" rows, should be avoided. Most information required in infoboxes will be in ObjectBlueprints.xml.  
Infoboxes should generally summarize available information; speculation, as well as filler rows (e.g., "?", "unknown", "N/A"), should be avoided if possible. Most information required in infoboxes will be in <code>ObjectBlueprints.xml</code>.  


===Prerelease Content===
===Prerelease Content===
Line 21: Line 21:


===Categories===
===Categories===
Categories should be named in their plural form when appropriate, with all words capitalized. E.g., [[:Category:Artifacts]]. (However, note also [[:Category:Lore]], so named because the word "lore" has no common plural form.)
Categories should be named in their plural form when appropriate, capitalized in title case. E.g., [[:Category:Artifacts]]. (However, note also [[:Category:Lore]], so named because the word "lore" has no common plural form.)


===Reliability===
===Reliability===
To make sure that all information on this wiki is up to date, make sure to use [[Template:As Of Patch]] on the top of pages.  
To make sure that all information on this wiki is up to date, make sure to use [[Template:As Of Patch]] on the top of pages.  


To make sure that information is correct in the first place, if it is in a difficult-to-find location (e.g., a C# class whose name is ''not'' the ID specified in the page's infobox), be sure to note which C# class you found it in by using a <code><nowiki><ref></ref></nowiki></code> tag. The expected format is <code>Namespace.Class:Method</code>, although the method may be omitted if the class's implementation is small or if it's not applicable. Line numbers must not be included, because they may be inconsistent across disassemblies.
To make sure that information is correct in the first place, if it is in a difficult-to-find location (e.g., a C# class whose name is not the ID specified in the page's infobox), be sure to note which C# class you found it in by using a <code><nowiki><ref></ref></nowiki></code> tag. The expected format is <code>Namespace.Class:Method</code>, although the method may be omitted if the class's implementation is small or if it's not applicable. Line numbers must not be included, because they may be inconsistent across disassemblies.


===Formality===
===Formality===
Line 34: Line 34:


===Terminology===
===Terminology===
Avoid protagonist bias as well: many other creatures are fully capable of using objects and mutations the same way as the player does. Avoid mentioning the player character when "this creature" is more accurate to describe the possible users.
Avoid protagonist bias; many creatures besides the player character are able to use objects and mutations the same way the player does. Avoid mentioning the player character when "this creature" is more accurate to describe the possible users. Do note, for example, when a mutation's effect depends on whether it's used by a player or non-player character, such as [[Precognition]].


* Do not refer to the NPCs of this game as "monsters"; they are '''creatures'''.
==== "Creature" versus "Monster" ====
* A parasang is made of 9 connected '''zones'''.
 
* "Pounds" is discouraged as referring to weight and [[Template:Pounds]] is preferred.
The general word for any given denizen of Qud is "creature"; no one is to be referred to as a "monster", regardless of how the player or player character may feel about them.
* Surround all complicated dice logic with [[Template:Dice tooltip]].
 
* The currency is '''drams''' or $.
==== Units ====
* A global ingame turn at (a turn at 100 quickness) is referred to as a '''Game tick''', but a player based turn counter that does depends on their quickness can be referred to as an ingame '''turn'''.
 
The standard unit of liquid, including water, is the "dram". Drams of water in particular (and only drams of water) may also be abbreviated with "$". E.g., "$10" means "ten drams of water".
 
The standard unit of weight is "#". This has no official verbalization, however, to avoid confusion, it should never be written as "pounds". Consider using [[Template:Pounds]] when writing out a weight.
 
The time between when a creature receives the opportunity to act is a "turn". The 'standard' unit of time is the "game tick", or simply "tick", which is equivalent to one turn for a creature whose quickness is 100.
 
===== "Parasang" =====
 
A parasang is, depending on context, equivalent to:
* a world map tile
* the 3×3 set of surface zones associated with a given world map tile
* the 3×3×infinity set of zones associated with a given world map tile
* the distance from one zone to any zone on an adjacent world map tile


==Formatting==
==Formatting==
Line 55: Line 68:
===Wikitext===
===Wikitext===
For more specific help on wikitext, check [https://en.wikipedia.org/wiki/Help:Wikitext Wikipedia's own Help article]. For fancier functions, check [https://en.wikipedia.org/wiki/Help:Magic_words Wikipedia's Magic Words].
For more specific help on wikitext, check [https://en.wikipedia.org/wiki/Help:Wikitext Wikipedia's own Help article]. For fancier functions, check [https://en.wikipedia.org/wiki/Help:Magic_words Wikipedia's Magic Words].
===Dice===
Format any string representing a dice roll with [[Template:Dice tooltip]].


==Sprite Uploading==
==Sprite Uploading==
{{Main | Sprite Uploading}}
{{Main | Sprite Uploading}}