Caves of Qud Wiki:Style Guide

The Official Caves of Qud Wiki Style Guide is a standard of editing practices and formatting styles for article contribution. Please follow these guidelines as closely as possible, but use your judgment and/or ask others if you believe a situation calls for breaking or amending them.

This is heavily based on Gamepedia's own Manual of Style.

Article Layout

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 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.

Prerelease Content

All content that requires that prerelease content be enabled in order to appear in the game must be prefaced with Template:Prerelease Content.

Book Layout

Book articles should include Template:Item, which is normally generated by Qud Blueprint Explorer. Please do not alter these except through QBE, as they're required in order for QBE to function correctly. The actual contents of the book should appear under a section titled 'Contents', using {{Book Page|(your text here)}) to format each "page", with the 'exact' contents of the book's page data in the game files, including the exact whitespace used.

NPC Layout

NPC articles should include Template:Character, which is normally generated by Qud Blueprint Explorer. Please do not alter these except through QBE, as they're required in order for QBE to function correctly.

Writing

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.)

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 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 <ref></ref> tag. The expected format is Namespace.Class:Method, 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

Unless the article is a guide, writing in the second person (referring to the reader directly with "you") usually has preferable alternatives. Consider using "the player" or "the player character" instead as appropriate, or something more suited to the context.

Any recommendations or other opinions must be presented only in sections marked with Template:Opinion, in order to help the reader distinguish verifiable fact from other additions.

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.

• Do not refer to the NPCs of this game as "monsters"; they are creatures.
• A parasang is made of 9 connected zones.
• "Pounds" is discouraged as referring to weight and Template:Pounds is preferred.
• Surround all complicated dice logic with Template:Dice tooltip.
• The currency is drams or $.
• 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.

Formatting

Color

The wiki already has a template for the main colors found inside Caves of Qud. Do not directly format the text with html;Template:Color has all hexcodes as well as way to quickly format a line with a single color.

Colored Names

Item names such as Stopsvalinn have multicolor names in game. For ease of use, call Template:Qud text instead of manually changing each letter using the Color Template. If referring to an item or character in its page, use Template:name to automatically make the colored version of the item. If referring to other items and characters with a link, use Template:favilink.

Quoting In Game Descriptions

When pasting descriptions from objectblueprints, call Template:Qud quote instead of Template:Quote to parse color strings and preserve single line breaks.

Wikitext

For more specific help on wikitext, check Wikipedia's own Help article. For fancier functions, check Wikipedia's Magic Words.

Sprite Uploading

Main article: Sprite Uploading