Style guide¶
The rules every page on this wiki follows. The writing rules live in WRITING-STYLE.md at the top of the repository and are included here, so this page always matches them.
Who we write for¶
Players. Someone between rounds who wants an answer, or someone new who wants to understand a mechanic. They know shooters and the game's own terms (HP, XP, AUX, sprint, loadout). They don't know Source engine internals or C++, and they shouldn't need to.
Their attention is limited, so every sentence has to earn its place.
Voice¶
- Plain and direct. Address the player as you, in the present tense.
- Open with what the thing is and why it matters. Name the subject in bold in the first sentence.
- Lead with what it means for the player: what to do, what to expect, what to avoid. How the code does it comes second, if at all.
- One idea per sentence. Keep sentences short, and paragraphs to one to three sentences.
- Use everyday words. Say hitbox, not hull. Leave out function names, file names and engine terms like tick and renormalised unless the reader needs them; if they do, explain the term once.
- Cut filler, hype and hedging that carries no information.
- British spelling (colour, armour, behaviour). Code identifiers and quoted strings keep their own spelling.
- Headings in sentence case: Weapon speed scale, not Weapon Speed Scale.
Keep the load light¶
- No more than two numbers in a sentence. Round in prose ("about 24 seconds") and give exact figures in tables and infoboxes.
- Move the mechanics out of the way. Formulas, code behaviour and edge cases most readers can skip go in a collapsed Technical details box at the end of the section. The box keeps its citations, so nothing is lost.
- Put server settings last. Console variables only server admins can change go under a For server admins heading at the end of the page.
- Use lists for sets of conditions, and tables for comparisons. A sentence that lists four conditions is a list.
- One caveat, once. If something is unconfirmed, say so in one callout, not in every sentence that touches it.
For example, instead of:
Each cloaked player has a visibility factor from 0 to 1 that controls how strong the shimmer and tint are. Standing still (≤20 u/s) lowers it by 1.1 per second; moving raises it by speed × 0.004 per second.
write:
The faster you move, the more you shimmer. Stand still and the shimmer fades in about a second.
and put the first version in the Technical details box.
Facts and sources¶
- Every gameplay number cites the line it comes from.
[[src:path:line]]becomes a footnote linked to the game's source at the pinned commit. - A citation never comes between a number and its unit. Write it after the unit (
5/s[1],200 units per second[1]). In a numeric table column the build moves it in front of the number, so the numbers in the column stay aligned; you still write it after the value. The build also fixes it if you write a unit after{{stat:…}}, whose citation follows the number. - Never guess. If the code is ambiguous, or client and server disagree, say so in an amber callout labelled Unconfirmed, Unverified or Unresolved.
- Say how a claim was established: "inferred from the code" is different from "tested in game".
- Tables and infoboxes take their numbers from the extracted data, not from hand-typed copies.
- Rewording must not change a fact. Rounding in prose is fine when the exact figure is in a table, infobox or Technical details box on the same page.
Numbers and units¶
Spell units out in prose and abbreviate them in data. In data, an abbreviated unit sits right against its number, with no space: 0.5s, 5/s, 256u/s. Game terms keep theirs: 225 HP. Prose is anything written as a sentence: paragraphs, list items, callouts and table captions. Data is table cells, infobox values and stat strips.
| Quantity | In prose | In data |
|---|---|---|
| Time | 2.16 seconds, 250 milliseconds, 3.25 minutes | 2.16s, 250ms, 3.25min |
| Speed | 256 units per second | 256u/s |
| Distance | 150 units; metres only where the game uses them | 150u, 45.72m |
| Angle | 1 degree | 1° |
| Multiplier | ×0.85, times sign and no space | ×0.85 |
| Range | 0.675–1.0, en dash and no spaces | 0.675–1.0 |
| Damage | Effective damage, with the ×1.485 modifier applied, unless labelled base | 17.82 (base 12) |
| Game terms | HP, XP, AUX, RPM: players know these, so keep them short | 225 HP |
As an adjective, hyphenate: a 10-second delay, a 13-second cloak.
Names¶
- Weapons use their in-game display names: MPN45, SRM-S, ZR68-L, Murata Supa-7, MilSO.
- Classes are capitalised: Recon, Assault, Support.
- In tight table columns, Recon, Assault and Support shorten to R, A and S, always in that order. Where a column also gives the XP a class needs, write the letter and the number together: R4 A10 S20. A letter alone means no XP is needed. The column's tooltip explains the notation, and each entry has its own tooltip naming the class and the rank.
- Game modes take the full name first, then the code: Capture the Ghost (CTG).
- Teams: Jinrai and NSF. The objective is the ghost, lowercase in running text.
- Thermoptic camouflage is the cloak after its first mention.
- Console variables and file names go in
code, with their default where it matters:mp_friendlyfire 1.
Page anatomy¶
- A
# Title, and a one-linedescriptionin the front matter - A lead of one or two short paragraphs that stands on its own
- An infobox for classes, modes and mechanics with stats
- Sections under
##headings. The contents list on the right is automatic. - For server admins, if the page has any
- The generated references, last
Game mode pages open with an Objective section (what each side is trying to do, then the win conditions table) and a Round flow section (the phases of a round in order, and how a match ends), before anything else.
Weapon pages follow one layout, in this order: Overview, General stats, Damage, Shots to kill, Time to kill, Handling, then anything weapon-specific (bolt action, heat), Availability, Suppressor and Technical notes. The prose is yours to write; the numbers come from {{weapon:…}} snippets, which read the weapon named in the front matter (weapon: weapon_zr68s).
- Comparisons go in tables, not lists. Numbers are right-aligned in monospace.
- Every column header in a data table has a tooltip saying what it means. Tips live in
wiki/column-tips.yml: once per header undercolumns, or underpagesfor a header that means something different on one page. A generated table can also pass its own. Write a tip's header the way the table shows it, with data units closed up (Pen. to cross 12u, not12 u): the build closes up units before it looks the tip up. The build warns about any header without one. - Hit locations with the same multiplier share a column: head / chest, stomach / arms, legs.
- Link a page's first mention in each section, not every mention.
- Page addresses follow the menu:
/weapons/rifles/zr68-s/. Folders and file names are lowercase with hyphens, and every slug is unique across the wiki.
Markup¶
[[slug|Label]]links to another page. A slug is the file name without.md, or the folder name for anindex.md.[[slug#heading|Label]]links to a section of another page.[[src:path:line]]is a citation. Separate several with;.{{table:…}},{{stat:…}}and{{weapon:…}}insert tables and numbers generated from the data.{{stat:player:classes.recon.stats.run_speed}}inserts one cited value fromwiki/data/player.json. Name an item in a list by itsid, never by its position; the build rejectsclasses.0.!!! info "Label"is a neutral callout, for notes.!!! warning "Label"is an amber callout, for anything quirky, unverified or in progress.??? note "Technical details"is the collapsed box for mechanics most readers can skip.
Indent a callout's or box's body by four spaces.
Rewriting a page¶
When you reword an existing page, for clarity or to bring it up to this guide:
- Keep every citation, word for word. Move it with the fact it supports, for example into a Technical details box, but never drop or edit it.
- Don't lose a number. If one leaves the main text, it goes into the Technical details box. Rounding in prose is fine when the exact figure stays on the page.
- Don't change a fact or add one. If you can't say something more simply without changing what it means, leave it as it is.
- Leave generated parts alone:
{{…}}snippets, infobox data and table cells. Table captions are prose, so reword those. - Check links before renaming a heading. Other pages link to sections with
[[page#heading|…]]; search for the heading's anchor first. - Build with
mkdocs build --strict(fromwiki/). It fails on broken links and unknown snippets.
Modes in development¶
- Game modes still in development are named only on their own pages, along with the roles they assign and the weapons those roles use. Nothing else in the wiki mentions them: not class, weapon or map lists, not comparisons, not the main page, not this guide. The one exception is the table of modes on the Game modes page, where they're tagged WIP.
- Their own pages open with an amber Work in progress callout and a neutral Not a class you can pick callout, and hold everything about the mode: its role, the role's stats and weapon, and its server settings.
- Text that comes from the data is filtered so it doesn't name them. The build warns about any page that does.
Visual¶
- Dark by default, minimal, neutral, with a light theme one click away. Hairline borders; no shadows, gradients or emoji.
- Blocks are rounded: 8px on tables, callouts, cards, infoboxes, code and the search box; 6px on navigation items.
-
Text uses four sizes, set as tokens in
ntre.css(in rem, so they follow Material's scaling and the reader's browser settings). At the default size:- Prose, 13px: body text, lists, card titles
- Secondary, 12px: callouts and Technical details, card text, the menu and contents, search, references, footer, infobox titles
- Data, 10.8px: tables and their captions, stat strips, infobox rows, tags, keys
- Marks, 9px at least: citation markers, so they stay clickable in tables
Headings scale from the prose size. - Tables never sit beside an infobox: they start below it and take the full width, so they're never squeezed or cut off. Prose still flows beside it. - In numeric table columns, citation markers come before the value, so the numbers line up on their right edge. Text cells and infoboxes keep them after the text. The build moves them; write citations after the value as usual. - Red is for the brand dot only: after page titles and beside the current page. Never for link text, because red text means a missing page. - Link underlines are a cool, desaturated cyan. On hover the line fills left to right, snaps into place, pulses once and settles. Cards lift to a lighter surface on hover instead. - Icon buttons, like "Edit this page", are small: the icon at 60% of the theme's size, in a circle with a hairline border. They stay muted until hovered. - The NT;RE mark is the primary logo. The wordmark appears only on the main page. - Image slots are grey placeholders labelled with what belongs there, until assets are licensed.
Details: Colours & type and Logos.