Modding

Onde está a pasta mods

Abra Mods no menu principal. O caminho está escrito na parte superior da tela, com um botão próximo a ele que abre a pasta no seu gerenciador de arquivos.

Está ao lado dos seus salvamentos e é a mesma pasta, quer você esteja instalando o mod de outra pessoa ou escrevendo o seu próprio. Nada é lido enquanto o jogo está em execução, então não importa se o jogo está aberto enquanto você move os arquivos.

Instale um

Um mod é uma pasta com mod.json no topo. A maioria dos downloads é aquela pasta dentro de um zip.

Um mod para o qual você copia permanece desativado até que você o diga. O jogo rejeita executáveis ​​sem questionar, mas um pacote de dados ainda pode alterar preços, itens e pessoas de maneiras que você não solicitou, e um pacote que aparece sozinho dentro de um jogo já em execução é um problema que ninguém quer diagnosticar. Então o jogo pergunta. É uma reinicialização extra na primeira vez e nunca mais para esse pacote.

Não há iniciador, não há arquivo de ordem de carregamento para editar e não há nada para gravar. A ordem de carregamento é um número dentro de cada embalagem, escolhido pelo seu autor.

Comece uma nova partida para um pacote que adicione pessoas, lugares ou missões. Um save já em andamento mantém o mundo com que foi criado. Pacotes que mudam apenas números, imagens ou cores são visíveis em uma partida já iniciada. Arquivos de áudio e fontes são validados, mas nenhuma superfície de pacote em execução os consome ainda.

Carregou?

Mod, no menu principal. Cada pacote encontrado fica em uma linha, com status de uma palavra: carregado, desabilitado, inválido, conflitante, requer outro mod, ignorado.

Um mod também pode desligar sozinho e diz o porquê. A opção que você coloca se aplica ao pacote em que você o colocou, não ao seu nome na pasta. Os mod ids são escolhidos pelos autores e não há nada para coordená-los, então dois mods não relacionados, ambos chamados northern_reach, são um acidente comum - e sem isso o segundo herdaria a opção do primeiro. Se o mod sob um id não for aquele que você ativou, a linha diz: este não é o mod que você ativou. Atualizar um mod preserva sua mudança; exclua-o e copie outro não.

Se você é o autor de um mod e vê essa linha em seu pacote, você tem uma colisão de ID com o mod de outra pessoa. Escolha uma identificação menos óbvia.

Duas dessas palavras são sobre uma reinicialização que você deve, não sobre o pacote. Ativo — reiniciar para carregar significa que você ligou e ninguém leu ainda; Desligado — reiniciar para baixar significa o contrário, e seu conteúdo ainda estará no jogo até você reiniciar. São palavras separadas propositalmente: uma tela que diz “Carregado” no momento em que você aperta um botão o enviaria a uma busca pelo mundo por algo que ainda não existe.

Quando o estado não está "carregado", a linha abaixo informa por que, no idioma em que você está jogando e sem identificadores, você não escreveu: qual arquivo o jogo se recusa a executar, qual pacote está faltando, qual versão ele deseja. Abaixo, o que fez o conteúdo do pacote: quantas entradas entraram, quantas foram rejeitadas. Mostrar detalhes abre o restante, ou seja, os ids e a regra exata que cada registro rejeitado quebrou.

Duas linhas compartilham uma palavra propositalmente: Requer outro mod É o mesmo problema para um jogador, quer o pacote que ele precisa esteja faltando ou seja a versão errada, e a linha abaixo diz qual. E quando dois pacotes reivindicam o mesmo registro, aquele com o load_order mais alto escreve por último e vence — mas uma aquisição que ninguém declarou é um erro, não uma nota. Ambas as linhas são relatadas, e a linha do perdedor nomeia o vencedor, e o vencedor ainda é calculado em vez de ser deixado ao acaso: uma rejeição não precisa ser também um sorteio. Quando dois mods querem a mesma coisa explica como declarar um de propósito.

“Carregado” ainda não significa que você pode vê-lo no mundo. Para isso, leia as contagens abaixo da linha, e Agora encontre no jogo informa onde cada tipo de coisa aparece.

As contagens sempre somam. Camas são aplicadas, mais rejeitadas, mais substituídas por outro mod, mais esperando por suas próprias condições - e as duas últimas são nomeadas em vez de permanecerem um buraco. Um registro que outro pacote escreve por último não é rejeitado, porque não há nada de errado com ele, e nem mesmo é aplicado, porque não foi isso que o jogo manteve. É a diferença entre ler uma linha e passar uma noite procurando um bug em um arquivo que não contém nenhum. Mostrar detalhes informa qual registro e qual pacote o possui agora.

Um número está próximo a essa soma em vez de dentro: arquivos que ninguém leu. Um arquivo cuja família não está em content_types nunca foi aberto, portanto não há registro para contar e não há como saber quantos estão nele. É uma contagem de arquivos, não de registros, e é exatamente por isso que não pode ser um sexto termo: a soma começa em lido, e estes nunca foram lidos.

Antes de pedir ajuda a alguém

Abra Mod e pressione Copiar relatório. Cole tudo em sua mensagem e diga o que você esperava.

Texto simples, pronto para um fórum, uma mensagem do Discord ou um relatório de bug: a versão em que você está, a pasta mods, cada pacote com sua versão, sua ordem de carregamento e status, o motivo de cada rejeição, as contagens para cada tipo de conteúdo e qual pacote venceu cada batalha.

the report the Mods screen copies

Bonemark mod report
game build: 0.0.0-dev
mods folder: C:/Users/you/AppData/Roaming/Godot/app_userdata/Bonemark/mods
packages: 2 found, 1 loaded

PACKAGES
  northern_reach  v0.1.0  order 100  active
    goods: 12 read, 12 applied, 0 rejected
  winter_roads  unreadable manifest
    - game_version must not be empty

CONTENT (1 families: 12 read, 12 applied, 0 rejected)
  goods: 12 read, 12 applied, 0 rejected

Nove em cada dez vezes a resposta está no bloco e ninguém precisa fazer uma única pergunta primeiro. Ele não lê nada fora da pasta mods, não altera nada e não contém informações pessoais.

Está em inglês mesmo quando você está jogando em outro idioma. Isso é intencional: a pessoa que está ajudando você pode não ler o seu, e todos os fatos que ele contém — ids, versões, contagens — ainda são os mesmos em todos os idiomas.

Remover um

Exclua sua pasta e reinicie. A desinstalação está toda aqui.

Nada seu é excluído junto com ele. Um salvamento mantém os ids que não pode mais resolver, sinaliza-os e retorna itens se o pacote for reinstalado. Uma sessão que não consegue entender um salvamento nem mesmo o sobrescreve: o arquivo original permanece exatamente como estava, e é a diferença entre uma tarde perdida e um jogo perdido. Saves é o relatório completo.

Se o jogo parar de funcionar após você instalar algo, a saída não precisa do jogo. Abra a pasta mods e remova a última coisa que você adicionou. Os pacotes só podem ser lidos nessa pasta, portanto, uma pasta que não existe é um pacote que não pode ser carregado e a próxima inicialização é a mesma de antes. Você não precisa de um menu de trabalho, console ou inicialização para fazer isso.

Até o jogo tenta sozinho - Se o jogo não iniciar é um número limitado de tentativas e depois um caminho de volta sem nenhum pacote carregado - mas esse é o cinto, e mover a pasta são os suspensórios.

O que você pode construir hoje

Agora, sem pedir nada a ninguém: mercadorias e os comerciantes que as vendem, itens, pessoas e onde ficam, edifícios e seus serviços, lugares no mapa, conversas, cenas, planos de missão, mapas desenhados no Tiled, imagens e cores, e todas as palavras para isso em sete idiomas. Arquivos de áudio e fontes são verificados e lidos, mas suas superfícies de pacote ainda não os consomem; a tabela de status diz isso claramente em vez de chamá-los de prontos. Todas as famílias são a lista medida, e seu status vem do build, não de uma promessa.

Ainda não, e O que você ainda não pode fazer explica cada caso: a família quests, áudio de pacote, fontes de pacote, conversões totais empacotadas e um pacote que seja uma funcionalidade em vez de conteúdo.

Nunca, devido à escolha do projeto: código. Sem scripts, sem cenas, sem arquivos de recursos, nada para o jogo rodar. É isso que torna seguro baixar o mod de um estranho, e não é uma fase pela qual o projeto está passando. O que um mod nunca pode fazer.

Tempo para a primeira coisa que você pode ver no jogo: Cerca de dez minutos, a maior parte gasto para encontrar a pasta. Um mod em dez minutos está completo, e a espada no final é real.

O que você ainda não pode fazer e por quê

Está escrito aqui, perto do começo, em vez de ficar para ser descoberto no fim. Isto é o que o build valida sem colocar atualmente em uma superfície de pacote voltada ao jogador, além do que não é conteúdo de pacote.

Uma mecânica que o jogo nunca teve é ​​a quarta linha com outro chapéu. Uma espada que bate com mais força é um número e é sua; uma arma que dispara um raio precisa das regras do raio, e as regras são códigos que alguém escreve e testa.

O que é um mod

Uma pasta de arquivos de texto. Você não escreve código. Você escreve listas de coisas que deseja no jogo e o jogo as lê quando começa.

A única regra da qual todo o resto segue: você pode adicionar e alterar dados. Você não pode fazer o jogo executar código. É isso que torna seguro baixar um mod: o pior que um mod de um estranho pode fazer é colocar uma espada boba em você.

34 famílias estão prontas para usar hoje, entre elas items, buildings, pois, npc_definitions, vendor_inventories, quest_plans, caravans e perks. Todas as famílias formam a tabela completa com o que cada uma faz; As famílias, uma por uma mostra seus campos e um registro para copiar.

Escolha o seu caminho

Este é o índice de todo o guia — onde cada tópico é escrito, esteja você construindo-o hoje ou não. No topo da Parte 3 há um segundo índice mais curto: são os seis tutoriais, na ordem em que se complementam. Se você está aqui para fazer alguma coisa e não para procurar alguma coisa, vá direto para lá.

Ou o que está em sua mente. Essa orientação é organizada na ordem em que o trabalho acontece – manifesto, depois validação, depois conteúdo e depois relatório – que é a ordem que alguém que já conhece o sistema escolheria. Quem não o conhece está pensando Quero adicionar um comerciante, e procura a palavra comerciante:

O que você precisa

Um editor que colore JSON mostra uma vírgula faltando enquanto você ainda está olhando para ela, em vez de fazer com que o jogo informe mais tarde que o arquivo estava ilegível.

Python e o console são opcionais. O jogo basta: coloque o pacote, reinicie e abra Mods, que informa cada registro recusado e o motivo. O checkout para autores é público. Quem quiser iterar mais rápido ou automatizar lançamentos pode clonar o checkout público do Bonemark e executar as ferramentas offline em Ferramentas offline; jogadores que instalam um pacote lançado não precisam de Python nem Godot. O mesmo checkout público contém o validador e as declarações do runtime, então as duas seções descrevem uma única cadeia de ferramentas. As ferramentas usam as mesmas declarações do jogo — os esquemas de registros e o limite de segurança têm uma fonte cada — e por isso respondem mais cedo, nunca de forma diferente. Um console de depuração ajuda a inspecionar um pacote carregado, mas não é necessário para escrever um.

Comece com o que você quer fazer

Tudo abaixo desta linha está organizado na ordem em que o trabalho acontece: cartaz, depois arquivos, depois famílias e depois relatórios. É a ordem certa para procurar algo e a ordem errada para começar, porque ninguém começa com um manifesto. Começa com Quero um comerciante.

Depois: escolha a frase que mais se assemelha ao que você está tentando fazer.

Os seis tutoriais são um pacote único, construído uma peça de cada vez: uma vela de cera de abelha, o pacote que um jogador carrega consigo, o fabricante de cera que a vende, a porta de sua loja, o poço atrás do curtume de onde vem o sebo e, finalmente, uma modificação na vela que o jogo já tinha. Faça-os em ordem e termine com um mod que alguém possa baixar. Coloque um no meio e ele funcionará sozinho.

Onde estão os números do jogo

Cada tutorial aqui avalia uma coisa nova comparando-a com algo que o jogo já vende, porque um número sem nada próximo a ele é uma suposição, e uma suposição em uma economia que negocia entre cidades não fica onde você a coloca.

Você não pode abrir os arquivos do jogo. Seus registros são ativos Godot dentro do pacote de compilação — um formato diferente do JSON que você escreve, com category = 1 onde seu arquivo diz "MANUFACTURED". Não há pasta para copiar e descompactar uma não é um fluxo de trabalho que alguém precise documentar.

Você não precisa disso. O catálogo publica o conteúdo do jogo, gerado a partir desses mesmos registros a cada construção: 270 itens com sua categoria, peso, valor de moeda e tamanho da pilha, 49 armas, 42 peças de armadura, 37 localizações. É a referência na qual este guia está ancorado, não pode divergir do jogo e o nome do campo está impresso ao lado de cada linha.

Uma dúzia de valores para saber antes de colocar preço em algo:

Se a sua novidade custar mais do que uma armadura de placas, algo deu errado e o jogo não lhe dirá - ela se tornará silenciosamente a carga mais lucrativa do mundo, e todas as caravanas a carregarão.

Uma mercadoria para vender

Você terá uma mercadoria que a economia sabe precificar, atrelada à vela que o jogo já vende, pronta para um comerciante segurar.

Captura de tela: Ainda não tirada. Este espaço permanece vazio até que haja um espaço real: um desenho de sua aparência seria a única coisa na página que não é real.

Leia primeiro: [O que é um mod](#o que é um mod) · [Um mod em dez minutos](#um mod-em-dez-minutos) · Nomes e ids

Copiar de: a pasta chamada chandlery, que já está na sua pasta mods. O jogo coloca lá na primeira vez que inicia, desligado, e é o resultado final desses seis tutoriais: todos os registros abaixo estão lá. É também o pacote que a pista de teste do repositório gira contra o carregador, então não há registro aqui de que o jogo rejeitaria. Ligue-o para ver funcionar ou copie a pasta, renomeie-a e torne-a sua.

Para onde vão os arquivos:

where the files go

mods
└ chandlery
  ├ mod.json
  └ content
    └ economy
      └ goods
        └ goods.json

Comece pela vela que o jogo já possui. Chama-se candle, custa 3, pesa 0,5, é MANUFACTURED e PRESERVED, e é feita pelo boticário. A sua é a mesma coisa feita de cera melhor, então guarde todas essas respostas e troque duas.

Antes de mod.json:

mod.json

{
  "id": "chandlery",
  "name": "The Chandlery",
  "version": "0.1.0",
  "game_version": "0.0.0-dev",
  "dependencies": [],
  "load_order": 100,
  "content_types": ["goods"],
  "overrides": [],
  "canon_safe": true
}

Então content/economy/goods/goods.json:

a goods record

[
  {
    "id": "chandlery:beeswax_candle",
    "display_name": "Beeswax Candle",
    "category": "MANUFACTURED",
    "decay_tier": "PRESERVED",
    "base_price": 9,
    "weight": 0.4,
    "production_class": "chandler",
    "daily_consumption_class": "household",
    "tags": ["light", "household"]
  }
]

Concluído – agora encontre-o no jogo. Reinicie, abra Mod e a linha abaixo da sua diz 1 entry added. É tudo o que uma mercadoria faz por si só: tem um preço, é comercializável e não fica no balcão de ninguém, porque ninguém a tem ainda. Não é um fracasso e é o que confunde todo mundo uma vez. Continue com Um comerciante que estoca.

Se não for mostrado: Nada apareceu tem os seis motivos em ordem. De longe, o mais comum é content_types - uma família ausente nessa linha significa que a pasta nunca é aberta, seja lá o que ela contenha. Então Antes de pedir ajuda a alguém, que é um único botão.

Um objeto para carregar

Você terá aquilo que um jogador pega, guarda em sua mochila e revende, junto com a mercadoria que você acabou de escrever.

Captura de tela: Ainda não tirada.

Leia primeiro: [Um produto bom para vender](#um produto bom para vender) · Nomes e IDs

Copiar de: chandlery/content/inventory/items/items.json para sua pasta mods.

Para onde vão os arquivos:

where the files go

mods
└ chandlery
  ├ mod.json
  └ content
    ├ economy
    │ └ goods
    │   └ goods.json
    └ inventory
      └ items
        └ items.json

Uma mercadoria e um objeto são duas metades da mesma coisa. A mercadoria é o ponto de vista da economia: o que uma cidade produz, o que uma caravana transporta, quanto vale. O objeto é o ponto de vista do jogador: o que cabe na mochila, o que está empilhado, o que está exposto em uma loja. O trigo tem mercadoria e não tem objeto, porque ninguém carrega um saco de trigo. As velas têm ambos.

Adicione "items" a content_types em mod.json e escreva content/inventory/items/items.json:

a items record

[
  {
    "id": "chandlery:beeswax_candle_bundle",
    "display_name": "Bundle of Beeswax Candles",
    "category": "MATERIAL",
    "rarity": "COMMON",
    "weight": 0.4,
    "max_stack": 20,
    "base_value": 10,
    "sellable": true,
    "tags": ["light", "household"]
  }
]

Concluído — agora encontre-o no jogo. Um item que ninguém entrega é carregado e acessível do nada. Em uma compilação de depuração, item chandlery:beeswax_candle_bundle coloca um em sua mochila imediatamente e é a prova mais rápida de que ele está carregado - mas esse comando não existe no jogo que as pessoas baixam, então é um atalho para você e nunca a resposta para um jogador. A verdadeira resposta é o próximo tutorial.

Se não for mostrado: Nada apareceu, então Antes de pedir ajuda a alguém.

Um comerciante que o detém

Você terá uma mulher com um nome em Old Seat com um balcão, suprimentos que são reabastecidos a cada dois dias e suas velas no balcão.

Captura de tela: Ainda não tirada.

Leia primeiro: Um item para carregar · Agora encontre-o no jogo

Copiar de: chandlery/content/narrative/npcs/npcs.json e chandlery/content/world/vendor_inventories/vendors.json.

Para onde vão os arquivos:

where the files go

mods
└ chandlery
  ├ mod.json
  └ content
    ├ economy
    │ └ goods
    ├ inventory
    │ └ items
    ├ narrative
    │ └ npcs
    │   └ npcs.json
    └ world
      └ vendor_inventories
        └ vendors.json

Este é aquele onde duas famílias têm que concordar. A pessoa carrega o id do banco, o banco carrega o id da pessoa e cada linha do banco carrega o id de um objeto. Três ids, e cada um deve ser escrito exatamente como você escreveu no outro arquivo. É o erro que custa uma noite, e a tela Mods o nomeia: uma linha apontando para um ID que ninguém fornece está listada como requer outro mod que não esteja instalado.

Adicione "npc_definitions" e "vendor_inventories" a content_types.

a npc_definitions record

[
  {
    "id": "chandlery:hesta",
    "display_name": "Hesta the Chandler",
    "title": "Candle Seller",
    "short_bio": "She renders fat behind the tannery and sells what burns longest.",
    "voice_tone": "brisk",
    "faction": "NONE",
    "role": "NONE",
    "settlement_id": "old_seat",
    "is_vendor": true,
    "vendor_inventory_id": "chandlery:candle_stall",
    "price_multiplier": 1.0,
    "personality_tags": ["brisk", "practical"],
    "offers_quest_ids": []
  }
]

a vendor_inventories record

[
  {
    "id": "chandlery:candle_stall",
    "display_name": "Chandler's Stall",
    "npc_id": "chandlery:hesta",
    "global_price_multiplier": 1.0,
    "buyback_rate": 0.35,
    "entries": [
      {
        "item_id": "chandlery:beeswax_candle_bundle",
        "kind": "misc",
        "daily_stock": 6,
        "price_multiplier": 1.0,
        "restock_days": 2,
        "min_standing": 0
      }
    ]
  }
]

Concluído – agora encontre-o no jogo. Reinicie, viaje para Old Seat, encontre Hesta, abra a tela de negociação. Se o banco estiver vazio, ainda não foi reabastecido: isso é restock_days, não é um bug. A cadeia pode ser quebrada de três maneiras e todas as três estão na tela do Mod: as mercadorias que ninguém possui, o contador que aponta para um id de item que não existe, a pessoa que aponta para um id de contador que não existe.

Ela também pode falar. Uma dialogue_graph cujo ID speaker é seu ID faz piadas quando um jogador clica nelas, e seu pacote não precisa redefinir nada que o jogo já tenha para obtê-las — veja Suas Conversas. Um arquivo locales oferece tudo isso em sete idiomas.

Se nada aparecer: primeiro compare os três IDs, depois Nada apareceu e depois Antes de pedir ajuda a alguém.

O serviço de um edifício

Você terá uma porta em um assentamento com sua etiqueta e cor, que se abre para um interior que o jogo já possui.

Captura de tela: Ainda não tirada.

Leia primeiro: Um comerciante que mantém · [O que um mod nunca pode fazer](#o que um mod-pode-nunca-fazer)

Copiar de: chandlery/content/world/buildings/buildings.json.

Para onde vão os arquivos:

where the files go

mods
└ chandlery
  └ content
    └ world
      └ buildings
        └ buildings.json

Você está recombinando, não construindo. Um registro buildings adiciona um novo serviço com um rótulo, cor de porta e função de rotina, e pode reutilizar uma extensão que o jogo já possui nomeando-a. Não é possível trazer uma extensão. Uma extensão é uma cena, uma cena é um código e um pacote com o nome de um caminho res:// ou .tscn é rejeitado antes mesmo de esse registro ser lido. Não é um buraco esperando para ser preenchido: é a linha que torna seguro instalar o mod de um estranho.

a buildings record

[
  {
    "id": "chandlery:chandlery",
    "label": "Chandlery",
    "role": "merchant",
    "color": { "r": 0.44, "g": 0.38, "b": 0.24 },
    "interior_service": "shop"
  }
]

Concluído – agora encontre-o no jogo. Reinicie e insira um assentamento que tenha seu serviço. Um registro sem settlement é carregado e colocado em lugar nenhum, o que é idêntico a um registro com falha: a tela do Mod dirá 1 entry added e você não encontrará nada. Leia a linha antes de procurar a porta.

Se não aparecer: Nada apareceu · Antes de pedir ajuda a alguém.

Um lugar no mapa

Você terá um ponto no mapa mundial onde um jogador poderá encontrar, com uma descrição dele e seu efeito no clima do grupo.

Captura de tela: Ainda não tirada.

Leia primeiro: O serviço de construção · Agora encontre-o no jogo

Copiar de: chandlery/content/world/pois/pois.json.

Para onde vão os arquivos:

where the files go

mods
└ chandlery
  └ content
    └ world
      └ pois
        └ pois.json

As coordenadas são absolutas e o mundo é gerado ao redor de lugares criados pelos autores. O mapa mede 61 440 × 34 560 pixels do mundo e Old Seat fica exatamente no centro, (30720, 17280), em toda partida. As cidades e vilas criadas pelos autores mantêm seus nomes e posições. A seed muda o terreno e os biomas ao redor delas, a escassez do ano, a organização política e quais estradas valem a pena. Um ponto continua sendo real e estável; o que fica ao lado muda a cada partida. Duas formas honestas de usar isso: ancore um POI perto de um assentamento criado pelos autores, para que o jogador passe por ele; ou escolha o vazio, pois uma cova de renderização que ninguém visita há anos deve ficar em lugar nenhum em particular.

a pois record

[
  {
    "id": "chandlery:tallow_pit",
    "kind": "RUINS",
    "display_name": "The Tallow Pit",
    "description": "A rendering pit behind the tannery. The smell reaches the road.",
    "world_position": { "x": 5400.0, "y": 3000.0 },
    "discovery_radius": 2.0,
    "one_time_loot": false,
    "morale_modifier": -1,
    "awareness_modifier": 0.0
  }
]

Concluído – agora encontre-o no jogo. Vá em frente. Não há comando de teletransporte, seja em uma compilação de depuração ou fora dela, então escolha as coordenadas até onde você deseja caminhar enquanto tenta.

Se não aparecer: Você provavelmente está fora de discovery_radius ou o local é algum lugar onde a semente da partida colocou um oceano. [Nada apareceu](#nada apareceu).

Mudando o que já está lá

Você terá alterado um registro que o jogo trouxe consigo – e você o terá declarado, de modo que a alteração ficará visível para o jogador e para todos os outros mods.

Captura de tela: Ainda não tirada.

Leia primeiro: Mude o que o jogo já tem · Quando dois mods querem a mesma coisa

Cópia de: chandlery/content/economy/goods/goods.json, que adiciona um registro e corrige um do jogo no mesmo arquivo.

Para onde vão os arquivos: Nenhum lugar novo. Uma mudança em algo que o jogo já possui fica na mesma pasta de família em que seus registros estão - o arquivo diz qual registro pretende e o que está fazendo com ele.

where the files go

mods
└ chandlery
  ├ mod.json          the change is declared here
  └ content
    └ economy
      └ goods
        └ goods.json  your record and the patch, in one file

Duas regras antes do arquivo. Uma alteração no registro de outra pessoa deve ser nomeada em overrides dentro de mod.json — um registro que caia em um ID que você não declarou é rejeitado, então nada pode reescrever secretamente algo com o qual o jogador não concordou. E patch, que altera um campo e deixa o resto em paz, requer "manifest_version": 2.

mod.json

{
  "id": "chandlery",
  "name": "The Chandlery",
  "version": "0.1.0",
  "game_version": "0.0.0-dev",
  "manifest_version": 2,
  "load_order": 100,
  "content_types": ["goods", "items", "npc_definitions", "vendor_inventories", "buildings", "pois"],
  "overrides": ["candle"],
  "canon_safe": true
}

a goods record

[
  {
    "op": "patch",
    "id": "candle",
    "changes": [
      { "op": "set", "field": "base_price", "value": 4 },
      { "op": "append_unique", "field": "tags", "value": "chandlery_touched" }
    ]
  }
]

Concluído – agora encontre-o no jogo. A tela Mod nomeia o registro que você adquiriu. A tela do outro autor também faz isso, se houver: quando dois pacotes escrevem o mesmo id, a linha do perdedor agora diz replaced: candle — 'chandlery' escreve por último, em vez de mostrar silenciosamente uma entrada a menos do que ele escreveu. Quem tiver o maior load_order escreve por último e vence.

Ganhar não é o mesmo que ter permissão. Dois pacotes que recebem um registro sem nomear o outro em supersedes são relatados como undeclared_collision e a composição não está correta: o validador offline diz a mesma coisa e rejeita:

typed into the debug console

ERROR: conflict on goods:candle: ['early', 'late'] each supply the whole record
and none declares the others under `supersedes`

O vencedor ainda é calculado, porque uma rejeição não precisa ser também um cara ou coroa, mas dois autores que a desejaram têm que dizê-lo. Quando dois mods querem a mesma coisa é essa conversa.

Se não aparecer: a causa usual é overrides — o id deve estar nessa lista, escrito exatamente, caso contrário o registro é rejeitado em vez de aplicado. Quando dois mods querem a mesma coisa · Nada apareceu.

Um mod em dez minutos

1. Crie uma pasta na sua pasta mods, com o nome em letras minúsculas e sublinhados: northern_reach. Tudo acontece lá dentro.

2. Escreva mod.json no topo:

mod.json

{
  "id": "northern_reach",
  "name": "The Northern Reach",
  "version": "0.1.0",
  "game_version": "0.0.0-dev",
  "dependencies": [],
  "load_order": 100,
  "content_types": ["items"],
  "overrides": [],
  "canon_safe": true
}

id deve corresponder ao nome da pasta. content_types lista as famílias que você traz — uma família que falta nessa linha nunca é lida, não importa o que esteja na pasta.

3. Crie as pastas content/inventory/items e coloque blades.json dentro:

a items record

[
  {
    "id": "northern_reach:frost_blade",
    "display_name_key": "northern_reach.item.frost_blade.name",
    "display_name": "Frost Blade",
    "category": "weapon",
    "base_value": 240,
    "weight": 3
  }
]

Os colchetes são uma lista: adicione quantas espadas quiser, separadas por vírgulas. Cada arquivo .json em uma pasta de família é lido, então divida-os como desejar.

240 não é um número escolhido para impressionar. Neste jogo, as armas de uma mão variam de 50 a 300, então uma lâmina de gelo de 240 é uma espada cara e não uma espada lendária, e um jogador pode comprá-la na mesma hora que puder comprar as boas que o ferreiro já vende. Onde estão os números do jogo é a tabela a ser observada antes de escolher qualquer número; um preço sem nada próximo é uma hipótese, e numa economia que comercializa entre cidades uma hipótese não permanece onde você a coloca.

4. Inicie o jogo e abra Mods no menu principal. Seu pacote recebe exatamente um status e Did it load? tem todos os seis.

5. Leia a linha abaixo para saber o que foi lido, aplicado e rejeitado, com o motivo de cada rejeição. Mostrar detalhes tem IDs.

6. Sua espada está no jogo. Tudo o que vem depois é mais do mesmo.

Agora encontre-o no jogo

O relatório diz applied. Significa que o disco está carregado e isso não é a mesma coisa que poder andar na frente dele. É aqui que todo guia para e todo autor começa a adivinhar.

settlement_id nomeia um lugar criado pelos autores. Os ids de assentamento são criados pelos autores e estáveis: Durnwall, Thorngate, Valdmere, Grentham e as doze vilas podem receber nome. A seed muda o terreno e os biomas ao redor delas, a escassez do ano e a organização política, não o id. Se quiser que alguém seja certamente encontrado, use qualquer id de assentamento criado pelos autores e mantenha o nome nos dados de idioma do seu pacote.

As coordenadas são absolutas e o mundo é gerado ao redor de lugares criados pelos autores. O mapa mede 61 440 × 34 560 pixels do mundo e Old Seat fica exatamente no centro, (30720, 17280), em toda partida. As cidades e vilas criadas pelos autores mantêm seus nomes e posições. A seed muda o terreno e os biomas ao redor delas, a escassez do ano, a organização política e quais estradas valem a pena. Assim, uma world_position de (6000, 2200) é um ponto real e estável no extremo noroeste do mapa, enquanto o que fica perto muda a cada partida: pode ser uma estrada, uma floresta ou lugar nenhum. Duas formas honestas de usar isso:

• Ainda no centro. Um ponto de interesse a alguns milhares de pixels de distância (30720, 17280) fica próximo ao assento antigo em todos os jogos, portanto é um local que o jogador encontrará.
• Você quer dizer vazio. Uma ruína pela qual ninguém passou por cem anos deve estar em qualquer lugar. As coordenadas absolutas são exatamente corretas para isso, e a semente decidirá quais vizinhos terá.

Os comandos de console que mais economizam tempo. day [n] e hour [n] avançam o tempo, que é como você vê um suprimento sem experimentá-lo. item <id> [count] e gold <amount> colocam as coisas em suas mãos. flag, quest_start e faction_rep movem o estado que uma condição pode estar aguardando. Não existe comando de teletransporte: para chegar a um local, viaje até lá.

mod.json, campo por campo

Uma dependência pode ser um objeto em vez de um nome: {"id": "some_mod", "version": "", "optional": true}.

Um valor que nomeia outro pacote é uma referência cross-mod e a referência deve ser uma dependência declarada. Se essa dependência for opcional, atribua ao campo um fallback, caso contrário o registro será ignorado quando a dependência estiver ausente:

a goods record

[
  {
    "op": "add",
    "id": "northern_reach:alloy",
    "display_name": "Alloy",
    "linked_item_id": "absent_helper:ore",
    "fallback": { "linked_item_id": "iron_ore" }
  }
]

Para onde vai cada arquivo

where the files go

northern_reach/
  mod.json                  the label
  content/assets/images/
    images.json             your art
  content/inventory/items/
    blades.json             your first record
  content/narrative/quest_plans/
    the_long_winter.json    your quest

Nomes e IDs

Um ID consiste em letras minúsculas, dígitos e sublinhados, e nada mais. frost_blade, não Frost Blade, não frost-blade e não frost.blade. Ele nem carrega seu próprio separador, porque um separador dentro de um id é a pasta que vaza para o nome: mova o arquivo e o id não estará mais de acordo com o disco. Os :s acima são a única exceção e ambas as metades seguem a regra.

A parte antes dos dois pontos é o ID do seu pacote. É assim que dois mods podem adicionar uma Frost Blade sem colidir.

Palavras que um jogador lê

O texto escrito em um registro é texto em um único idioma. Em vez disso, aponte para uma chave:

a locale CSV

northern_reach.item.frost_blade.name
northern_reach.item.frost_blade.description

As chaves são minúsculas, unidas por pontos, com o namespace como ids. Traz palavras para a família locales — um .csv sob content/locale com uma coluna key e uma coluna de idioma. As famílias, uma por uma tem o formato exato.

Escreva também o display_name simples próximo à chave. Um registro que contém apenas uma frase deve ser reescrito à mão no dia em que você o traduz, e até então haverá quatrocentas delas.

As duas maneiras de errar falham de maneiras muito diferentes, e apenas uma delas lhe diz isso. Uma chave que não responde a nada aparece como a própria chave — northern_reach.item.frost_blade.name, na tela, deliberadamente feia para alguém consertar e contada como um buraco. Um registro que contém apenas texto e nenhuma chave nunca aparece: funciona, no seu idioma, para todos os jogadores em todos os idiomas. Nada é rejeitado e nada falta, então nada informa, e um jogador que lê em português lê silenciosamente o seu italiano. Você encontra o primeiro erro. O segundo encontra seus leitores.

Traduza um mod e seja traduzido

O jogo é lançado em sete idiomas, então um pacote com inglês incluído nos registros é lido como inglês para seis sétimos daqueles que o instalam. É isso que custa evitá-lo, que é quase nada se você fizer no primeiro dia e reescrever se fizer no quatrocentos.

As línguas que existem

Sete, e esta tabela é lida na construção em vez de escrita à mão aqui, então um idioma que chega ou sai a move no mesmo dia:

Dois dos códigos têm uma segunda grafia em circulação - pt-BR é aquele que uma loja digital usa e esta página, pt_BR é aquela com a qual o mecanismo está em conformidade - e em um cabeçalho de coluna ambos são aceitos. Escreva aquele que você copiou.

Carregue palavras em mais de um idioma

Um CSV em content/locale, com key primeiro e uma coluna por idioma:

a locale CSV

key,en,it,de
northern_reach:GOOD_FROST_SALT,Frost Salt,Sale di Brina,Frostsalz
northern_reach:ITEM_FROST_BLADE_NAME,Frost Blade,Lama di Brina,Frostklinge

Quando uma chave não responde no idioma do jogador, o jogo desce uma escada fixa: o idioma do jogador, depois o idioma em que seu pacote afirma ter sido escrito, depois o catálogo do jogo e depois a própria chave. A última etapa é feia de propósito: uma chave não resolvida precisa parecer errada para que alguém a conserte. Uma conversão total ignora o catálogo de jogos, porque Old Seat surgir em um mundo ambientado em outro continente não é um pequeno descuido de tradução, é o jogo base que brilha.

Escreva um texto que possa ser traduzido

• Não há sentenças construídas em pedaços. A ordem das palavras não é a mesma em todos os idiomas, portanto, um nome montado em tempo de execução a partir de uma coluna de adjetivos e uma coluna de substantivos produz Oro Cervo em italiano. Uma entrada escrita para cada idioma, completa.
• O nome de uma pessoa nunca é traduzido ou flexionado. Aldric é Aldric em todos os idiomas. O que também significa que uma chave não deve colocar um nome em posição oblíqua — "of {name}", "{name}'s" — porque muitos idiomas recusam nomes próprios e o jogo não.
• Não há limite de caracteres e isso não é o mesmo que não ter limite. Nenhum campo conta caracteres; o que acaba sendo espaço na tela. O alemão é cerca de um terço mais longo que o inglês e é a língua mais usada; os chineses são muito mais baixos e quase nunca o fazem. Se você tentar apenas uma tradução, tente o alemão e atribua ao rótulo o texto mais curto que ainda esteja correto.

Alguém que traduz seu pacote

Adiciona uma coluna e envia o arquivo de volta para você. O fluxo de trabalho está todo aqui, e é por isso que o formato é CSV em vez de algo mais amigável para um programador: um tradutor pode abri-lo em uma planilha, e suas ferramentas já o lêem.

Duas coisas fazem a diferença entre um pacote que é traduzido e outro que não. Mantenha as chaves estáveis — uma chave renomeada é uma tradução perdida e o tradutor descobre quando um jogador descobre. E diga para que serve uma linha: uma chave chamada NR_MSG_01 recebe um palpite, enquanto northern_reach:VENDOR_HERB_GREETING recebe uma saudação do vendedor de ervas.

Se for você quem está traduzindo o pacote de outra pessoa, as mesmas regras o vinculam: as colunas são os idiomas que o jogo carrega, as chaves são as chaves dele e não as suas, e um nome continua sendo um nome.

Mudando o que o jogo já tem

part of mod.json

"overrides": ["iron_sword"]

overrides é uma promessa. Um registro que cai em um ID que você não declarou é rejeitado, então você nunca pode mudar silenciosamente algo sobre o qual um jogador nada sabia.

a goods record

[
  {
    "op": "patch",
    "id": "iron_ore",
    "changes": [
      { "op": "set", "field": "base_price", "value": 14 }
    ]
  }
]

Um patch nomeia suas alterações uma de cada vez:

• set — Grava value em field, o que quer que estivesse lá antes. Está escrito com field e value.
• unset — Remove field do registro, para que o leitor veja o valor padrão da família. Está escrito com field.
• append_unique — Adiciona value à lista em field se ainda não estiver lá. Está escrito com field e value.
• remove_value — Remove cada ocorrência de value da lista em field. Está escrito com field e value.

• Nomeie um campo por caminho, nunca por local. tags.0 é rejeitado. O terceiro rótulo de hoje é o segundo rótulo depois de você carregar o mod de outra pessoa.
• Um caminho tem até quatro nomes em letras minúsculas unidos por pontos. Qualquer coisa que contenha um operador é rejeitada.
• append_unique é aquele que dois mods podem compartilhar. Se ambos enfileirarem o mesmo rótulo, não é um conflito e não o duplica.

Só às vezes

Um registro pode dizer quando vale a pena. Adicione um when próximo ao op, em um pacote com "manifest_version": 2:

a presentation_bindings record

{
  "op": "add",
  "id": "my_mod:snowy_cloak",
  "subject": "wool_cloak",
  "kind": "item",
  "slot": "icon",
  "cue": "my_mod:cloak_snowy",
  "when": { "season": { "is": "winter" } }
}

Não há operador e nada para calcular. Tudo o que uma condição pode dizer está nessas duas tabelas.

Máximo de quatro sujeitos em um when, dois ensaios por sujeito. Duas tentativas sobre o mesmo assunto são um intervalo: { "day": { "at_least": 10, "at_most": 30 } }.

Qual família leva o quê. Cada família leva os três decididos no carregamento. Apenas presentation_bindings e effects pegam os quatro que se movem durante o jogo, porque apenas esses dois são reconstruídos quando o mundo muda. A indicação de season em outro lugar é rejeitada, e a mensagem diz quais disciplinas aquela família realmente cursa.

A razão são os resgates. Um registro que decide um item, uma pessoa ou uma missão deve ser o mesmo registro na próxima vez que for carregado, e uma condição de movimentação é exatamente o que o impede de fazer isso.

Uma skin sazonal vai para o link, não para a imagem. Traga a imagem apenas uma vez, depois dois registros presentation_bindings para ela: um com when, outro sem. images, audio e fonts rejeitam um when sem discussão.

Retido não é rejeitado. Uma condição que não é atendida mantém seu registro, e o relatório de carga diz isso pelo nome:

what the game prints back

WITHHELD my_mod:snowy_cloak from my_mod: season is winter, and it is spring

Um pacote com cinquenta recordes de temporada é mantido três quartos a qualquer momento. É o pacote que funciona.

Se alguma associação de apresentação condicional for negada, o relatório ainda mostra a família conforme declarada e imprime bound=0 junto com cada linha WITHHELD; não relata incorretamente o pacote como não tendo superfície de apresentação. Se nenhuma ligação incondicional fornecer o mesmo slot, ele também imprimirá NO_APPLICABLE kind/subject/slot com a condição sem resposta, o que significa "nada se aplica neste estado mundial", e não "o registro era inválido". Teste a condição no host ou na pista de tempo de execução com o estado mundial correspondente antes de assumir que a associação foi rejeitada.

Duas versões da mesma coisa. Traz dois registros add com o mesmo id e condições diferentes. Aquele cuja condição se mantém é quem cobra. Se ambos forem válidos, o segundo será rejeitado como duplicado – que é como as condições sobrepostas são relatadas em vez de serem resolvidas pela ordem de arquivo.

Remover algo

remove significa descontinuado, não fora de existência. O registro continua se resolvendo e fica marcado: nada de novo deixa de ser oferecido, guardado em estoque, fabricado ou gerado por ele, e tudo o que um jogador já possui e quem o nomeia continua lendo exatamente o que sempre leu.

a goods record

{ "op": "remove", "id": "iron_ore" }

vendor_inventories é a única família que tira o registro, e apenas porque as regras de salvamento já dizem que ninguém aponta para essa linha.

Um remove não pode transportar um when. Uma retirada que um resgate poderia nomear deve ser decidida; caso contrário, uma identificação será resolvida em uma noite e não na seguinte.

Uma remoção é permanente para uma composição. Um patch, replace ou segundo remove subsequente direcionado ao ID retirado é rejeitado, mesmo que um recall de mercadorias mantenha o registro antigo solucionável por meio de sua remoção permanente. Isso evita que o relatório salvo indique "retirado" enquanto um pacote subsequente faz com que o registro se comporte como fornecido novamente. Adicione um novo ID de namespace quando precisar de um novo registro; Não confie na remoção seguida de uma ressurreição silenciosa.

Quando dois mods querem a mesma coisa

Ambos carregam. Cada mudança é composta antes de qualquer coisa ser construída, então o jogo vê ambos.

Ganhar e obter permissão são duas questões diferentes, e essa é a parte surpreendente. O jogo sempre calcula qual pacote ele escreve por último – deixar isso ao acaso faria com que até mesmo o lançamento de uma moeda fosse uma rejeição – e ainda sinaliza o par como uma colisão que ninguém declarou. O validador offline rejeita o mesmo par sem discussão, então você descobre antes do jogador.

supersedes em seu manifesto é a sua maneira de dizer que você fez isso de propósito. Nomeie o ID do outro pacote e o conflito se tornará declared_replacement: registrado, com motivo e não mais um erro.

Dê ao seu pacote um load_order próprio. Dois pacotes que compartilham um número não são rejeitados, e então o vencedor sai da ordem alfabética do id do mod: uma ordem que nenhum autor escolheu e que nenhum jogador pode ler na tela.

Imagens, som, escrita, cor

Trazer um arquivo e usá-lo são duas etapas separadas e você precisa de ambas. Um arquivo para o qual nada aponta é lido, verificado, medido e nunca exibido.

Traga o arquivo

Cada família de recursos é um descritor de arquivo mais os arquivos que ela nomeia. O descritor deve ser nomeado como sua família: images.json, audio.json, fonts.json.

where the files go

content/assets/images/
  images.json
  river_guard.png

a images record

[
  {
    "id": "northern_reach:river_guard",
    "file": "river_guard.png",
    "format": "png"
  }
]

Três regras que valem:

• O cabeçalho é verificado antes de qualquer coisa decodificá-lo. format é o que o arquivo é, não o que a extensão afirma.
• Um nome file que contém .. ou ~, ou que começa com /, \, res:// ou user://, é rejeitado no nome.
• Um id que não resolve recebe um espaço reservado e um aviso, nunca silenciado.

Aposte nisso

Em um registro que você carrega, com um campo que leva o ID da sua imagem:

Em qualquer coisa, incluindo conteúdo do jogo base, com um registro presentation_bindings nomeando o assunto, seu tipo e slot:

a presentation_bindings record

[
  {
    "id": "northern_reach:iron_sword_icon",
    "subject": "iron_sword",
    "kind": "item",
    "slot": "icon",
    "cue": "northern_reach:river_guard",
    "alternative_key": "northern_reach_iron_sword_icon_alt"
  }
]

alternative_key é obrigatório quando um slot contém informações: é a chave do idioma que diz a mesma coisa para um jogador que não pode receber a imagem.

Som

role é um limite, não um rótulo: cada um carrega sua própria duração máxima, seu próprio limite de quantos jogam juntos e o cursor que o jogador procura.

Um WAV compactado é rejeitado: decodificá-lo requer um analisador, e o analisador é exatamente o que você está evitando.

Escritos

covers nomeia os idiomas para os quais sua fonte carrega glifos e a compilação se recusa a instalá-la para quaisquer outros. Um caractere sem idioma não falha: desenhe quadradinhos, e a tela parece uma tradução incompleta, com o texto certo e falha na fonte.

fallback_font é obrigatório: nomeie outro ID de fonte de sua preferência ou uma família de sistema (Segoe UI, Noto Sans). sizes é o que o cache de glifo é calculado.

Apenas um caractere, nunca uma coleção — um .ttc contém vários e qual deles chega depende de um índice que o descritor não pode carregar. Fontes gratuitas com ampla cobertura: Google Fonts, Font Squirrel. Verifique se a licença permite redistribuir o arquivo - seu pacote o contém.

Cor

Tokens, nunca uma cena, roteiro ou caminho de recurso. Os nomes são os do jogo: bg_deep, bg_mid, bg_button, bg_hover, border, border_hi, text, text_dim, accent, gold. Um nome que esta compilação não conhece é mencionado no log em vez de parecer ter sido aplicado.

a themes record

[
  {
    "id": "northern_reach:dusk",
    "tokens": {
      "bg_deep": { "kind": "colour", "value": "#12131a" },
      "text": { "kind": "colour", "value": "#e8e2d0" },
      "border": { "kind": "colour", "value": "#7f6ab0" }
    },
    "contrast_pairs": [
      { "text": "#e8e2d0", "background": "#12131a" }
    ]
  }
]

contrast_pairs são verificados em uma proporção de 4,5 e abaixo disso o tema é rejeitado. O medidor WebAIM informa a proporção de um par antes de usá-lo.

Desligue o pacote e a interface recupera suas cores e escritas.

Arte que faz bem

A construção verifica se uma imagem é uma imagem. Não tem nada a dizer sobre se parece certo, e em um mundo desenhado em cinza, uma espada brilhante, alegre e de alta resolução não deixa de estar errada ao passar por todos os escrutínios. Isto é o que se sabe hoje.

O guia de estilo completo ainda não foi publicado. O que ele trará: a paleta em si, as dimensões em que cada tipo de coisa é desenhada e exemplos lado a lado do que entra no mundo e do que sai dele. Vale a pena esperar em vez de adivinhar, porque a falha que ele evita não é um arquivo rejeitado: é um pacote que se instala perfeitamente e faz o jogo parecer dois jogos.

Enquanto não existir, o método confiável é aquele que não necessita de nenhum documento: coloque sua imagem ao lado da imagem do jogo e vejam-nas juntas.

Seus mapas

Desenhe em Tiled, exporte para .tmj e indexe para content/world/maps/maps.json.

a maps record

[
  {
    "id": "northern_reach:river_bend",
    "file": "river_bend.tmj",
    "name_key": "NORTHERN_REACH_RIVER_BEND",
    "world_origin": [4096, 2560],
    "region_id": "northern_reach:lowlands"
  }
]

Um link que nomeia o conteúdo de outro pacote — ou do jogo base — faz com que todo o layout seja rejeitado. modding_map_report nomeia a provisão e a regra que a rejeitou.

Suas missões

Uma missão é um conjunto de registros que só fazem sentido juntos, em content/narrative/quest_plans.

a quest_plans record

[
  {
    "kind": "arc",
    "id": "northern_reach:the_long_winter",
    "stages": ["northern_reach:bring_the_grain"]
  },
  {
    "kind": "quest",
    "id": "northern_reach:bring_the_grain",
    "name_key": "northern_reach.quest.bring_the_grain.name",
    "giver": "northern_reach:the_reeve",
    "in_arc": "northern_reach:the_long_winter",
    "objectives": ["northern_reach:gather_grain"],
    "rewards": [
      { "grant": "receive_coin", "coin": 250 }
    ]
  },
  {
    "kind": "objective",
    "id": "northern_reach:gather_grain",
    "quest": "northern_reach:bring_the_grain",
    "goal": "collect_item",
    "target": "northern_reach:winter_grain",
    "count": 40
  },
  {
    "kind": "ending",
    "id": "northern_reach:the_barns_are_full",
    "arc": "northern_reach:the_long_winter",
    "requires": ["northern_reach:bring_the_grain"]
  }
]

• Um plano é tudo ou nada. Um registro errado e nenhum é instalado: a alternativa é um arco que para no meio do caminho com o jogador segurando a espada e não o título.
• Uma recompensa é um grant, nunca um kind. kind indica qual dos quatro registros é esse. Uma recompensa escrita com kind é lida muito bem e é rejeitada.

Verifique o seu com modding_quest_plan_report.

Suas conversas

Uma conversa consiste em três tipos de registros em content/narrative/dialogue: o dialogue_graph que a nomeia e diz em qual barra ela abre, as barras dialogue_node que são as linhas e as opções dialogue_option que estão acima dela.

Sua fala é a sua fala, e nada a reescreve. O que um modelo local pode fazer é responder a uma pergunta que o jogador escreve ao personagem, permanecendo dentro do que sua fala diz — e quando não consegue ficar dentro, ele diz que não sabe. É o jogador quem decide se aquela superfície existe; com o modelo desligado, o personagem diz sua frase e para. A tradução da sua piada vem dos arquivos de idioma, como tudo o mais que você escreve.

O gráfico nomeia speaker e o gatilho está todo lá. Cada personagem do jogo pergunta a esta família quais conversas estão acima deles quando clicado, para que você possa dar ao ferreiro algo a dizer sem redefinir o ferreiro.

a dialogue record

[
  {
    "kind": "dialogue_graph",
    "id": "northern_reach:gate_toll",
    "entry": "northern_reach:gate_open",
    "speaker": "gate_warden",
    "name_key": "TALK_PACK_GATE"
  },
  {
    "kind": "dialogue_node",
    "id": "northern_reach:gate_open",
    "graph": "northern_reach:gate_toll",
    "voice": "line",
    "speaker": "gate_warden",
    "line_key": "TALK_PACK_GATE_OPEN"
  }
]

Você escreve a conversa, nunca as palavras: cada piada é uma chave de idioma, então o mesmo pacote pode ser lido em todos os idiomas que o jogador possui. Um pacote contendo prosa é rejeitado no arquivo em vez da tela.

Uma piada e uma escolha podem conter cada uma das condições, e uma escolha pode conter comandos. Uma condição decide se a coisa será mostrada ao jogador; um comando é o que acontece quando ele o executa.

• Uma conversa nomeando algo que esta compilação não pode fazer nunca é aberta. Não é a escolha que a utiliza: a conversa inteira, antes da primeira linha. Uma discussão que para na terceira opção já levou as moedas do jogador.
• Nada se move mais do que existe. Pergunte primeiro com has_coin ou has_item; um pacote que se esquece disso não pode deixar o jogador com menos quarenta moedas, porque ninguém aceitou uma dívida e nenhuma tela a explica.
• Toda piada precisa de uma saída. Uma piada que um jogador pode entender e da qual não pode fugir é rejeitada quando o gráfico é carregado.

Verifique o seu com modding_dialogue_report.

Suas cenas

Uma cena é o único tipo de conteúdo que tira o controle do jogador, então também é o único com uma regra de finalização. As cenas vivem em content/narrative/scenes e cada uma nomeia um where, o local onde é reproduzida. Entre naquele lugar e a cena começa.

a scenes record

[
  {
    "id": "northern_reach:the_morning_after",
    "where": "northern_reach:waystation",
    "beats": [
      { "beat": "fade_in", "seconds": 1.5 },
      { "beat": "lock_player" },
      { "beat": "say", "actor": "gate_warden", "line_key": "SCENE_PACK_GREETING" },
      { "beat": "wait", "seconds": 1.0 },
      { "beat": "unlock_player" }
    ]
  }
]

• Uma cena que remove controles deve devolvê-los. Uma sequência que termina sem unlock_player é rejeitada, pois a alternativa é trazer uma sala da qual o jogador só poderá sair fechando o jogo.
• As linhas seguem em ordem e uma linha de bloqueio é esperada. Isso é o que torna uma cena uma cena, em vez de uma lista de coisas acontecendo ao mesmo tempo.

Verifique o seu com modding_scene_report.

Suas capturas de tela

O layout de uma tela informa quais seções vão em qual painel da tela o jogo já possui e em que ordem. Ele apresenta as peças que esta construção desenha; ele não pode adicionar uma, porque uma seção que ninguém escreveu não tem nada para desenhar.

As provisões residem em content/ui/screens. As famílias, uma por uma tem campos e um registro para copiar.

Verifique o seu com modding_screen_report.

Nada apareceu

Leia primeiro o status na tela Mod. Quase todos os estados nomeiam o problema abertamente, na linha, e o mesmo acontece com o erro mais comum de todos: aquele que já esteve no topo desta lista.

A família faltando em content_types. Você escreve goods.json, esquece "goods" na lista de manifesto e a pasta nunca é aberta: nada é rejeitado, porque nada foi lido. O pacote é carregado vazio. Agora a tela informa por qual arquivo ele passou e o que adicionar:

what the game prints back

content/economy/goods/goods.json was not read — add "goods" to content_types in mod.json

O validador offline imprime a mesma frase, portanto os dois não podem discordar. Somente se a linha indicar carregado e não nomear nenhum arquivo não lido, desça nesta lista. Está na ordem de quantas vezes cada um é o culpado.

Os relatórios nunca deixam você em dúvida. Um registro rejeitado é nomeado, o que há de errado com ele e geralmente com um código — consulte Cada código de diagnóstico.

Apareceu e está errado

O caso mais difícil, porque nada é relatado. Duas coisas passam por todo o escrutínio e ainda dão a você um registro que você não escreveu.

Um campo omitido não é um erro: é um valor padrão. O esquema de cada família informa quais campos sem os quais um registro não pode ser instalado e, para quase todas as famílias, essa lista é curta. goods requer exatamente um: id. Omita base_price e será 1. Omita weight e será 1.0. Omita category e a mercadoria será uma matéria-prima. Nada te alerta, porque não há nada de errado: você pediu um bem e conseguiu.

Mesmo um valor que não esteja entre as opções é um valor padrão. O leitor coloca todas as letras maiúsculas antes de pesquisar, então manufactured e MANUFACTURED são o mesmo valor e capitalização nunca é o problema: não comece a reescrever arquivos para isso. O problema é MANUFACTURED_GOODS: não é membro, então se torna RAW_MATERIAL. SLOW para um decay_tier torna-se ETERNAL. O disco é instalado, a tela diz aplicada e sua vela tem o preço e a perecibilidade de outra coisa.

Nada no jogo diz isso, porque não há nada a dizer: o campo é declarado como uma string, e uma string com erro ortográfico ainda é uma string. O validador é o único lugar onde você pode levá-lo, e agora é preciso:

typed into the debug console

$ python tools/quality/validate_mod_data.py --root mods/northern_reach
WARN: northern_reach:goods:goods.json#1: category is "MANUFACTURED_GOODS",
  which is not one of RAW_MATERIAL, MANUFACTURED, CONSUMABLE, AMMUNITION,
  EQUIPMENT. It loads as RAW_MATERIAL.
  ERROR=0 WARN=1

Um aviso e não um erro, porque o registro realmente carrega e rejeitá-lo agora quebraria os pacotes que já funcionam. --strict transforma isso em um erro e é a razão pela qual você executa --strict antes de postar.

Um campo que você omitiu permanece silencioso e não pode ser tomado: omitir category e escrever RAW_MATERIAL são a mesma solicitação. Portanto, as tabelas de campos em As famílias, uma por uma marcam Obrigatório e fornecem a coluna de valores como a forma que o carregador verifica. Quando um registro carrega e se comporta como outra coisa, primeiro compare seus campos com aquela tabela: o que você está procurando é um campo que você não escreveu ou uma palavra que o carregador não reconheceu.

Cada família

Uma pasta e um relatório por família. A coluna de status é medida na construção, então nunca é uma promessa que o jogo não cumpra. O que é é apenas a linha de abertura, para que a tabela permaneça algo que você possa percorrer com os olhos; a descrição completa de cada família, com seus campos e um registro para copiar, é o seu verbete em As famílias, uma por uma.

• Pronto para usar — formulário publicado, o jogo instala seus registros, há um exemplo, e seus ids sobrevivem a um salvamento e recarregamento.
• Validado, nada o consome ainda — o carregador lê e verifica a família, mas nenhuma superfície de pacote voltada ao jogador a consome. Pacotes de áudio e fontes estão neste nível: um relatório limpo não faz um sinal silencioso nem uma fonte sem uso aparecer no jogo.
• Verificado, ainda não instalado — o jogo reconhece a família e verifica seu arquivo, e nada o coloca em um jogo em andamento. Um pacote direcionado a ele passa em todas as verificações e não carrega nada. Está na página de propósito: a alternativa é que alguém passe uma noite lá sem nunca descobrir que não fez nada de errado.

Decidido na íntegra, sem família para carregá-los, então nenhum cartaz pode perguntar a ela:

Isto não é desperdício. O que um mod nunca pode fazer é essa lista.

As famílias, uma por uma

Cada família que a construção conhece, o que aceita e um registro que você pode copiar.

• Os campos obrigatórios são aqueles sem os quais um registro não pode ser instalado.
• A coluna de valores é a forma que o carregador verifica, não uma dica.
• Onde uma família diz isso, um campo que a tabela não nomeia é rejeitado junto com o registro em que está. Um erro de digitação no nome de um campo é um registro que não carrega, e o relatório da família diz isso pelo nome.

Cada entrada também diz o que acontece com um save no dia em que um jogador desinstala você:

Não há nada escrito à mão aqui. Os campos vêm do esquema publicado de cada família. Cada exemplo é um dos pacotes que a matriz de teste da estrutura gira no carregador, colocado de volta no namespace northern_reach e verificado novamente em relação ao seu padrão ao entrar nesta página: um exemplo que o jogo rejeitaria causa falha na compilação.

O mundo e os lugares que ele contém

5 famílias: buildings, caravans, maps, pois, world_generation.

buildings

Definições de edifícios e serviços do assentamento: rótulo, cor, função e interior reaproveitado.

• Status Pronto para usar
• Viajou em O serviço de um edifício
• Pasta content/world/buildings
• Registros roteados para o campo id
• Relatório modding_building_report
• Se um jogador desinstalar você substitute_placeholder. Um assentamento com um buraco onde houve um saque é impossível de jogar; um edifício visivelmente desaparecido é lido e recuperado.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado buildings.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a buildings record, under content/world/buildings

[
  {
    "id": "northern_reach:guildhall",
    "label": "Guild Hall",
    "role": "reeve",
    "color": {
      "r": 0.4,
      "g": 0.34,
      "b": 0.26
    },
    "interior_service": "moot_hall"
  }
]

caravans

Rotas comerciais que uma caravana percorre: de onde sai, para onde vai, o que traz, quão bem é escoltada e com que rapidez se desloca.

• Status Pronto para usar
• Pasta content/logistics/caravans
• Registros roteados para o campo id
• Relatório modding_caravan_report
• Se um jogador desinstalar você preserve_inert_reference. Uma rota cujo pacote desapareceu mantém seu nome e não transporta nada. Substituir um destino enviaria as mercadorias do jogador para um lugar que ele nunca aceitou.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado caravans.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a caravans record, under content/logistics/caravans

[
  {
    "id": "northern_reach:salt_road_run",
    "display_name": "Salt Road Run",
    "origin_settlement_id": "valdmere",
    "destination_settlement_id": "old_seat",
    "cargo_type": "salt",
    "cargo_value": 240,
    "guard_strength": "light",
    "daily_progress": 0.08,
    "initial_spawn_offset_days": 3
  }
]

maps

Arranjos que um pacote desenha no Tiled, nomeados por id: o arquivo, onde ele está no mundo e a chave do idioma pelo qual é conhecido. O índice é o registro; o arranjo próximo a ele é lido como dados e nunca como um recurso, normalizado em forma canônica, verificado em relação ao kit publicado e montado antes de qualquer coisa ser colocada. Um layout rejeitado não coloca absolutamente nada, pois metade do mapa é uma região em que o jogador entra sem saber qual metade chegou.

• Status Pronto para usar
• Pasta content/world/maps
• Registros roteados para o campo id
• Relatório modding_map_report
• Se um jogador desinstalar você drop_optional_presentation. Nenhum resgate nomeia uma disposição. Um salvamento nomeia o ponto de interesse para o qual um layout foi movido, e esse registro mantém sua coordenada, portanto, um mapa retirado custa o layout e nunca o conteúdo. Abandonar isso é o que faz o mundo voltar ao que dizem seus registros, em vez de manter uma posição que ninguém mais fornece.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado maps.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a maps record, under content/world/maps

[
  {
    "id": "northern_reach:river_bend",
    "file": "river_bend.tmj",
    "name_key": "MAP_RIVER_BEND",
    "world_origin": [
      4096,
      2560
    ],
    "region_id": "northern_reach:lowlands"
  }
]

pois

Pontos de interesse colocados por coordenadas no mapa mundial manuscrito.

• Status Pronto para usar
• Rota para Um lugar no mapa
• Pasta content/world/pois
• Registros roteados para o campo id
• Relatório modding_poi_report
• Se um jogador desinstalar você preserve_inert_reference. Um lugar descoberto permanece descoberto. Missões e histórico de viagens apontam para o id.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado pois.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a pois record, under content/world/pois

[
  {
    "id": "northern_reach:drowned_mile",
    "kind": "RUINS",
    "display_name": "The Drowned Mile",
    "description": "A stretch of road the river took back. The milestones still stand, chest deep.",
    "world_position": {
      "x": 0.0,
      "y": 0.0
    },
    "discovery_radius": 3.0,
    "one_time_loot": true,
    "morale_modifier": -1,
    "awareness_modifier": 0.05,
    "narrative_significance_key": "POI_DROWNED_MILE_LORE"
  }
]

world_generation

Perfis de geração feitos apenas de dados: escolhas ponderadas de bioma e localização, de propriedade do hospedeiro.

• Status Pronto para usar
• Pasta content/world/generation
• Registros roteados para o campo id
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. Um save registra o id do perfil escolhido. Se o pacote estiver faltando, manter e relatar esse ID é mais seguro do que reconstruir silenciosamente o jogo com o mapa base do jogo.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado profiles.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a world_generation record, under content/world/generation

[
  {
    "kind": "generation_profile",
    "id": "northern_reach:ashen_reach",
    "stream": "northern_reach:world_stream",
    "tables": {
      "biomes": [
        {
          "id": "plains",
          "weight": 60
        },
        {
          "id": "forest",
          "weight": 30
        },
        {
          "id": "hills",
          "weight": 10
        }
      ],
      "settlements": [
        {
          "id": "northern_reach:hamlet",
          "weight": 100
        }
      ],
      "buildings": [
        {
          "id": "northern_reach:longhouse",
          "weight": 100
        }
      ],
      "pois": [
        {
          "id": "northern_reach:standing_stone",
          "weight": 100
        }
      ]
    }
  }
]

Pessoas, famílias e o que podem fazer

8 famílias: enemy_archetypes, enemy_variants, group_archetypes, mercenary_templates, noble_houses, npc_definitions, perks, relationships.

enemy_archetypes

Tipos de inimigos que o nível estratégico conhece: classificação, quais variantes eles implantam, onde acampam, qual é o tamanho da guarnição e com que frequência eles atacam.

• Status Pronto para usar
• Pasta content/threat/enemy_archetypes
• Registros roteados para o campo id
• Relatório modding_enemy_archetype_report
• Se um jogador desinstalar você preserve_inert_reference. Um acampamento ainda aponta para o que o estabeleceu. A substituição mudaria silenciosamente o que cerca um assentamento; nomeando a ausência que lemos.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado enemy_archetypes.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a enemy_archetypes record, under content/threat/enemy_archetypes

[
  {
    "id": "northern_reach:salt_reavers",
    "display_name": "Salt Reavers",
    "description": "Coastal raiders who winter inland and burn what they cannot carry.",
    "tier": 2,
    "corruption_chance": 0.1,
    "preferred_camp_biomes": [
      "marsh",
      "coast"
    ],
    "camp_count": 3,
    "garrison_min": 8,
    "garrison_max": 16,
    "aggression": 0.4,
    "raid_cooldown_days": 5,
    "sortie_size_min": 4,
    "sortie_size_max": 9,
    "target_preferences": [
      "caravan",
      "settlement"
    ],
    "camp_glyph": "tent"
  }
]

enemy_variants

Blocos de estatísticas para um tipo de corpo inimigo em campo: classe, classificação, os cinco atributos e os IDs da arma, improvisada e escudo que ela carrega.

• Status Pronto para usar
• Pasta content/combat/enemy_variants
• Registros roteados para o campo id
• Relatório modding_enemy_variant_report
• Se um jogador desinstalar você substitute_placeholder. Um corpo que já esteja em campo sem um bloco de estatísticas não pode ser combatido. Um substituto estável do motor mantém a batalha solucionável e o ID original é preservado ao lado.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado enemy_variants.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a enemy_variants record, under content/combat/enemy_variants

[
  {
    "id": "northern_reach:salt_reaver_archer",
    "archetype_id": "northern_reach:salt_reavers",
    "display_name": "Salt Reaver Archer",
    "variant_class": "archer",
    "tier": 2,
    "strength": 3.0,
    "agility": 5.0,
    "constitution": 3.5,
    "aim": 6.0,
    "will": 2.5,
    "main_weapon_id": "short_bow",
    "ai_behavior": "keeps distance and gives ground rather than trade blows"
  }
]

group_archetypes

Parâmetros estratégicos ajustáveis ​​para um grupo que vive no mapa mundial: raio de alerta, preferência de alvo, número de membros, limites de abastecimento e retirada.

• Status Pronto para usar
• Pasta content/strategic/group_archetypes
• Registros roteados para o campo id
• Relatório modding_group_archetype_report
• Se um jogador desinstalar você substitute_placeholder. A inteligência estratégica deve identificar um limite em algum lugar. Ele responde a um valor padrão do motor, que é o mesmo que esta família já utiliza.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado group_archetypes.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a group_archetypes record, under content/strategic/group_archetypes

[
  {
    "id": "northern_reach:pilgrim_column",
    "display_name": "Pilgrim Column",
    "kind": "nomad",
    "faction_id": "",
    "target_preference": "wandering",
    "aggression": "avoid_player",
    "alarm_radius_px": 300.0,
    "night_aggression_multiplier": 0.5,
    "min_members": 6,
    "max_members": 14,
    "behavior_profile_mix": [
      "coward",
      "balanced"
    ],
    "provisions_max": 6,
    "retreat_hp_pct": 0.6
  }
]

mercenary_templates

Modelos mercenários contratáveis: nome, classe, origem, saúde e moral iniciais, custo de contratação e dia em que aparecem pela primeira vez.

• Status Pronto para usar
• Pasta content/character/mercenaries
• Registros roteados para o campo id
• Relatório modding_mercenary_report
• Se um jogador desinstalar você preserve_inert_reference. Mercenários já contratados vivem no resgate como uma unidade; apenas a lista da taverna perde seu modelo. O id permanece nomeado, então a origem do orgânico ainda pode ser lida.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado mercenaries.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a mercenary_templates record, under content/character/mercenaries

[
  {
    "id": "northern_reach:ditchwater_sapper",
    "display_name": "Ditchwater Sapper",
    "class_id": "skirmisher",
    "background": "Dug siege trenches for whoever was paying, and stopped asking which side it was.",
    "hp_max": 24,
    "morale_start": 70,
    "hire_cost": 180,
    "available_from_day": 6
  }
]

noble_houses

Dados iniciais de uma casa nobre: ​​o senhor, o herdeiro, cujos assentamentos respondem à casa, e quem conta como rival ou aliado.

• Status Pronto para usar
• Pasta content/politics/noble_houses
• Registros roteados para o campo id
• Relatório modding_noble_house_report
• Se um jogador desinstalar você preserve_inert_reference. A consideração de um jogador por uma casa é registrada em sua identidade. Substituir um seria reescrever sem dizer nada aos que eram leais.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado noble_houses.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a noble_houses record, under content/politics/noble_houses

[
  {
    "id": "northern_reach:house_tidewatch",
    "display_name_key": "VALID_NOBLE_HOUSE_MOD_HOUSE_TIDEWATCH",
    "display_name": "House Tidewatch",
    "strength": "reduced",
    "alignment": "isolationist",
    "corruption_risk": "moderate",
    "is_minor": true,
    "lord_state": "ailing",
    "captain_initial_stance": "suspicious",
    "captain_initial_opinion": 35,
    "apex_ambition": 20,
    "apex_claim_legitimacy": 15,
    "house_power_base": 25,
    "lore_summary": "Kept the coast road open for two hundred years and was paid in salt for it."
  }
]

npc_definitions

Definições de NPCs Nomeados.

• Status Pronto para usar
• Entrado Um comerciante que o detém
• Pasta content/narrative/npcs
• Registros roteados para o campo id
• Relatório modding_npc_report
• Se um jogador desinstalar você preserve_inert_reference. Uma pessoa com um nome que o mundo lembra não é a mesma que nunca existiu, e os relatos apontam para o id.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado npcs.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a npc_definitions record, under content/narrative/npcs

[
  {
    "id": "northern_reach:wandering_herbalist",
    "display_name": "Wandering Herbalist",
    "title": "Travelling Healer",
    "role": "NONE",
    "settlement_id": "old_seat",
    "is_vendor": true,
    "vendor_inventory_id": "northern_reach:herb_stall",
    "personality_tags": [
      "gentle",
      "secretive"
    ]
  }
]

perks

Privilégios declarativos: gatilhos e efeitos, sem nenhum manipulador escrito em código.

• Status Pronto para usar
• Pasta content/character/perks
• Registros roteados para o campo id
• Relatório modding_perk_report
• Se um jogador desinstalar você preserve_inert_reference. Um personagem mantém o que ganhou. A remoção de um recurso reescreve silenciosamente um edifício no qual o jogador passou o jogo.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado perks.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a perks record, under content/character/perks

[
  {
    "id": "northern_reach:stoneskin",
    "skill": "armour",
    "name_key": "PERK_STONESKIN",
    "description_key": "PERK_STONESKIN_DESC",
    "kind": "lateral",
    "side": "L",
    "col": 0,
    "row": 7,
    "level": 100,
    "parents": [],
    "icon": "northern_reach:stoneskin_icon"
  }
]

relationships

Padrões de parceiros, políticas de relacionamento limitado, condições de recrutamento e títulos declarativos.

• Status Pronto para usar
• Pasta content/companion/relationships
• Registros roteados para o campo id
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. A semente do relacionamento de um parceiro permanece ligada à sua identidade, portanto, remover um pacote não pode apagar silenciosamente a confiança, o rancor ou o histórico de abandono.

Campos. Esta família contém mais de um tipo de registro e cada tipo é verificado em sua própria lista. Um campo que esta tabela não nomeia é rejeitado junto com o registro.

Um registro com kind: bond:

Um registro com kind: companion_template:

Um registro com kind: recruit_terms:

Um registro com kind: relationship_policy:

Em um arquivo chamado relationships.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a relationships record, under content/companion/relationships

[
  {
    "id": "northern_reach:marsh_policy",
    "kind": "relationship_policy",
    "relation_kinds": [
      "comrade",
      "feud",
      "sworn"
    ],
    "bounds": {
      "floor": -100,
      "ceiling": 100
    },
    "bands": [
      {
        "name": "hostile",
        "from": -100,
        "to": -61
      },
      {
        "name": "cold",
        "from": -60,
        "to": -31
      },
      {
        "name": "wary",
        "from": -30,
        "to": -11
      },
      {
        "name": "neutral",
        "from": -10,
        "to": 10
      },
      {
        "name": "warm",
        "from": 11,
        "to": 40
      },
      {
        "name": "trusted",
        "from": 41,
        "to": 70
      },
      {
        "name": "devoted",
        "from": 71,
        "to": 100
      }
    ],
    "max_change_per_event": 12,
    "decay_per_day": 1
  },
  {
    "id": "northern_reach:hire_terms",
    "kind": "recruit_terms",
    "means": "hire",
    "cost": 240
  },
  {
    "id": "northern_reach:marsh_companion",
    "kind": "companion_template",
    "unit": "northern_reach:marsh_unit",
    "recruit": "northern_reach:hire_terms",
    "loyalty": "northern_reach:marsh_policy",
    "starting_regard": 8,
    "leave_below": -60
  }
]

Coisas, comércio e os números por trás de um confronto

5 famílias: combat_balance, goods, items, recipes, vendor_inventories.

combat_balance

Valores de equilíbrio de combate limitados que ajustam os parâmetros existentes do solucionador sem adicionar regras, operações ou mecânicas.

• Status Pronto para usar
• Pasta content/combat/balance
• Registros roteados para o campo id
• Relatório modding_combat_balance_report
• Se um jogador desinstalar você substitute_placeholder. O saldo é um dado de definição mantido pelo anfitrião, não pelo inventário do jogador. Quando seu pacote está ausente o balanceamento canônico e estável responde, e o carregamento subsequente não traz consigo uma segunda forma de salvar os ajustes.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado balance.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a combat_balance record, under content/combat/balance

[
  {
    "id": "northern_reach:coastal_balance",
    "values": {
      "zone_penalty_head": 22,
      "crit_damage_mult": 1.75,
      "friendly_fire_redirect_chance": 0.2
    }
  }
]

goods

Bens comercializáveis ​​e suas propriedades econômicas.

• Status Pronto para usar
• Viajei em [Um produto para vender](#um produto para vender)
• Pasta content/economy/goods
• Registros roteados para o campo id
• Relatório modding_goods_report
• Se um jogador desinstalar você preserve_inert_reference. Uma acompanhante que nomeia uma mercadoria que ninguém fornece é honesta. Substituí-la mudaria silenciosamente o que o jogador tem.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado goods.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a goods record, under content/economy/goods

[
  {
    "id": "northern_reach:spiced_wine",
    "display_name": "Spiced Wine",
    "category": "consumable",
    "decay_tier": "preserved",
    "base_price": 12,
    "weight": 0.5,
    "tags": [
      "luxury",
      "drink"
    ]
  }
]

items

Itens de inventário, incluindo armas e armaduras.

• Status Pronto para usar
• Pathed in Um item para carregar
• Pasta content/inventory/items
• Registros roteados para o campo id
• Relatório modding_items_report
• Se um jogador desinstalar você preserve_inert_reference. O repositório continua nomeando o que estava nele, e essa é a única razão pela qual a reinstalação o devolve a eles.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado items.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a items record, under content/inventory/items

[
  {
    "id": "northern_reach:spiced_wine_bottle",
    "display_name": "Bottle of Spiced Wine",
    "category": "CONSUMABLE",
    "rarity": "UNCOMMON",
    "weight": 0.5,
    "max_stack": 10,
    "base_value": 14,
    "sellable": true,
    "tags": [
      "drink",
      "luxury"
    ]
  }
]

recipes

Receitas artesanais: o que se consome, o que sai, onde é feito, quanto custa e qual a probabilidade de estragar.

• Status Pronto para usar
• Pasta content/economy/recipes
• Registros roteados para o campo id
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. Nada em um salvamento nomeia uma receita: um salvamento nomeia o objeto que um processo produziu, e a família desse objeto é responsável por ele. O que uma receita aposentada deixa para trás é uma estação que não oferece mais algo, que é relatado em vez de corrigido, pois inventar uma receita substituta colocaria na mão do jogador um item que nenhum pacote fornece.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado recipes.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a recipes record, under content/economy/recipes

[
  {
    "id": "northern_reach:salt_cured_ration",
    "display_name_key": "VALID_RECIPE_MOD_SALT_CURED_RATION",
    "recipe_kind": "normal",
    "inputs": {
      "salt": 1,
      "dried_meat": 2
    },
    "output_item_id": "northern_reach:salt_cured_ration",
    "output_count": 3,
    "requires_service": "kitchen",
    "gold_cost": 4,
    "time_cost_minutes": 20,
    "success_chance": 0.95,
    "failure_policy": "lose_fuel",
    "quality_policy": "material_inputs",
    "legality": "legal"
  }
]

vendor_inventories

Tabelas de abastecimento do comerciante.

• Status Pronto para usar
• Entrado Um comerciante que o detém
• Pasta content/world/vendor_inventories
• Registros roteados para o campo id
• Relatório modding_vendor_inventory_report
• Se um jogador desinstalar você drop_optional_presentation. Os estoques são regenerados. Um comerciante com uma prateleira vazia é um estado legível e a linha não aponta para mais nada.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado vendors.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a vendor_inventories record, under content/world/vendor_inventories

[
  {
    "id": "northern_reach:herb_stall",
    "display_name": "Herbalist's Stall",
    "npc_id": "northern_reach:wandering_herbalist",
    "global_price_multiplier": 1.0,
    "buyback_rate": 0.4,
    "entries": [
      {
        "item_id": "northern_reach:spiced_wine_bottle",
        "kind": "consumable",
        "daily_stock": 3,
        "price_multiplier": 1.1,
        "restock_days": 2,
        "min_standing": 0
      }
    ]
  }
]

História, missões e as palavras que um jogador lê

9 famílias: dialogue, locales, lore, mr_lines, progress, quest_metadata, quest_plans, quests, scenes.

dialogue

Conversas como registros: o gráfico, suas piadas e as escolhas que nele constam. Três tipos compartilham a família e kind diz qual deles. Um pacote escreve a conversa, nunca as palavras — cada pressionamento de tecla é uma chave de linguagem — e cada condição e cada consequência é uma verificação ou comando que esta compilação já executa.

• Status Pronto para usar
• Pasta content/narrative/dialogue
• Registros roteados para o campo id
• Relatório modding_dialogue_report
• Se um jogador desinstalar você preserve_inert_reference. Um save registra o que uma conversa fez – uma missão que mudou, um objeto que mudou de mãos, uma verdade aprendida – nunca a conversa em si, que termina no momento em que você escreve algo. Quando o pacote vai embora, as consequências permanecem porque eles nunca fizeram parte da conversa e a conversa simplesmente não é mais oferecida. Substituí-lo colocaria na boca de um personagem palavras que seu autor nunca escreveu.

Campos. Esta família contém mais de um tipo de registro e cada tipo é verificado em sua própria lista. Um campo que esta tabela não nomeia é rejeitado junto com o registro.

Um registro com kind: dialogue_graph:

Um registro com kind: dialogue_node:

Um registro com kind: dialogue_node:

Um registro com kind: dialogue_node:

Um registro com kind: dialogue_option:

Em um arquivo chamado gate_toll.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a dialogue record, under content/narrative/dialogue

[
  {
    "kind": "dialogue_graph",
    "id": "northern_reach:gate_toll",
    "entry": "northern_reach:gate_open",
    "speaker": "gate_warden",
    "name_key": "TALK_PACK_GATE_TOLL_NAME",
    "description_key": "TALK_PACK_GATE_TOLL_DESC"
  },
  {
    "kind": "dialogue_node",
    "id": "northern_reach:gate_open",
    "graph": "northern_reach:gate_toll",
    "voice": "line",
    "speaker": "gate_warden",
    "line_key": "TALK_PACK_GATE_OPEN"
  },
  {
    "kind": "dialogue_option",
    "id": "northern_reach:opt_pay_the_toll",
    "node": "northern_reach:gate_open",
    "label_key": "TALK_PACK_OPT_PAY",
    "goto": "northern_reach:gate_paid",
    "commands": [
      {
        "step": "pay_coin",
        "coin": 25
      },
      {
        "step": "change_relation",
        "subject": "player",
        "target": "gate_warden",
        "delta": 4
      }
    ]
  }
]

O aparelho contém 12 registros; 3 são mostrados.

locales

As palavras que um jogador lê, em CSV com uma coluna por idioma: as chaves do próprio pacote e as do jogo onde o pacote declara a substituição.

• Status Pronto para usar
• Pasta content/locale
• Relatório modding_locale_report
• Se um jogador desinstalar você preserve_inert_reference. Um save dá nome ao disco, nunca as palavras que o dizem, então um pacote retirado entre duas sessões custa uma tradução e nada. A chave é preservada e aparece, o que parece uma tradução ausente, em vez de conteúdo ausente.

Colunas. Uma coluna que esta tabela não nomeia é rejeitada com o registro.

Em um arquivo chamado words.csv. O nome do arquivo é metade do endereço e o ID da linha é a outra metade, então dois arquivos podem conter o mesmo ID de linha sem colidir:

a locales file

key,en,it
word_pack:GOOD_FROST_SALT,Frost Salt,Sale di Brina

lore

Entradas do Codex: lugares, pessoas, eventos, costumes e coisas sobre as quais um mundo conta histórias. Uma entrada carregada não é uma entrada conhecida.

• Status Pronto para usar
• Pasta content/narrative/lore
• Registros roteados para o campo id
• Relatório modding_lore_report
• Se um jogador desinstalar você preserve_inert_reference. Uma entrada do Codex que um jogador leu é algo que ele viu. Retirá-lo apaga parte do que ele sabe sobre o mundo em que passou algum tempo, e missões e outras entradas apontam para o id.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado lore.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a lore record, under content/narrative/lore

[
  {
    "id": "northern_reach:the_drowned_causeway",
    "category": "place",
    "title_key": "STORY_PACK_DROWNED_CAUSEWAY_TITLE",
    "body_key": "STORY_PACK_DROWNED_CAUSEWAY_BODY",
    "era": "before_the_mark",
    "citation_key": "STORY_PACK_CAUSEWAY_CITATION"
  },
  {
    "id": "northern_reach:the_tide_watch",
    "category": "custom",
    "title_key": "STORY_PACK_TIDE_WATCH_TITLE",
    "body_key": "STORY_PACK_TIDE_WATCH_BODY",
    "relates_to": [
      "northern_reach:the_drowned_causeway"
    ]
  }
]

mr_lines

Linhas estruturadas de realismo medieval, roteadas por arquivo e id de linha em vez de um campo de id no JSON.

• Status Pronto para usar
• Pasta content/medieval_realism/structured
• Relatório modding_mr_lines_report
• Se um jogador desinstalar você drop_optional_presentation. Uma piada de cores à qual nada se refere. Removê-lo não custa nada e mantê-lo mostraria uma string vazia.

Colunas. Uma coluna sem nome nesta tabela é permitida e deve ser um valor simples em vez de uma lista ou objeto.

Cada registro precisa de pelo menos um dentre public_line, public_label, public_summary_line.

Estes nomes são rejeitados sem questionamento, sejam eles quais forem: unsafe_example, unsafe_reason, audit_note, expected_block_reason, script, scene, resource_path. Algumas são as colunas de verificação com as quais aqueles que jogam escrevem e outras são os nomes em forma de código que [O que um mod nunca pode fazer](#o que um mod-pode-nunca-fazer) rejeita em todos os lugares. Um registro com um é rejeitado em vez de ser apagado silenciosamente.

Em um arquivo chamado MR_L03_TAVERN_INN_LINES.csv. O nome do arquivo é metade do endereço e o ID da linha é a outra metade, então dois arquivos podem conter o mesmo ID de linha sem colidir:

a mr_lines file

line_id,tavern_state,speaker_role,tone,public_line,mechanical_hint
northern_reach:tavern_extra_01,evening_rush,innkeeper,welcoming,"Warm bread and a clean cup if you've the coin for it, friend.",food_only

progress

Registros de progressão do jogador: objetivos, perfis de dificuldade seguros e perfis de partida dentro das regras do anfitrião.

• Status Pronto para usar
• Pasta content/player/progress
• Registros roteados para o campo id
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. As conquistas conquistadas e os perfis de jogo escolhidos permanecem nomeados quando o pacote está ausente; tirá-los silenciosamente reescreveria a história do jogador ou o contrato do jogo.

Campos. Esta família contém mais de um tipo de registro e cada tipo é verificado em sua própria lista. Um campo que esta tabela não nomeia é rejeitado junto com o registro.

Um registro com kind: achievement:

Um registro com kind: difficulty_profile:

Um registro com kind: run_profile:

Em um arquivo chamado progress.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a progress record, under content/player/progress

[
  {
    "id": "northern_reach:hard_tide",
    "kind": "difficulty_profile",
    "name_key": "DIFF_HARD_TIDE",
    "description_key": "DIFF_HARD_TIDE_DESC",
    "modifiers": {
      "enemy_strength_percent": 140,
      "coin_gain_percent": 80
    },
    "permadeath": true
  },
  {
    "id": "northern_reach:tide_run",
    "kind": "run_profile",
    "name_key": "RUN_TIDE",
    "description_key": "RUN_TIDE_DESC",
    "difficulty": "northern_reach:hard_tide",
    "seed_stream": "tide"
  },
  {
    "id": "northern_reach:held_tide",
    "kind": "achievement",
    "name_key": "ACH_HELD_TIDE",
    "description_key": "ACH_HELD_TIDE_DESC",
    "condition": [
      {
        "when": "days_survived",
        "count": 30
      }
    ],
    "icon": "tower"
  }
]

quest_metadata

Registros de metadados da missão, indexados por quest_id em vez de id.

• Status Pronto para usar
• Pasta content/narrative/quest_metadata
• Registros roteados para o campo quest_id
• Relatório modding_quest_metadata_report
• Se um jogador desinstalar você preserve_inert_reference. Ele descreve missões que já poderiam ser reduzidas a uma lápide; retirá-lo os deixaria sem descrição, em vez de ausentes.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado quests.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a quest_metadata record, under content/narrative/quest_metadata

[
  {
    "quest_id": "northern_reach:tavern_errand",
    "world_reason": "settlement_shortage",
    "quest_role": "recovery",
    "difficulty_band": "standard",
    "urgency_band": "soon"
  }
]

quest_plans

Planos de Missão como Registros: Os arcos, missões, objetivos e finais que um pacote escreve e a partir dos quais o jogo constrói suas próprias missões. A forma de registro de uma missão, ao lado de recursos manuscritos, em vez de em seu lugar.

• Status Pronto para usar
• Pasta content/narrative/quest_plans
• Registros roteados para o campo id
• Relatório modding_quest_plan_report
• Se um jogador desinstalar você preserve_inert_reference. Um plano constrói as mesmas missões que o jogo executa, então um aposentado deixa o mesmo buraco que a caligrafia deixaria. O progresso é a única coisa que um jogador não pode reconstruir: uma missão não resolvida é relatada e nunca concluída ou cancelada silenciosamente.

Campos. Esta família contém mais de um tipo de registro e cada tipo é verificado em sua própria lista. Um campo que esta tabela não nomeia é rejeitado junto com o registro.

Um registro com kind: arc:

Um registro com kind: ending:

Um registro com kind: objective:

Um registro com kind: quest:

Em um arquivo chamado the_long_winter.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a quest_plans record, under content/narrative/quest_plans

[
  {
    "kind": "arc",
    "id": "northern_reach:the_long_winter",
    "name_key": "northern_reach.arc.the_long_winter.name",
    "stages": [
      "northern_reach:bring_the_grain"
    ]
  },
  {
    "kind": "quest",
    "id": "northern_reach:bring_the_grain",
    "name_key": "northern_reach.quest.bring_the_grain.name",
    "description_key": "northern_reach.quest.bring_the_grain.description",
    "giver": "northern_reach:the_reeve",
    "in_arc": "northern_reach:the_long_winter",
    "objectives": [
      "northern_reach:gather_grain",
      "northern_reach:pay_the_toll"
    ],
    "deadline_days": 30,
    "rewards": [
      {
        "grant": "receive_coin",
        "coin": 250
      },
      {
        "grant": "give_item",
        "item": "northern_reach:reeves_seal",
        "count": 1
      }
    ]
  },
  {
    "kind": "objective",
    "id": "northern_reach:gather_grain",
    "quest": "northern_reach:bring_the_grain",
    "goal": "collect_item",
    "target": "northern_reach:winter_grain",
    "count": 40,
    "name_key": "northern_reach.objective.gather_grain.name"
  }
]

O fixture contém 5 registros; 3 são mostrados.

quests

Recursos de missão manuscritos, carregados por rota em vez de interpretados como registros. Um pacote que deseja sua própria missão escreve quest_plans.

• Status Verificado, ainda não instalado
• Pasta content/narrative/quests
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. O progresso é a única coisa que um jogador não pode reconstruir. Uma missão não resolvida é relatada e nunca concluída ou cancelada silenciosamente.

Esta família é carregada por caminho em vez de lida como um registro, e um pacote não pode carregar o arquivo que deseja; veja O que um mod nunca pode fazer. Em vez disso, escreva quest_plans.

scenes

Cenas encenadas: a sala, quem está nela e as falas que se desdobram em ordem. É o único conteúdo que tira o controle do player, e é por isso que uma sequência que nunca chega a end é rejeitada em vez de reproduzida. Piadas e adereços são nomes retirados de listas publicadas; nenhuma cena Godot, nenhum ativo e nenhum script são carregados aqui.

• Status Pronto para usar
• Pasta content/narrative/scenes
• Registros roteados para o campo id
• Relatório modding_scene_report
• Se um jogador desinstalar você preserve_inert_reference. Um save registra o que uma cena fez – um nome escolhido, uma missão movida, uma porta aberta – nunca o fato de que ela foi assistida. É jogado e termina numa única sessão, portanto um pacote que sai custa a cena e nunca a consequência de o ter visto. Substituí-lo representaria algo que o autor nunca escreveu sob o nome de algo que escreveu.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado scenes.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a scenes record, under content/narrative/scenes

[
  {
    "id": "northern_reach:tollhouse_wake",
    "name_key": "STAGE_PACK_TOLLHOUSE_WAKE",
    "stage": {
      "room": [
        880,
        600
      ],
      "light": "candle",
      "props": [
        {
          "prop": "bed",
          "at": "bedside"
        },
        {
          "prop": "storage",
          "at": "east",
          "label_key": "STAGE_PACK_BELONGINGS"
        },
        {
          "prop": "light_marker",
          "at": "north",
          "light": "candle"
        },
        {
          "prop": "walkway",
          "at": "bedside",
          "to": "door"
        }
      ]
    },
    "cast": [
      {
        "actor": "northern_reach:tollkeeper",
        "name_key": "STAGE_PACK_TOLLKEEPER",
        "sprite": "default",
        "at": "bedside"
      }
    ],
    "beats": [
      {
        "beat": "lock_player"
      },
      {
        "beat": "fade_in",
        "seconds": 2.0
      },
      {
        "beat": "say",
        "actor": "northern_reach:tollkeeper",
        "line_key": "STAGE_PACK_WAKE_1"
      },
      {
        "beat": "wait",
        "seconds": 0.8
      },
      {
        "beat": "say",
        "actor": "northern_reach:tollkeeper",
        "line_key": "STAGE_PACK_WAKE_2"
      },
      {
        "beat": "play_cue",
        "cue": "northern_reach:door_latch"
      },
      {
        "beat": "walk_to",
        "actor": "northern_reach:tollkeeper",
        "anchor": "door"
      },
      {
        "beat": "remove_actor",
        "actor": "northern_reach:tollkeeper"
      },
      {
        "beat": "show_exit"
      },
      {
        "beat": "unlock_player"
      },
      {
        "beat": "end"
      }
    ]
  }
]

Como você vê e ouve tudo

7 famílias: audio, effects, fonts, images, presentation_bindings, screens, themes.

audio

Sons que um pacote carrega, nomeados por id: música, ambiente, efeitos e voz, cada um apontando para um arquivo dentro de sua própria pasta e declarando a função que o delimita.

• Status Validado, nada o consome ainda
• Pasta content/assets/audio
• Registros roteados para o campo id
• Relatório modding_audio_report
• Se um jogador desinstalar você preserve_inert_reference. Um save nomeia o assunto e nunca o som acima dele, então um pacote retirado entre duas sessões custa uma atmosfera e não uma coisa. A referência é preservada e relatada: silêncio sem nada a dizer porque é precisamente o estado que esta família existe para evitar.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

No arquivo audio.json, que é o único arquivo através do qual esta pasta é lida:

a audio record, under content/assets/audio

[
  {
    "id": "northern_reach:hearth_hum",
    "file": "hearth_hum.wav",
    "codec": "wav",
    "role": "ambience",
    "duration_seconds": 0.25,
    "sha256": "23fc92432963f74bd638f38ea9d7ddb475853f022810bdc8b344269bf43d5830"
  }
]

effects

Tempo, poeira, faíscas e luzes, compostas a partir dos modelos que o anfitrião disponibiliza. Um pacote nomeia um modelo e define parâmetros dentro de intervalos declarados; não há campo, em lugar nenhum, que carregue um shader, uma cena ou um script - e é isso que permite que um pacote de um estranho peça fogo sem poder pedir um programa.

• Status Pronto para usar
• Pasta content/assets/effects
• Registros roteados para o campo id
• Relatório modding_effect_report
• Se um jogador desinstalar você preserve_inert_reference. Nada em um salvamento nomeia um efeito. O ar retorna ao que o jogo base desenha quando o pacote sai, o que custa um aspecto e nada que o jogador possua.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado effects.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a effects record, under content/assets/effects

[
  {
    "id": "northern_reach:moor_drift",
    "template": "dust_drift",
    "parameters": {
      "amount": 64,
      "lifetime": 6,
      "scale": 2,
      "wind": 4,
      "colour": "#c8bfa8"
    },
    "priority": 40
  }
]

fonts

Tipos de letra que um pacote carrega, nomeados por id: o arquivo, o tamanho em que são desenhados e os idiomas cujos glifos eles carregam. A capa afirma estar exposta, porque um caractere sem os glifos de um idioma não falha: ele desenha pequenos quadrados e a tela parece uma tradução que alguém deixou pela metade.

• Status Validado, nada o consome ainda
• Pasta content/assets/fonts
• Registros roteados para o campo id
• Relatório modding_font_report
• Se um jogador desinstalar você preserve_inert_reference. Nada em um save nomeia um personagem. A interface reverte para a fonte do kit de ferramentas quando o pacote sai, que é a única que qualquer autor teve que escolher.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

No arquivo fonts.json, que é o único arquivo através do qual esta pasta é lida:

a fonts record, under content/assets/fonts

[
  {
    "id": "northern_reach:plain",
    "file": "plain.ttf",
    "format": "ttf",
    "sizes": [
      12,
      16,
      24
    ],
    "oversampling": 1,
    "covers": [
      "en"
    ],
    "fallback_font": "Segoe UI",
    "sha256": "613b1d24f9f8b0365a94f01214155af8e87ca72aa6633befd5e0ee05b3dc4122"
  }
]

images

Imagens que um pacote traz, nomeadas por id: ícones, retratos e folhas de sprites, cada uma apontando para um arquivo dentro de sua própria pasta.

• Status Pronto para usar
• Pasta content/assets/images
• Registros roteados para o campo id
• Relatório modding_image_report
• Se um jogador desinstalar você preserve_inert_reference. Um save nomeia objetos e pessoas, nunca a imagem de um deles, então uma imagem que deixa de resolver custa um desenho e não uma coisa. A referência é preservada e relatada: substituí-la por arte de outro pacote mostraria ao jogador algo que nenhum autor escolheu, e remover o id silenciosamente faria com que o ícone ausente parecesse uma falha de design.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

No arquivo images.json, que é o único arquivo através do qual esta pasta é lida:

a images record, under content/assets/images

[
  {
    "id": "northern_reach:salt_pouch",
    "file": "salt_pouch.png",
    "format": "png"
  }
]

presentation_bindings

Qual recurso de pacote preenche qual espaço em qual assunto: o ícone em um objeto, o sprite em uma unidade ou bloco, o banner em uma facção, tanto para o conteúdo do pacote quanto para o do jogo base.

• Status Pronto para usar
• Pasta content/presentation/bindings
• Registros roteados para o campo id
• Relatório nada dele; modding_preflight_report cuida disso
• Se um jogador desinstalar você preserve_inert_reference. Um save nomeia o sujeito — o objeto, a pessoa, a peça — e nunca a imagem que o reveste, então um link que deixa de resolver custa um desenho e não uma coisa. A referência é preservada e relatada: o sujeito retorna à arte que a construção já possuía, que é a única resposta que nenhum autor teve que escolher.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado bindings.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a presentation_bindings record, under content/presentation/bindings

[
  {
    "op": "add",
    "id": "northern_reach:cloak_icon",
    "subject": "wool_cloak",
    "kind": "item",
    "slot": "icon",
    "cue": "northern_reach:cloak_plain",
    "alternative_key": "item_wool_cloak_icon_alt"
  },
  {
    "op": "add",
    "id": "northern_reach:cloak_icon_winter",
    "subject": "wool_cloak",
    "kind": "item",
    "slot": "icon",
    "cue": "northern_reach:cloak_snowy",
    "alternative_key": "item_wool_cloak_icon_alt",
    "when": {
      "season": {
        "is": "winter"
      }
    }
  }
]

screens

Layouts de tela: quais seções cabem em qual painel da tela o jogo já possui e em que ordem. Possui peças que esta construção desenha e não pode adicionar nenhuma: uma nova tela precisaria de widgets, fontes de dados e manipuladores de cliques, que juntos são uma linguagem de programação.

• Status Pronto para usar
• Pasta content/ui/screens
• Registros roteados para o campo id
• Relatório modding_screen_report
• Se um jogador desinstalar você preserve_inert_reference. Nada em um resgate nomeia uma disposição. Ele decide como uma página é desenhada enquanto o pacote é carregado, e a página reverte para o layout que esta compilação leva consigo quando sai: custa uma skin e nada que o jogador possua.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado screens.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a screens record, under content/ui/screens

[
  {
    "id": "northern_reach:character_sheet",
    "screen": "character_sheet",
    "panels": {
      "header": [
        "header"
      ],
      "left": [
        "vitals",
        "combat"
      ],
      "middle": [
        "attributes",
        "skills"
      ],
      "right": [
        "service",
        "weight",
        "background"
      ]
    }
  }
]

themes

Paletas de interface como tokens: cores, tamanhos e espaçamentos nomeados, com pares cujo contraste o jogador deve ser capaz de ler. Nunca uma cena, roteiro ou caminho de recurso.

• Status Pronto para usar
• Pasta content/assets/themes
• Registros roteados para o campo id
• Relatório modding_theme_report
• Se um jogador desinstalar você preserve_inert_reference. Nada em um save nomeia um tema. A interface volta às cores do kit de ferramentas quando o pacote sai, que é a única paleta que qualquer autor teve que escolher.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado themes.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a themes record, under content/assets/themes

[
  {
    "id": "northern_reach:dusk",
    "tokens": {
      "bg_deep": {
        "kind": "colour",
        "value": "#12131a"
      },
      "bg_panel": {
        "kind": "colour",
        "value": "#1b1c26"
      },
      "bg_panel_hi": {
        "kind": "colour",
        "value": "#262838"
      },
      "text": {
        "kind": "colour",
        "value": "#e8e2d0"
      },
      "text_bright": {
        "kind": "colour",
        "value": "#f4efe2"
      },
      "text_mute": {
        "kind": "colour",
        "value": "#6f6a80"
      },
      "border": {
        "kind": "colour",
        "value": "#7f6ab0"
      },
      "border_dark": {
        "kind": "colour",
        "value": "#14151c"
      },
      "border_soft": {
        "kind": "colour",
        "value": "#4a4560"
      },
      "danger": {
        "kind": "colour",
        "value": "#d4564b"
      },
      "success": {
        "kind": "colour",
        "value": "#7fc46a"
      },
      "warning": {
        "kind": "colour",
        "value": "#e0b13c"
      },
      "accent_player": {
        "kind": "colour",
        "value": "#6f97e8"
      },
      "accent_enemy": {
        "kind": "colour",
        "value": "#c94a4a"
      }
    },
    "contrast_pairs": [
      {
        "text": "#e8e2d0",
        "background": "#12131a"
      },
      {
        "text": "#f4efe2",
        "background": "#1b1c26"
      },
      {
        "text": "#e8e2d0",
        "background": "#262838"
      }
    ]
  }
]

O que o jogador controla e o que ele observa

3 famílias: adaptive, input_bindings, settings.

adaptive

Perfis que analisam o andamento de uma partida e sugerem uma abordagem diferente. O resultado é um conselho e nunca uma mudança: um perfil que pudesse atuar seria a única coisa que um pacote traz capaz de alterar um jogo sem que o jogador ou convidado o tenha solicitado, e num diff pareceria exatamente como uma tabela de ajustes. As entradas são uma lista publicada de agregados de jogos, cada um deles uma contagem ou média que o jogo já possui sobre si mesmo.

• Status Pronto para usar
• Pasta content/player/adaptive
• Registros roteados para o campo id
• Relatório modding_adaptive_report
• Se um jogador desinstalar você drop_optional_presentation. Não há salvamento de nomes de perfil. O que um perfil tocou é um multiplicador recalculado pelos mutadores ativos toda vez que eles mudam, assim um pacote retirado deixa de ser consultado e o jogo volta exatamente para o que o jogador havia escolhido. Nada é preservado, portanto não há nada para preservar.

Campos. Esta família contém mais de um tipo de registro e cada tipo é verificado em sua própria lista. Um campo que esta tabela não nomeia é rejeitado junto com o registro.

Um registro com kind: adaptive_profile:

Um registro com kind: threshold_set:

Em um arquivo chamado adaptive.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a adaptive record, under content/player/adaptive

[
  {
    "kind": "adaptive_profile",
    "id": "northern_reach:hard_roads",
    "name_key": "ADAPTIVE_HARD_ROADS",
    "description_key": "ADAPTIVE_HARD_ROADS_BODY",
    "policy": "pace_encounters",
    "reads": [
      "battles_won_ratio",
      "days_survived",
      "party_size"
    ],
    "fallback_policy": "event_cadence",
    "confidence_floor_percent": 60,
    "sample_days": 14
  },
  {
    "kind": "threshold_set",
    "id": "northern_reach:hard_roads_lines",
    "profile": "northern_reach:hard_roads",
    "name_key": "ADAPTIVE_HARD_ROADS_LINES",
    "thresholds": [
      {
        "signal": "battles_won_ratio",
        "above": 80,
        "advise": "raise"
      },
      {
        "signal": "battles_won_ratio",
        "below": 35,
        "advise": "lower"
      },
      {
        "signal": "party_size",
        "below": 3,
        "advise": "lower"
      },
      {
        "signal": "days_survived",
        "above": 60,
        "advise": "hold"
      }
    ]
  }
]

input_bindings

Ações próprias de um pacote, com a chave que desejarem. O jogador decide: uma sugestão que termina em uma combinação que ele já havia atribuído perde, e a ação vem sem botão, porque um botão que faz outra coisa silenciosamente é pior do que um botão que não faz nada.

• Status Pronto para usar
• Pasta content/input
• Registros roteados para o campo action_id
• Relatório modding_input_report
• Se um jogador desinstalar você preserve_inert_reference. A reatribuição de um jogador permanece armazenada no ID da ação, portanto, a reinstalação do pacote encontra o botão onde você o colocou. A ação em si é removida do mapa de comando quando o pacote sai, então a tela de atribuição nunca lista algo que não responde a nada.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado bindings.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a input_bindings record, under content/input

[
  {
    "action_id": "northern_reach:call_scout",
    "label_key": "KEY_PACK_CALL_SCOUT",
    "context": "exploration",
    "suggested_keyboard": "f9"
  }
]

settings

Opções que um jogador pode alterar, declaradas em vez de sorteadas. Um pacote diz qual é a opção, quais valores ela pode ter e onde reside o valor; o controle é construído pelo convidado. Nada que cruze essa fronteira é um Controle ou um script, e essa é a única razão pela qual um menu de configurações pode mostrar as opções de um estranho sem executar seu código.

• Status Pronto para usar
• Pasta content/settings
• Registros roteados para o campo key
• Relatório modding_settings_report
• Se um jogador desinstalar você preserve_inert_reference. Um valor armazenado permanece sob sua chave, então a reinstalação do pacote encontra a escolha do jogador onde ele o deixou. O que o pacote deixa é uma linha em um perfil que ninguém lê: não custa nada e preserva uma escolha feita pelo jogador.

Campos. Um campo que esta tabela não nomeia é rejeitado com o registro.

Em um arquivo chamado settings.json, ou qualquer nome .json que você quiser dentro dessa pasta:

a settings record, under content/settings

[
  {
    "key": "northern_reach:patrol_density",
    "type": "int",
    "default": 3,
    "minimum": 1,
    "maximum": 9,
    "scope": "campaign",
    "label_key": "OPTION_PACK_PATROL_DENSITY",
    "help_key": "OPTION_PACK_PATROL_DENSITY_HELP"
  },
  {
    "key": "northern_reach:show_road_names",
    "type": "bool",
    "default": true,
    "scope": "presentation",
    "label_key": "OPTION_PACK_SHOW_ROAD_NAMES"
  }
]

Atalhos do console

Estes são um atalho, não uma etapa. Tudo abaixo tem um lugar na tela Mods, que é por onde segue o caminho normal e para onde qualquer pessoa que baixou seu pacote irá procurar. O console é mais rápido quando você está iterando e já está aberto, e só existe em uma versão de depuração: uma cópia publicada do jogo não tem console, então nada que um autor de pacote precisa pode ficar aqui sozinho.

Comece em modding_manifest_report — o jogo vê seu pacote e em que estado? - então modding_preflight_report para um veredicto único sobre tudo instalado. Em seguida, o relatório de cada família.

modding_reload lê seus arquivos novamente sem reiniciar. Edite, use Alt-Tab, digite o comando e veja. Ele reconstrói o que nada está segurando — bindings, efeitos e imagens — e nomeia cada família deixada de lado, porque uma partida está sobre os registros que um save pode nomear:

what the game prints back

HELD BY THE RUN items: edited files are read on the next load

modding_reload all lê tudo novamente e é para uma tela inicial sem nenhum jogo em andamento. modding_condition_report imprime o que o jogo agora pode responder por um when e o que não pode.

Ferramentas off-line

Estas ferramentas são para autores e automação de lançamentos. Elas ficam no checkout público do Bonemark; jogadores que instalam um mod lançado não precisam de Python nem Godot. Se você escreve um mod, clone a versão correspondente de github.com/tallowgames/Bonemark, mantenha seu pacote de trabalho fora da pasta mods do jogador e execute os comandos abaixo a partir desse checkout. O jogo continua sendo a autoridade final do runtime.

Python 3.10 ou mais recente; Godot apenas para pista de tempo de execução. Mantenha seu pacote fora da pasta mods do player e tente uma cópia.

a command line

python tools/modding/new_mod.py --list
python tools/modding/new_mod.py --id my_mod --family goods --family items

Ele escreve um pacote que passa na validação antes mesmo de você escrever qualquer coisa: um mod.json pré-compilado, um registro de trabalho para cada família solicitada e um README com os próximos dois comandos. Os registros vêm de equipamentos que a construção já verifica para essas famílias, portanto, um starter que para de funcionar causa a mesma verificação que faz com que o equipamento falhe, em vez de apodrecer dentro de um modelo. Ele se recusa a gravar em uma pasta chamada mods.

a command line

python tools/quality/validate_mod_data.py --root "<mod-root>"
python tools/quality/validate_mod_data.py --strict --root "<mod-root>"

Verifique mod.json, pastas familiares, ids, esquemas, referências, limites e cargas bloqueadas. --strict transforma avisos em falhas.

Compare a superfície de modding com a versão

Quando o jogo mudar, compare o instantâneo da superfície arquivado antes de atualizar um pacote. Ele contém um resumo, além de campos e operações para cada família pública, portanto o resultado indica qual família foi alterada e por quê:

a command line

python tools/quality/modding_surface_contract.py --json
python tools/quality/modding_surface_contract.py --before "<previous-build>/game/games/bonemark/modding/data/mod_surface_contract.json" --json

A diferença é unchanged, additive ou breaking. Os motivos da falha são explícitos: field_removed, required_added, type_changed, default_changed, constraint_changed, operation_removed e root_changed, format_changed, id_field_changed, catalogue_changed, family_removed e contract_major_changed_without_new_id. Nome de modificação compatível field_added, required_removed, operation_added ou family_added. O comando sem --before também verifica a linha de base armazenada. Se a superfície atual foi movida, a auditoria falhará até que um mantenedor examine os resumos exatos antes/depois em tools/quality/modding_surface_contract_changes.json; uma alteração significativa também deve registrar cada motivo, a decisão, a nota de migração e o revisor. A promoção de um instantâneo intencionalmente revisado é explícita:

a command line

python tools/quality/modding_surface_contract.py --write-baseline

Esta é uma verificação do mantenedor/lançamento; os autores do mod só precisam da comparação --before, e os jogadores que instalam um pacote lançado não precisam executá-lo.

a command line

python tools/modding/mod_test_host.py --root "<mod-root>" --repo-root "<framework-root>" --json

Lê o manifesto, dependências, compatibilidade e ordem de carregamento sem iniciar o Godot e sem executar nenhum pacote.

Nunca abre um arquivo de conteúdo. Esta é a divisão do trabalho: o host responde estes pacotes serão carregados juntos, o validador responde este registro está correto - mas isso significa que um pacote que o validador rejeita ainda pode ser composto de forma limpa aqui. Medidos em quatorze pacotes deliberadamente quebrados, os dois discordam em cada rejeição: o host prepara todos os quatorze refused vazios, incluindo um carregando scripts/payload.sh que apenas o validador encontra. Discar não é o mesmo que instalar com segurança. Faça as duas coisas antes de publicar. Repita --root quando o conjunto de teste for dividido em pastas; o host então compõe o conjunto completo em um plano determinístico.

a command line

python tools/modding/mod_test_matrix.py --repo-root "<framework-root>" --root "<mod-root>" --godot "<godot-exe>" --require-runtime --report "mod_test_matrix.json"

Ele executa o validador, o host de teste, o equipamento de cada família pronto para uso e a pista de tempo de execução Godot. Remova --require-runtime se você não tiver Godot; o relatório dirá então que o teste de tempo de execução foi ignorado e não aprovado.

Para um conjunto composto, repita a opção:

a command line

python tools/modding/mod_test_matrix.py --repo-root "<framework-root>" --root "<mod-a>" --root "<mod-b>" --godot "<godot-exe>" --require-runtime

O relatório mantém um resultado por raiz e adiciona composed_set para o conjunto completo. Este bloco é onde são demonstrados conflitos de pacotes, IDs duplicados e erros de dependência. Um pacote limpo por si só não é prova de que o conjunto será carregado junto. O relatório também inclui surface_contract, a versão atual do contrato familiar, e o resumo de auditoria, portanto, uma matriz não pode ser verde enquanto o instantâneo de compatibilidade do repositório estiver desatualizado. Com --require-runtime, leia runtime.reachability.loaded_families e runtime.reachability.reachable_families. A primeira diz que os registros compostos foram carregados; o segundo só é preenchido quando um caminho real direcionado aos jogadores da sonda Godot os consumiu. runtime.reachability.observations mantém o pacote, família, ID do registro, caminho e status para cada linha, enquanto unreachable lista as linhas carregadas que ainda não possuem nenhum caminho. Uma família pode ser validada e encenada, mas ainda assim estar ausente de reachable_families: "carregado" não é o mesmo que "um jogador pode alcançá-lo".

Cada comando acima é verificado nas próprias ferramentas à medida que esta página é construída: o script deve existir e cada opção deve ser aceitável.

Cada código de diagnóstico

Não leia esta lista em ordem. Está aqui para que um código que você encontra em um relatório seja uma pergunta com uma resposta – uma pequena palavra em letras minúsculas como asset_missing. Cole um na caixa de pesquisa no topo desta página.

Alguns códigos pertencem a mecanismos que um pacote ainda não consegue alcançar. Estou aqui da mesma forma: um código que você não pode acionar custa uma linha que você nunca lerá, e um código que está faltando custa uma noite.