Caves of Qud Wiki:Style Guide: Difference between revisions

m Remove plaintext lang specifier
m Add note on putting {{Spoiler}} on endgame pages
 
(11 intermediate revisions by 3 users not shown)
Line 7: Line 7:
==Article Layout==
==Article Layout==
===Page Names and Capitalization===
===Page Names and Capitalization===
{{gamename}} has all items and creatures titles written in all lowercase, unless the name is proper ([[Sparafucile]] vs [[giant centipede nest]]). To keep in the same spirit, all items and creatures will follow the same convention. If possible, the capitalization format of the game must be obeyed as much as possible. As an example, all mutations are capitalized in Title Case as they are in game ([[Multiple Legs]]) but cybernetics are not ([[cherubic visage]]). Concepts and mechanics that have no official name will follow standard wiki title format. The same concept applies to capitalizations of terms that appear within the text of an article.


Exceptions can be made for section titles, table headers, and similar labels - these typically are written in Title Case regardless of the terminology involved.
As a rule, capitalize the same way the game does.
 
Item and creature names are generally written in all lowercase (e.g., {{F|giant centipede nest}}) unless the name is proper (e.g., {{F|Sparafucile}}).
 
Mutation names are Title Case (e.g., {{F|Multiple Legs}}); cybernetics (which are items) are not (e.g., {{F|cherubic visage}}).
 
Concepts and mechanics that are ordinary English words and don't appear in-game are generally not capitalized, but it may vary on a case by case basis.
 
Section titles, table headers, and similar labels are generally written in Title Case regardless of the terminology involved.


Examples of terms and their typical capitalization:
Examples of terms and their typical capitalization:
Line 19: Line 26:
| Mutation names
| Mutation names
| Title Case
| Title Case
| {{favilink|Corrosive Gas Generation}}
| {{f|Corrosive Gas Generation}}
|-
|-
| Skills
| Skills
Line 31: Line 38:
| Proper names
| Proper names
| Capitalized
| Capitalized
| {{favilink|Lake Hinnom}}, {{favilink|banner of the Holy Rhombus}}, {{favilink|flume-flier of the sky-bear}}
| {{f|Lake Hinnom}}, {{f|banner of the Holy Rhombus}}, {{f|flume-flier of the sky-bear}}
|-
|-
| Non-proper location names
| Non-proper location names
| Lowercase
| Lowercase
| {{favilink|desert canyons}}
| {{f|desert canyons}}
|-
|-
| Most items and creatures
| Most items and creatures
| Lowercase
| Lowercase
| {{favilink|spaser pistol}}, {{favilink|gelatinous prism}}
| {{f|spaser pistol}}, {{f|gelatinous prism}}
|-  
|-  
| Game mechanics terminology
| Game mechanics terminology
Line 97: Line 104:
==== “Creature” ====
==== “Creature” ====


A creature is anything with a <code>Brain</code> part in the game data. (Note that this is a distinct notion from having a brain susceptible to psionic attacks.)
A creature is anything that can be Hostile, Neutral, or Friendly. When Alt is held, it shows up red (if hostile) or green (otherwise). In the game data, it has the <code>Brain</code> part.


The following are creatures:
The following are creatures:


* {{Favilink|snapjaw scavenger}}
* {{f|snapjaw scavenger}}
* {{Favilink|Q Girl}}
* {{f|Q Girl}}
* {{Favilink|giant amoeba}}
* {{f|giant amoeba}}
* {{Favilink|giant centipede nest}}
* {{f|giant centipede nest}}
* {{Favilink|yonderbrush}}
* {{f|yonderbrush}}
* {{Favilink|wine weep}}
* {{f|wine weep}}
* {{Favilink|pulsed field magnet}}
* {{f|pulsed field magnet}}


The following are not creatures:
The following are not creatures:


* {{Favilink|watervine}}
* {{f|watervine}}
* {{Favilink|witchwood tree}}
* {{f|witchwood tree}}
 
Depending on the context, exceptions may be made for narrative entities who aren't represented as game objects with brains, such as [[Ereshkigal]], despite the fact that the only thing Ereshkigal has in common with most creatures in the primary sense is that she has in-game dialog attributed to her.


==== “Currently” ====
==== “Currently” ====
Line 126: Line 131:


This rule is not related to uses of the word “currently” that are about something that is expected to change within a game session. For instance, “a creature that is currently flying” does not run afoul of this rule and does not call for a citation to justify that wording.
This rule is not related to uses of the word “currently” that are about something that is expected to change within a game session. For instance, “a creature that is currently flying” does not run afoul of this rule and does not call for a citation to justify that wording.
==== “Dynamic Encounter” / “Faction Encounter” ====
'''Dynamic encounters''' are a system by which the majority of objects in the game are automatically entered into various [[Modding:Encounters_and_Population|population tables]] that can be chosen based on a common ancestor blueprint, a tag, or a variety of other qualities.
'''Faction encounters''' are a type of random generation that rarely occurs in a wide variety of zones, in which a legendary and their entourage are present.
Players will often refer to faction encounters as dynamic encounters even though they are different mechanisms with different purposes. Often, it's not necessary for an article to use either term, but when they are used, try to be consistent.
E.g., worshippers of Oboroqoru roll on a ''dynamic encounter'' table to determine their creature type. Finding a legendary Mechanimist while traveling the overworld is an example of a ''faction encounter''.
Finding a dromad trader and their entourage is similar to a faction encounter but is not labeled as such in the game code. Consider simply “encounter” or other phrasing.


==== “Monster” ====
==== “Monster” ====


Avoid the word “monster”, except as used in the game. Prefer “creature” instead, regardless of how the player or player character may feel about the creature in question.
Avoid the word “monster”, except as used in the game or patch notes. Prefer “creature” instead, regardless of how the player or player character may feel about the creature in question.
 
===== "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
 


==== “The” ====
==== “The” ====


While it is an established feature of technical writing, the “indefinite the”, i.e., the use of “the” followed by a singular common noun used to refer to an entire class of thing, is dispreferred in favor of using “a”/“an” and a singular noun, or no article and a plural noun. E.g.,
While it is a fixture of technical writing, the “definite generic”, i.e., the use of “the” followed by a singular common noun used to refer to an entire class of thing, is discouraged in favor of using “a”/“an” and a singular noun, or no article and a plural noun. E.g.,


* A slugsnout is a type of swine. – Fine
* '''No:''' The slugsnout is a type of swine.
* Slugsnouts are a type of swine. – Fine
* '''Yes:''' A slugsnout is a type of swine.
* The slugsnout is a type of swine. – Not Preferred
* '''Yes:''' Slugsnouts are a type of swine.


The idea is partly to make it clearer when something really is unique, e.g., “the Kesil Face”.
This helps make it clear when something really is unique, e.g., “the Kesil Face”.


==== Units ====
==== Units ====
Line 148: Line 174:


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


=== Spoilers ===
=== Spoilers ===
Line 169: Line 187:
* Content related to hidden content that is not easily encountered by players, such as [[Tzimtzlum]], ''should'' include spoiler warnings.
* Content related to hidden content that is not easily encountered by players, such as [[Tzimtzlum]], ''should'' include spoiler warnings.
* Content related to special enemies, such as the [[Girsh Nephilim]], ''should'' include spoiler warnings.
* Content related to special enemies, such as the [[Girsh Nephilim]], ''should'' include spoiler warnings.
=== Endgame Content ===
{{Spoiler}}
Any content that appears after the player character starts to ascend the Spindle (i.e. after the player types in <code>ASCEND</code>) is considered endgame content, and should be placed in the <code>Endgame:</code> namespace. This includes the endings themselves, as well as creatures, items, locations, conversations, and events that may occur after ascension.
If you are using QBE, it will automatically upload any object that appears in the endgame to the correct namespace.
All articles in the <code>Endgame:</code> namespace '''''must''''' be prefaced with the [[Template:Spoiler|Spoiler template]].


==Formatting==
==Formatting==
Line 184: Line 212:
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.
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, you should use favilinks. There are three favilink templates available:
If referring to other items and characters with a link, you should use favilinks. There are three favilink templates available, each with an easier-to-type equivalent:


* [[Template:Favilink]] takes the name of an item or mutation and links to it.
* [[Template:Favilink]] (or [[Template:F]] for short) takes the name of an item or mutation and links to it.
* [[Template:Favilink page]] takes the name of a page and links to it.
* [[Template:Favilink page]] (or [[Template:F page]] for short) takes the name of a page and links to it.
* [[Template:Favilink id]] is useful when you wish to specifically link to an object by its blueprint ID, a mutation by its mutation ID, and so on.
* [[Template:Favilink id]] (or [[Template:F id]] for short) is useful when you wish to specifically link to an object by its blueprint ID, a mutation by its mutation ID, and so on.


The differences between these favilink types can be relevant when objects or mutations share the same name, for example, the {{favilink id|NightVision}} implant and the {{favilink id|Mutation:DarkVision}} mutation. The table below shows how one might link to one page versus the other:
The differences between these favilink types can be relevant when objects or mutations share the same name, for example, the {{f id|NightVision}} implant and the {{f id|Mutation:DarkVision}} mutation. The table below shows how one might link to one page versus the other:


{| class="wikitable"
{| class="wikitable"
Line 196: Line 224:
! Examples
! Examples
|-
|-
| {{favilink id|NightVision}} (the implant)
| {{f id|NightVision}} (the implant)
|
|
* <code><nowiki>{{favilink|Night Vision}}</nowiki></code>
* <code><nowiki>{{f|Night Vision}}</nowiki></code>
* <code><nowiki>{{favilink id|NightVision}}</nowiki></code>
* <code><nowiki>{{f id|NightVision}}</nowiki></code>
* <code><nowiki>{{favilink page|Night Vision (implant)}}</nowiki></code>
* <code><nowiki>{{f page|Night Vision (implant)}}</nowiki></code>
|-
|-
| {{favilink id|Mutation:DarkVision}} (the mutation)
| {{f id|Mutation:DarkVision}} (the mutation)
|
|


* <code><nowiki>{{favilink page|Night Vision}}</nowiki></code>
* <code><nowiki>{{f page|Night Vision}}</nowiki></code>
* <code><nowiki>{{favilink id|Mutation:DarkVision}}</nowiki></code>
* <code><nowiki>{{f id|Mutation:DarkVision}}</nowiki></code>
|}
|}


Note that mutations linked with [[Template:Favilink id]] must be prefixed with <code><nowiki>Mutation:</nowiki></code> to distinguish them from object blueprint IDs.
Note that mutations linked with [[Template:F id]] must be prefixed with <code><nowiki>Mutation:</nowiki></code> to distinguish them from object blueprint IDs.


Use of favilink should follow [[#Links | the general rules for linking]].
Use of favilink should follow [[#Links | the general rules for linking]].
Line 260: Line 288:


Before submitting fan art to this wiki, please read through the following rules. The [[Caves_of_Qud_Wiki:Community_portal#Community_administrators|wiki administrators]] may remove any content uploaded to the wiki at their discretion, for reasons including but not limited to violation of the rules below.
Before submitting fan art to this wiki, please read through the following rules. The [[Caves_of_Qud_Wiki:Community_portal#Community_administrators|wiki administrators]] may remove any content uploaded to the wiki at their discretion, for reasons including but not limited to violation of the rules below.
==== Types of work that are appropriate ====
As long as you obey the rules below, any fan art related to Caves of Qud may be uploaded to the wiki. This includes
* depictions of characters and creatures that exist in the game;
* art of locations or events from the game;
* original characters (OCs) based on the player character;
* objects, furniture, and OCs that exist in the universe of Qud;
and so on. In general, work can be added to any page that is at least tangentially relevant to it. For example:
* If you have a stylized depiction of a snapjaw, then that would certainly be relevant to the [[Snapjaws]] page or a more specific page, such as {{f|Snapjaw Scavenger}}.
* An OC that comes from the [[Mopango]] faction could be added to the [[Mopango]] page.
* An OC with the {{f|Multiple Arms}} mutation could be added to the page for that mutation.
If you have questions about whether a particular work of art would be appropriate for the wiki and where it could go, please ask in <code>#wiki-discussion</code> in the Caves of Qud wiki.


==== No NSFW content ====
==== No NSFW content ====
Line 285: Line 330:


All work submitted to the wiki, '''including original works of art''', are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike license (CC BY-NC-SA 4.0); see [[Caves of Qud Wiki:Copyrights]]. This gives the wiki and the Caves of Qud community the right to freely download, share, and adapt your work under the same Creative Commons license. '''Do not submit copyrighted work without permission!'''
All work submitted to the wiki, '''including original works of art''', are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike license (CC BY-NC-SA 4.0); see [[Caves of Qud Wiki:Copyrights]]. This gives the wiki and the Caves of Qud community the right to freely download, share, and adapt your work under the same Creative Commons license. '''Do not submit copyrighted work without permission!'''
==== Distinguishability from in-game content ====
Any fan art added to a page should be ''easily distinguishable'' from in-game content, so as not to confuse readers of the page. For example, please don't upload a tile for a [[Mechanimists]] creature you modded in and add it to the Mechanimists page, because readers may not be able to clearly delineate between your work and work from the original game.
Caves of Qud has a very idiosyncratic art style and this rule will not apply to most works uploaded to the wiki. However, if you're concerned that your work may confuse readers, you can choose to add a frame and [https://www.mediawiki.org/wiki/Help:Images caption it] in a way that clearly marks the work as coming from outside of the game.


=== How to add your art to a page ===
=== How to add your art to a page ===
Line 300: Line 351:
On the page containing the image you uploaded, click <code>Edit</code> and then add the following line to the page:
On the page containing the image you uploaded, click <code>Edit</code> and then add the following line to the page:


<syntaxhighlight lang="plaintext">
<!-- By advice of https://www.mediawiki.org/wiki/Extension:SyntaxHighlight#Supported_languages -->
<syntaxhighlight lang="moin">
[[Category:Fan Art]]
[[Category:Fan Art]]
</syntaxhighlight>
</syntaxhighlight>
Line 310: Line 362:
Now add your art to the page of your choosing! To do this, you'll need to visit the page you want to add your work to, hit <code>Edit</code>, and then link to your art.
Now add your art to the page of your choosing! To do this, you'll need to visit the page you want to add your work to, hit <code>Edit</code>, and then link to your art.


For example, suppose that your art was uploaded to [https://wiki.cavesofqud.com/wiki/File:Super_Cool_Dromad.webp File:Super_Cool_Dromad.webp]. Then to link your art in the {{favilink|Dromad}} page (or perhaps the [[Dromad merchants]] page), you would go to that page, edit it, and then add the following line to the page in the location that you want to upload it:
For example, suppose that your art was uploaded to [https://wiki.cavesofqud.com/wiki/File:Super_Cool_Dromad.webp File:Super_Cool_Dromad.webp]. Then to link your art in the {{f|Dromad}} page (or perhaps the [[Dromad merchants]] page), you would go to that page, edit it, and then add the following line to the page in the location that you want to upload it:


<syntaxhighlight>
<syntaxhighlight lang="moin">
[[File:Super_Cool_Dromad.webp]]
[[File:Super_Cool_Dromad.webp]]
</syntaxhighlight>
</syntaxhighlight>
Line 318: Line 370:
If you want to add a caption (e.g. to attribute the artist), you can do so with
If you want to add a caption (e.g. to attribute the artist), you can do so with


<syntaxhighlight>
<syntaxhighlight lang="moin">
[[File:Super_Cool_Dromad.webp|frame|Created by Mr. Super Cool Dromad Lover]]
[[File:Super_Cool_Dromad.webp|frame|Created by Mr. Super Cool Dromad Lover]]
</syntaxhighlight>
</syntaxhighlight>
In general, you can choose where you'd like to place the art. By convention, art should ''generally'' be added to the bottom of a page before any navboxes, footers, or appendices. However, if you believe that your art may belong in a different area of the page (e.g. at a certain point in a guide where it may be relevant), you are free to add it there instead.


Hit the <code>Save changes</code> button, and you're done! MediaWiki supports many different ways of formatting your images; see https://www.mediawiki.org/wiki/Help:Images for all of the options that are available to you.
Hit the <code>Save changes</code> button, and you're done! MediaWiki supports many different ways of formatting your images; see https://www.mediawiki.org/wiki/Help:Images for all of the options that are available to you.


[[Category:Caves of Qud Wiki]]
[[Category:Caves of Qud Wiki]]