aboutsummaryrefslogtreecommitdiff
path: root/game/localisation/README.md
diff options
context:
space:
mode:
author Hop311 <Hop3114@gmail.com>2023-06-24 00:55:45 +0200
committer GitHub <noreply@github.com>2023-06-24 00:55:45 +0200
commit432000a3ab73980fc6421b3587de4b97af30d3ad (patch)
tree4b80d98261252f25011e34b22a8d49767525559f /game/localisation/README.md
parent40cf0fa95e325f3bf875e42c11254da23192f506 (diff)
parent206cafc8bba310e4d4f35f4898ef3ac289abe81a (diff)
Merge pull request #131 from OpenVicProject/ui-cleanup
Localisation and UI focus cleanup
Diffstat (limited to 'game/localisation/README.md')
-rw-r--r--game/localisation/README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/game/localisation/README.md b/game/localisation/README.md
index 401517f..909e380 100644
--- a/game/localisation/README.md
+++ b/game/localisation/README.md
@@ -1,16 +1,16 @@
# Localisation
-This folder contains localisations for in-game text. Each sub-folder must be named with a standard locale code, e.g. `en_GB`, to which the localisations contained within it shall apply (Godot's supported locale codes are listed [here](https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html)). These folders contain `.csv` files where each line is interpreted as a key-value pair. Empty lines allow for spacing out/separating sections, and any further entries beyond the first two on a line are ignored, which can be used to add comments at the end of lines. Lines with their key and value empty are skipped, allowing free-standing comments with no preceeding localisation, but lines with only one of their key or value empty, while not loaded as a localisation, will still result in warnings about incomplete entries.
+This folder contains localisations for in-game text. Each sub-folder must be named with a standard locale code, e.g. `en_GB`, to which the localisations contained within it shall apply (Godot's supported locale codes are listed [here](https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html)). These folders contain `.csv` files where each line is interpreted as a semicolon-separated key-value pair. Empty lines allow for spacing out/separating sections, and any further entries beyond the first two on a line are ignored, which can be used to add comments at the end of lines. Lines with their key and value empty are skipped, allowing free-standing comments with no preceeding localisation, but lines with only one of their key or value empty, while not loaded as a localisation, will still result in warnings about incomplete entries.
```
-,, Example Localisation Comment
-EXAMPLE_KEY,Example Value
-ANOTHER_EXAMPLE,Another Example, This is a comment
+;; Example Localisation Comment
+EXAMPLE_KEY;Example Value
+ANOTHER_EXAMPLE;Another Example; This is a comment
-,, Entries with empty keys/values are skipped but can still produce warnings
-THIS,, produces a warning!
-,As, does this!
-,, This doesn't!
+;; Entries with empty keys/values are skipped but can still produce warnings
+THIS;; produces a warning!
+;As; does this!
+;; This doesn't!
BUT_THIS_DOES
-AND_THIS,
+AND_THIS;
```