From 5cb0a86b2fcac8f380bb65f12bdd4decceab6768 Mon Sep 17 00:00:00 2001 From: Azgaar Date: Fri, 27 Aug 2021 23:22:38 +0300 Subject: [PATCH] Updated Data model (markdown) --- Data-model.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Data-model.md b/Data-model.md index b49be2d..bf40b59 100644 --- a/Data-model.md +++ b/Data-model.md @@ -246,3 +246,11 @@ Notes (legends) data is stored in unordered array of objects: `notes`. Object st * `legend`: `string` - note text in html ## Name bases +Name generator consumes training sets of real-world town names (with the exception of fantasy name bases) stored in `nameBases` array, that is available globally. Each array element represent a separate base. Base structure is: +* `i`: `number` - base id, always equal to the array index +* `name`: `string` - names base proper name +* `b`: `string` - long string containing comma-separated list of names +* `min`: `number` - recommended minimal length of generated names. Generator will adding new syllables until min length is reached +* `max`: `number` - recommended maximal length of generated names. If max length is reached, generator will stop adding new syllables +* `d`: `string` - letters that are allowed to be duplicated in generated names +* `m`: `number` - if multi-word name is generated, how many of this cases should be transformed into a single word. `0` means multi-word names are not allowed, `1` - all generated multi-word names will stay as they are \ No newline at end of file