VNLEWIKICrie histórias. Conecte mundos.
Português (Brasil)
Manual do VNLE

Entenda os arquivos e o JSON

O que é JSON?

JSON é um arquivo de texto com dados estruturados. Chaves contêm propriedades nomeadas; colchetes contêm uma lista ordenada. Strings usam aspas duplas; números e true/false não. Os IDs conectam os registros. Você pode abrir o arquivo em um editor de texto para conferi-lo; normalmente, faça as alterações na história pelo VNLE e exporte novamente.

Apresentando JSON · Passo a passo: integre o conteúdo ao seu jogo

O projeto editável e a exportação de jogos têm propósitos diferentes. Edite o conteúdo no VNLE e depois exporte novamente. Os seguintes trechos vêm do projeto incluído.

Pastas da exportação

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

O exemplo didático acrescenta guide-map.json para associar IDs a nomes legíveis. Esse arquivo pertence ao exemplo e não é gerado para todos os projetos. Em uma exportação normal, os pontos de entrada estão em story-index.json e os catálogos em story.json.

Inicie uma conversa

Um ponto de entrada é formado por flowRef e entryRef. Ambos são IDs, não nomes de exibição. Resolva execution.entries[entryRef].nodeRef para encontrar onde a execução começa. Estes são os IDs reais usados pelo exemplo:

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

Leia um diálogo

{
  "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 identifica o tipo de nó. speakerRef aponta para um personagem em content.characters. text.textRef aponta para content.texts. continuation descreve o que acontece ao usar Continue.

Resolva o texto e o idioma

{
  "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
}

Use content.translations[language][text ID].message quando existir; caso contrário, use sourceMessage. Os segmentos de texto fornecem as palavras visíveis, e os placeholders recebem valores das vinculações do nó. O idioma é uma configuração do jogo: alterá-lo não muda o progresso.

Mostrar nome e retrato

{
  "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": {}
}

Resolva nameTextRef como qualquer outro texto. Para a imagem, use o retrato da expressão escolhida ou defaultPortraitRef. Encontre o arquivo em content.assets[portrait ID].relativePath. Copie assets junto de story.json.

Consulte cada campo

Referência completa dos campos · JSON Schema · story.json