Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing to the Wiki

Contributors and reviewers share responsibility for our Mission and Community Standards. Review the work constructively, explain requested changes, and help contributors improve. Personal attacks and public humiliation are unacceptable. Good-faith disagreement and criticism are welcome.

You can check what pages need fixing/content on the github Issues section.

This wiki is hosted on GitHub Pages using mdBook, a modern static site generator.

However, don’t worry! It is simpler than it seems. You do not need to download the code (although you can if you want to edit it locally). Follow the steps below:

1) If you do not have one yet, register for a GitHub Account here.

2) Fork the wiki by going to the main project page here and pressing the Fork button on the top right.

image

3) Your fork is now ready to contribute to! You can edit pages directly on GitHub using the web editor.

4) When you feel that your changes are good enough, open a pull request to the main repository. To do this, go to your fork and click Pull Requests → New Pull Request, then follow the prompts.

5) Make sure you regularly sync your fork with the main repository to stay up to date! On your fork page, click Sync fork and select Update branch to pull in the latest changes.

Editing on GitHub (No Download Required)

The simplest way to contribute is to edit directly on GitHub:

  1. Navigate to the file you want to edit in the src/ folder
  2. Click the Edit (pencil icon) button in the top right
  3. Make your changes in the markdown editor
  4. Scroll down, write a commit message describing your changes, and click Commit changes
  5. Create a pull request with your changes
  6. A maintainer will review and merge if approved

Wiki pages are written in markdown (.md files) — learn more about markdown syntax here.

Local Development (Download & Edit)

If you prefer to edit the files locally, test changes, or experiment with the website layout:

Prerequisites

  • Python 3 on any platform. python3 scripts/setup_tools.py downloads the pinned mdBook and plugin binaries into a local tools/ folder.
  • Rust is optional: it is only used to build the emoji preprocessor, and the wiki builds without it.

Setup

  1. Fork and clone the repository to your computer

  2. Using your preferred git client (or GitHub Desktop), clone your fork

  3. Navigate to the civ13-wiki/ folder in your terminal/command prompt

Building & Serving

Any platform (Windows: use py -3 instead of python3):

# One-time setup, then build and open in browser
python3 scripts/setup_tools.py --run build --open

# For development with live reloading
python3 scripts/setup_tools.py --run serve

The wiki will be served at http://localhost:3000. When using mdbook serve, the page automatically refreshes whenever you save changes to markdown files.

File Organization

  • src/ — All markdown source files (the content you edit)
  • src/SUMMARY.md — Wiki table of contents and navigation structure. Every page must be listed here exactly once; the Guides and Maps overview pages are generated from it (run python3 scripts/nav.py --write after changing it)
  • images/ — Images and sprites used in pages
  • book/ — Compiled output (generated automatically, do not edit)
  • theme/ — mdBook theme customization

Starting a new page

Start from a template so new pages share one shape:

python3 scripts/new_page.py guide "Guide to Beekeeping" --group "Food & Animals"
python3 scripts/new_page.py map "Verdun" --group "Early Firearms (1650 to 1930)"
python3 scripts/new_page.py gamemode "Train Raid"

This copies templates/<kind>.md into the right folder, lists the page in SUMMARY.md under the named group (or at the end of the section), and regenerates the overview pages. Replace every placeholder before opening a pull request; delete a section rather than leaving it empty.

Keeping pages current

A monthly report lists pages that have not been edited in twelve months. After checking a page against the game and finding it still right, add a review marker on its own line near the top so it drops off the report:

<!-- reviewed: 2026-11-05 -->

Map pages

Map pages live in src/maps/ and are listed in SUMMARY.md under the vote group the in-game map vote uses (era for team combat, mode for roleplay). A map belongs in an active group only while it has an uncommented entry in the game’s map vote lists; otherwise list it under Not in Rotation rather than deleting the page, so it is ready when the map returns.

A complete map page has the generated layout render, the sides or factions, the objective or win condition, and any rules that differ from the mode guide. A page that still only has the render keeps its How to contribute section until someone fills it in.

Adding Images

When adding images to wiki pages:

  1. Upload your image to the images/ folder (or appropriate subfolder like images/entities/, images/food/, etc.)
  2. Reference it in markdown using: ![description](images/your-image.png)
  3. Make sure the filename is unique to avoid conflicts with existing images

Images

Admonitions

Call-out boxes use the admonish fenced block. The first word picks the style: note, tip, info, warning or danger. Keep them short and use warning and danger only for things that get a character hurt or a player banned.

```admonish warning
Avoid drinking raw water from puddles, rivers and lakes; boil it first.
```

DMI Sprites (<dmi-sprite>)

The wiki supports rendering sprites directly from .dmi files (the icon format used by BYOND/SS13) using a custom HTML element.

Note

Sprites are fetched over HTTP and will only display when the wiki is served via a web server (e.g. mdbook serve, or the live GitHub Pages site). They will not appear when opening an .html file directly from the filesystem (file://), due to browser security restrictions on cross-origin fetching.

Basic syntax

<dmi-sprite src="URL_TO_FILE.dmi" state="state_name"></dmi-sprite>

Attributes

AttributeRequiredDefaultDescription
src✅ Yes—Full URL to the .dmi file. Use raw GitHub URLs, e.g. https://raw.githubusercontent.com/civ13/civ13/master/icons/...
state✅ Yes""The icon state name inside the DMI to display (case-sensitive, must match exactly).
dirNosouthDirection to display. Accepts: south, north, east, west, southeast, southwest, northeast, northwest (or their BYOND numeric codes 1, 2, 4, 8, etc.). Falls back to south if the state has fewer dirs.
animatedNofalseSet to "true" to play the animation if the state has multiple frames.
scaleNo1Integer pixel scale multiplier. Use 2 or 3 for a larger display (e.g. a 32×32 sprite becomes 64×64 or 96×96).

Examples

Static sprite (south-facing, default size):

<dmi-sprite src="https://raw.githubusercontent.com/civ13/civ13/master/icons/obj/items.dmi" state="knife"></dmi-sprite>

Animated sprite, scaled up 2×:

<dmi-sprite src="https://raw.githubusercontent.com/civ13/civ13/master/icons/mob/human.dmi" state="human" dir="south" animated="true" scale="2"></dmi-sprite>

Centred in a paragraph (wrap in a <div> or <p>):

<div style="text-align: center;">
  <dmi-sprite src="https://raw.githubusercontent.com/civ13/civ13/master/icons/lobby/lights_out.dmi" state="lights_out" animated="true" scale="2"></dmi-sprite>
</div>

Tips

  • The src must be a raw GitHub URL (starting with https://raw.githubusercontent.com/), not a regular GitHub page URL.
  • State names are case-sensitive and must match the name as it appears inside the .dmi file exactly.
  • If nothing appears, check that the state name is correct and that you are viewing the page through a server (not via file://).
  • You can mix <dmi-sprite> with regular markdown or HTML — it is an inline element by default.