Файлы и JSON

Что такое JSON?

JSON — текстовый файл со структурированными данными. Фигурные скобки содержат именованные свойства, квадратные — упорядоченный список. Строки заключаются в двойные кавычки, числа и true/false — нет. ID связывают записи. Файл можно открыть в текстовом редакторе для просмотра; обычно историю следует менять в VNLE и затем экспортировать заново.

Представляем JSON · Пошаговое руководство по интеграции в игру

Редактируемый проект и экспорт для игры служат разным целям. Меняйте содержимое в VNLE, затем повторяйте экспорт. Фрагменты ниже взяты из прилагаемого проекта.

Папки экспорта

story.json                  Game data: flow + text + catalogs
assets/files/…png           Images used by the game
story-index.json            Entry points for starting conversations
export-info.json            Export result
project/
  project.vnle.json          Project name, languages, catalog references
  chapters/                 Chapter structure
  flows/                    Scene nodes and entry points
  layout/                   Node positions in the editor
  characters/               Characters and portrait references
  variables/                Variable definitions and initial values
  commands/                 Game actions, inputs and outcomes
  items/, quests/, locations/ Resources
  localization/             Source texts and translations
  assets/                   Asset catalog and image files

В учебном примере дополнительно есть guide-map.json, связывающий ID с понятными названиями. Этот файл относится только к примеру и не создаётся для каждого проекта. В обычном экспорте точки входа находятся в story-index.json, а каталоги — в story.json.

Начните разговор

Точка входа состоит из flowRef и entryRef. Это ID, а не отображаемые названия. Получите execution.entries[entryRef].nodeRef — с этого узла начинается выполнение. Ниже приведены реальные ID примера:

{
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "entryRef": "5e6b2e12-1ac1-4c46-8221-1a051e87370a"
}

Прочитайте диалог

{
  "continuation": {
    "kind": "node",
    "nodeRef": "85b3aadf-2b95-4150-bc44-c0c796337874"
  },
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "id": "ffa7141b-97ed-44c1-a346-8bba7e26d94f",
  "kind": "dialogue",
  "speakerRef": "807b2957-7bab-4a28-83a4-1f3d1589bbc2",
  "text": {
    "bindings": {},
    "textRef": "fd7b61a3-8233-4ba7-8f77-b88b119a91bf"
  }
}

kind определяет тип узла. speakerRef ссылается на персонажа в content.characters. text.textRef ссылается на content.texts. continuation описывает действие после Continue.

Получите текст на нужном языке

{
  "id": "fd7b61a3-8233-4ba7-8f77-b88b119a91bf",
  "category": "dialogue",
  "sourceMessage": {
    "kind": "segments",
    "segments": [
      {
        "kind": "text",
        "text": "Welcome to the harbour. I am Mira."
      }
    ]
  },
  "placeholders": {},
  "externalUse": false
}

Если существует content.translations[language][text ID].message, используйте его, иначе — sourceMessage. Текстовые сегменты содержат видимые слова, а подстановочные поля получают значения из привязок узла. Язык относится к настройкам игры: его смена не меняет прогресс.

Покажите имя и портрет

{
  "id": "807b2957-7bab-4a28-83a4-1f3d1589bbc2",
  "name": "Mira",
  "key": "character_2fbfc3b256cb4ecf94a89965ef8e4549",
  "nameTextRef": "ff2cf3d4-08d3-47d8-b41a-86f1a801e1b7",
  "color": "#82d5e6",
  "defaultPortraitRef": "eacb484c-0663-4ffd-876d-401664b980db",
  "emotions": {}
}

Получите nameTextRef так же, как любой другой текст. Используйте портрет выбранной эмоции или defaultPortraitRef. Путь к файлу находится в content.assets[portrait ID].relativePath. Скопируйте assets вместе с story.json.

Проверьте назначение полей

Полный справочник полей · JSON Schema · story.json