Satisfactory Wiki:Style guide

This page is a guide to creating or editing mainspace pages at Satisfactory Wiki in accordance with the established article style. These guidelines are not set in stone, but they should generally be followed in order to maintain consistency across pages, unless there is a good reason to make an exception.

General guidelines

Language and units

Text should generally follow formatting and grammar as usual on wikis. Wikipedia's Manual of Style provides a detailed overview. However, it does not need to be followed as strictly here, since this is a video game wiki after all, not an encyclopedia. Styling that should be used is notably:

• using proper grammar
• using MediaWiki formatting in favor of plain HTML wherever possible
• avoiding speaking to the reader, except for tips sections and tutorials

The default game language is US English, therefore, the wiki should use US English as well.

• Color not Colour
• Aluminum not Aluminium
• Sulfur not Sulphur
• Meter not Metre
• Labeled not Labelled
• Signaling not Signalling

etc.

The units page discusses units present on the wiki. Same applies to the formatting of numbers, discussed below.

For consistency, the plural of gas is spelled gases, not gasses.

Capitalization

All in-game entities with their name explicitly spelled out should follow the in-game case.

• Reinforced Iron Plate
• Supercomputer
• AWESOME Sink
• Resource Well
• Head Lift

Other phrases which are not a specific name should use lowercase (inside sentences) or sentence case (beginning of sentences, article names).

• Resource node

Page names

Pages describing a single subject should follow casing rules described above. Pages for groups of subjects generally use word case to mimic in-game casing, such as Conveyor Poles or Train Signals, even though it would be acceptable to not capitalize either in text.

Additionally, page names should avoid special characters, even if their use in the software is permissible (FICS⁕MAS < FICS*MAS < FICSMAS).

Experimental content

The wiki prefers content in the stable branch of the game over experimental, as discussed here.
In a nutshell, experimental content never replaces early access content, but is rather presented alongside it and the differences marked as such.

• If the entire topic of a page is only available in one branch, the page should have a notice at the top using {{Unreleased|Early Access}} or {{Unreleased|Experimental}}.
  • This means that a feature removed in experimental is only available in early access.
  • The {{Removed}} template is used for features that have been removed in both branches.
• If a feature changed between branches:
  • In-line text is differentiated using {{EA}} and {{EX}}. The experimental text is in a bracket following the early access text. Example: The Fluid Freight Car can carry 1600 m^3[EA] (2400 m^3[EX]) of fluid.
  • Alternatively, a section titled "Experimental" can be added to the bottom of the page, denoted using {{Unreleased|Experimental}}, describing changes in one, concise section.
• Images are not replaced with the experimental only version. They may only be reuploaded separately if the target has been renamed, under the new name.
• UI icons are not replaced with the experimental only version, nor are they reuploaded as a separate file.
• Pages are not moved to stay in trend with new names of features.
  • Example: Patch 0.3.6 introduced Mk.2 Pipelines and simultaneously appended "Mk.1" to "Pipeline" to more clearly distinguish them. If both Pipelines were maintained on separate pages, this would mean that Mk.1 Pipelines would be on a page named "Pipeline" (consistent with Early Access), while Mk.2 Pipelines would be on a page named "Pipeline Mk.2".

History sections are exempt of this rule, as mentioned below.

Upcoming content

Upcoming content is content that has been officially teased and is expected to be introduced to the game in a future update.

• In order to prevent many stub pages being created (as there is usually little or just not enough information about teased features), all upcoming content should be listed on the Future content page.
• Certain exceptions can apply, which are situational (e.g. the Crab Boss is unusually notable, due to being teased since the E3 trailer).
• Even if enough information for a feature is gathered, it should remain on the Future content page. Pages created despite this should be marked as upcoming content using {{Unreleased|Upcoming}}.

Numbers

• Spell out numbers if it is below 10 (zero to nine) and is mentioned as a single number in the context. Use numeric (Arabic) notation otherwise.
• Where large numbers are mentioned, every 3 digits should be separated with a comma, such as 1,234,567,890. Spaces are not required.
• Periods should be used as decimal separator, such as 0.5 etc.
• Where superscript is to be used, prefer template over Unicode as the latter is smaller and thus more difficult to read. These templates is a shorthand to call <sup> (2 or 3) </sup>
  • 45 m{{cubic}} = 45 m³
  • 300 {{m3pm}} = 300 m³/min
  • 30 km{{sq}} = 30 km²
• To represent a long decimal with specified decimal points, use {{rounding| The Number | Number of decimal points}}. The full decimal can be viewed when mouse hover the number.
  • {{rounding|8.1234|1}} = 8.1
  • {{rounding|8.123456|4}} = 8.1235
  • {{rounding|8.1234|0}} = 8

Control

Where specific control keys are to be executed, use the following template:

• {{key|A}} A
• {{key|tab}} Tab ↹
• {{key|left}} ←
• {{key|ctrl}}+{{key|A}} Ctrl+A
• {{mouse|left}}
• {{mouse|middle}}

History

This section of the page should list changes to the article topic based on game patches. It should generally follow the official changelog, but sometimes there are undocumented changes introduced in updates. In those cases, the information should be based on in-game testing.

• Entries are listed retroactively: The most recent change is at the top and the oldest at the bottom.
• Entries start with the patch that is always linked.
• If there was only one change in a patch, the entry is on one line.
  • If there were multiple, all notes for that patch are indented, and the first line only has the patch.
• If it has zero entries, {{HistoryMissing}} is used to mark it as missing. If it has some entries but is either outdated or there are uncertainities, {{HistoryMissing|Incomplete}} is used to mark it as such.
• Only include changes that directly affected the page topic, not changes that were only related. For example:
  • Assembler's building cost is changed and no longer requires Modular Frames – this is mentioned in the Assembler's history, but NOT in the Modular Frame history, as Modular Frames didn't change themselves, only its usage did.
  • Aluminum production was rebalanced – this is mentioned in the history of Alumina Solution, Aluminum Scrap, Aluminum Ingot etc., but NOT in the Bauxite history, the raw ore still behaves the same itself.
• If it has been introduced as brand new, the entry should say just "Introduced". If it was implemented from being previously unobtainable (unreleased), it should say that it "has been made officially available".
• If it never has changed, there should be only one point saying "No changes".
• Unlike the rest of the wiki, entries prefer experimental over stable. Therefore, if something changes in experimental before it goes to stable, only the experimental change is mentioned.
  • This is because something can change in experimental and then be reverted back, which would result it not being mentioned at all.
• Reformat entries to sound relevant.
  • For example, Patch 0.4.0.4 patch notes include the following change:
    • Certain buildings can now be rotated 45 degrees when placing instead of only 90 degrees: Jump Pad, U-Jelly Landing Pad, Street Light, Personal Storage Container, Light Control Panel, Power Switch, M.A.M., AWESOME Shop, Craft Bench, Equipment Workshop.
  • Such change would be formatted as "X can now be rotated 45 degrees when placing instead of only 90 degrees", NOT "Certain buildings can now be rotated 45 degrees when placing instead of only 90 degrees: X".
• If there are changes that are not mentioned in any patch notes, or the exact patch in which the change occured is not known:
  • Use "Unknown Patch before/after (link to patch)" or "Unknown Patch between (link to patch) and (link to patch)" for when it was added into the game.
    • Alternatively, "Unknown Update X patch" can be used (where a certain update refers to any patch during the development of that update).
  • Include references if possible.

Examples of good history sections: Geothermal Generator, Cable, Electric Locomotive

Images

Images should follow these general guidelines:

• All images:
  • Categorize and apply the license on all images on upload.
  • Use simple, short, recognizable filenames. "Raw Quartz node in a cave.jpg" is a far better filename than "Picture of a quartz node I found in a cave full of spiders while exploring rocky desert.jpg".
• For user-made in-game screenshots:
  • Crop image whenever possible. Cropping should be aimed to minimize file size.
  • When UI is the subject, avoid blending the UI with bright background, which can be best avoided by viewing against a black background.
  • If taking a screenshot of a subject, ensure there is nothing intrusive in the way. If UI is not relevant in the screenshot, use Photo Mode to hide the UI. Holster / de-equip any equipment, which usually takes up screen space.
  • Unless transparency is necessary, use JPG, aiming for filesizes of about 300 kB or less. WebP is another alternative which allows for transparency. The resolution of the screenshot can be usually reduced as well.
  • PNGs can be compressed using tools online, which can reduce their size by 30-70% without any visual loss of quality.
• For user-made infographics or similar non-screenshot images:
  • Just as with in-game screenshots, avoid intrusive elements in the image and aim for the smallest filesize.
  • Screenshots of third-party tools using assets from Satisfactory use {{License/third-party}}.
• For UI icons extracted from the game:
  • Use the highest resolution available (as there are usually two or three resolutions of the same UI icon).
  • Do not alter the images in any shape or form.

Game character

Where the player-controlled character is mentioned, Pioneer should be used. Where gender is referred, use She.

Formatting

• When forcing a line break, use <br /> tag.
  • A double return (↵ Enter↵ Enter) creates a similar effect but with different spacing.
  • Transitioning from paragraph and number bullets or point bullets automatically create line break.
  • One empty line between 2nd tier headings. No empty line is required between 3rd tier headings.
  • Some module or template automatically includes line break. Be sure to preview the edits before deciding whether additional line breaks are required.
• When a non-line breaking space is required, use </nbsp> tag.
  • This will force the line break to be happen before (or sometimes after) the words joined by the non-breaking space.

Notices

• {{Stub}} is used to mark new pages that do not cover the feature sufficiently.
• {{Cleanup|details}} is used to mark pages that do not mark quality requirements, such as those described in this style guide.
• {{Outdated}} is self-explanatory.
• {{Unreleased|branch}} is used for features with specific availability, such as only being in one branch, upcoming, unreleased, etc.
• {{Delete|reason}} is used to mark pages for deletion. A page can be marked for deletion if it isn't notable enough or unmaintained. An administrator routinely checks pages and files marked for deletion and either proceeds with deletion, or suggests other action.
• {{DisambigMsg|about|more info description|wiki page link}} is used to mark pages with disambiguous text that needs clarification.
• {{Disambig}} is used on disambiguation pages that lists articles associated with the same title.

Other

• Whilst the Discord role is a capitalised singular term "COFFEESTAINER", the mixed-case usage appears on the Coffee Stain website as "Coffee Stainer".

Item page format

Item, fluid and equipment pages start with a brief description of the item that either mentions how it is obtained or used. {{Infobox item}} (or {{Infobox simple}}, in special cases) is used, and is placed before this mean section, but after any notices there may be on the page.

Obtaining

Subsection name	Used when	Content
Unlocking	Unlocked via M.A.M. research	{{MAMunlock}}
	Unlocked via the AWESOME Shop	{{Shopunlock}}
Resource acquisition	Item is a raw resource	{{OreGeneralDescription}}
Crafting	Always, unless it's a natural item or collectible	{{Recipes producing|className}}

Usage

Subsection name	Used when	Content
Space Elevator	Project Assembly parts	{{Elevatorusage}}
Research	Used in any M.A.M. research chain	{{MAMusage}}
Equipment	Used in any M.A.M. research chain	Details on the equipment's functionality, such as used ammo or fuel
Crafting	Always	{{Recipes using|className}}
AWESOME Sink	Always, excluding fluids	{{Sinkusage}}

Tips

If there are any tips to be mentioned, they shall be listed here.

Trivia

If there is any trivia, it shall be listed here.

Current issues

If there is any bugs, glitch or their work-around, it shall be listed here. Besides that, make sure to report such bugs to https://questions.satisfactorygame.com/ .

External links

If there are any external guides immediately relevant to the page, they shall be listed here. This section is only for external links, while intrawiki links should be in the See also section below.

See also

If there are any related articles, they shall be listed here. Only intrawiki links should be listed here.

Gallery

<gallery>
File:image1.png|Image caption 1
File:image2.png|Image caption 2
<gallery>
If the page has any specific images to be displayed, it shall be here in its own gallery section.

• For files enclosed by the <gallery> tag, the leading text File: may be omitted, although any subsequent visual edits may automatically add them back.

History

History follows general guidelines as mentioned above.

References

If the page has any references, use {{Reflist}} to list them here automatically. The references should be mentioned in the main context and be enclosed, such as:
Statement one (in the main text).<ref>source website address</ref>

Navboxes shall be placed at the very bottom of the page. All item pages use {{ItemNav}}. Additionally, if the item is a fluid or packaged fluid, {{FluidsNav}} is placed above it.

Patch notes format

The lead section of patch notes is always created using the {{Patch}} template. See its documentation for details.

If there was a hotfix released that didn't increment the version number but changed the build number, it should be mentioned in the mean section. If there was an additional note added to the patch notes, it should be in its own section named Hotfix that is placed before the intro. See Patch 0.3 for an example.

Major updates have their logo at the very top of the page and key art at the bottom. Additionally, it is noted whether a patch is the "first" of a major update or if it "brings its features to the stable branch". See Patch 0.4.1.0 for an example.

Occasionally, a series of patches is released on experimental only, with the latest of the series being pushed onto the stable branch with the same build and version, but patch notes listing all changes of the series. To distinguish these, the earlier experimental release gets (Experimental) added to its title. See Patch 0.2.1.17 (Experimental) and Patch 0.2.1.17 for an example.

Intro

The intro text that precedes the actual patch notes.

Patch note sections

Each patch note section has its own header, which is not in all caps (as formatted by default) and uses sentence case instead. Quality of Life is an exception, as the L gets capitalized.

Note that patch notes from Discord have preformatted bullet points (•), those should be replaced with normal lists:

• Change 1
• Change 2

Correct formatting:

• Change 1
• Change 2

Each page ends with {{PatchesNav}}. No categories are added manually.