Skip to content

Latest commit

 

History

History
19 lines (18 loc) · 2.55 KB

MANUAL_OF_STYLE.md

File metadata and controls

19 lines (18 loc) · 2.55 KB
Raw

Follow these conventions when adding or editing in-game text. Theses conventions apply to the default US English language, translations should follow guidelines from /lang/notes/ if there are any for the language in question, which can be different that the ones here.

  1. Use US English spelling.
    1. The exception here is for some character dialogs, as some characters can use other than US English dialects. For example, Exodii/Rubik uses Cockney dialect in combination of Early Modern English.
  2. Use double sentence spacing after periods. This means that a period that ends a sentence should be followed by two spaces. If the sentence is the last in the block of text, there should be no spaces following it.
    1. Translations may not always use two spaces, so make sure to use a translation wrapper, _(" "), when appending spaces in code.
  3. Use second person point of view (eg. "you").
  4. The names of stats, traits/mutations, scenarios, professions, backgrounds, proficiencies, martial arts, and Compact Bionics Modules (CBMs) should be in title case. This means that each word should be capitalized unless it is an article, preposition, or conjunction.
  5. Items and entities with proper noun names should also be in title case.
    1. This includes: Cataclysm, Discontinuity (an event in Aftershock), Exodii, Marloss, Mycus, Autodoc, Kevlar and Nomex.
    2. Unique currencies, such as "merch", should be written lowercase unless the name includes a proper noun, such as in "Hubcoin".
  6. All other item and entity names should be in all lower-case letters.
  7. Use the serial comma (Oxford comma).
  8. Use ellipsis character (…) instead of three dots (...). Replace instances of three periods with the dedicated Unicode character for ellipsis, namely U+2026. As to the specifics of using it:
    1. No spaces before it and one space after it.
    2. This character does not end a sentence, use ellipsis followed by a period …. when ending a sentence with ellipsis.
  9. Brand names do not need to be avoided as we are covered under fair use. However, as CDDA-Earth is a parallel universe, nonexistent brands are also allowed.
  10. Don't avoid using Unicode letters, which includes proper names and alphabets when needed, or symbols as ® or ™.
  11. Always make sure that all descriptions follow a sentence case, i.e. they start with a big letter and end with a full stop, even if they are just for testing purposes (they can still appear by mistake and can be seen in debug menus).