Skip to content

Formatting Guidelines

riftcrystal edited this page Apr 18, 2018 · 8 revisions

These guidelines specifically pertain to formatting. Please also refer to Translation Guidelines.

TOML

Spec.

  • Be careful when adding newlines in translations that you do not add unnecessary indentation on the newlines.

  • Never edit original text.

Translations

General

Do not use full-width characters or symbols in translated messages. IE: "!" should be "!".

When adapting source symbols (such as "《", "》", "「", "」"), find an analogue in English that matches the original intent.

This is not a hard rule, but virtually all circumstances it should be followed. The one good exception is using a ideographic space (" ") to enforce alignment in certain dialog text.

Achievement Names

Files
  • ui\00_message\achievement\achievement_name

Guidelines
  • Currently formatting is enforced by the replication tool, so if you make a mistake. It’s OK.

    • Auto-formatting is based on this scheme.

    • Except for job level achievements. Which are automatically handled by replication.

Location Names

Files
  • ui\00_message\common\area_list

  • ui\00_message\common\field_area_name

  • ui\00_message\common\land_name

  • ui\00_message\common\spot_name

  • ui\00_message\common\stage_list

  • ui\00_message\master\area\*_spot_name

Guidelines
  • Currently formatting is enforced by the replication tool, so if you make a mistake. It’s OK.

Quest Info

Files
  • ui\00_message\quest_info

Guidelines

Quest info files are broken up in a specific way:

  • First message is the quest title.

  • Second message is the quest summary.

  • All other following messages are quest objectives.

Quest titles

  • Currently formatting is enforced by the replication tool, so if you make a mistake. It’s OK.

Quest summaries

  • Do not end the final sentence with common punctuation (commas, periods). Exclamation marks are OK.

  • It is OK to use newlines.

Quest objectives

  • Do not end the final sentence with common punctuation (commas, periods). Exclamation marks are OK.

  • Do not use newlines. This will cause display issues in-game (quest tracker does not properly support newlines).

    • Currently have to live with text getting squished. If the text becomes unreadable, figure out a way to shorten the text itself.