Comando create

O comando create é usado para criar o conteúdo de origem de um pacote de adaptação por toque (ou, de forma abreviada, pacote não empacotado) ou para adicionar novos layouts a um pacote não empacotado existente. Este é um ponto de entrada rápido para começar a adicionar adaptação por toque a um jogo. A tabela a seguir mostra os diferentes subcomandos disponíveis para uso com o comando create. Observe que o comando create não pode ser usado sozinho, e um subcomando deve ser fornecido.

Subcomandos	Descrição
`bundle`	Cria um novo pacote de adaptação por toque não empacotado para desenvolvimento
`layout`	Cria um novo layout com base em um modelo em um pacote de adaptação por toque não empacotado existente

Criar pacote

O subcomando create bundle oferece a criação rápida de todo o conteúdo de origem necessário para um novo pacote de adaptação por toque. Ele é um ponto de partida para a adaptação por toque caso não exista um pacote não empacotado para um jogo. Ele cria todos os diretórios e arquivos necessários para começar a trabalhar com um novo pacote. Isso inclui o diretório raiz de layouts, que contém os arquivos de layout JSON para diferentes idiomas, o diretório raiz de ativos, que contém os ativos para vários DPIs por idioma, o arquivo raiz de configuração do pacote (takxconfig.json), que descreve o pacote, e um arquivo de contexto vazio para o estado dinâmico do layout e definições de layout reutilizáveis.

Opções

Use as opções da tabela a seguir para configurar a criação de um pacote de adaptação por toque não empacotado.

Opções	Descrição
`--destination` `--name`	OBRIGATÓRIO. Caminho de destino onde o pacote não empacotado será colocado. Pode ser um nome simples ou um caminho completo. [!NOTE] Se houver arquivos ou diretórios no destino, a opção `--overwrite-destination` deverá ser usada para excluí-los primeiro. [!NOTE] Se um nome simples for usado em vez de um caminho, o diretório de trabalho atual conterá o pacote criado.
`--layouts-directory-name` `--layouts-dir` `--layouts`	Nome do subdiretório para armazenar os layouts de controles por toque. Este é o diretório raiz de layouts. Padrão: `layouts`.
`--assets-directory-name` `--assets-dir` `--assets`	Nome do subdiretório para armazenar os ativos de controles por toque. Este é o diretório raiz de ativos. Padrão: `assets`.
`--layout-languages`	Lista de marcas de idioma IETF a serem usadas para a criação de diretórios de idioma no diretório raiz de layouts. `neutral` sempre será criado. Padrão: lista vazia.
`--asset-languages`	Lista de marcas de idioma IETF a serem usadas para a criação de diretórios de idioma no diretório raiz de ativos. `neutral` sempre será criado. Padrão: lista vazia.
`--version`	Versão do conteúdo do pacote. Padrão: `1.0.0.0`.
`--version-name`	Nome da versão do conteúdo do pacote. Padrão: cadeia de caracteres vazia.
`--context-file-name` `--context-file` `--context`	Nome do arquivo de contexto do pacote. Padrão: `context.json`.
`--templates`	Lista de um ou mais modelos de layout a serem adicionados ao pacote na criação. Os modelos são sempre adicionados ao diretório de idioma de layout `neutral`, bem como a quaisquer diretórios de idioma correspondentes aos idiomas especificados em `--layout-languages`. Exibir a lista de modelos disponíveis. Padrão: `Blank`.
`--no-templates`	Não adiciona nenhum modelo ao pacote. Não pode ser usado se `--templates` for especificado. Padrão: `false`.
`--overwrite-destination` `--overwrite`	Exclui qualquer conteúdo anterior no destino. Isso é OBRIGATÓRIO se o destino não estiver vazio. Padrão: `false`.

Exemplos

Os exemplos a seguir demonstram como criar um novo pacote de adaptação por toque não empacotado.

Criar um novo pacote não empacotado simples com o modelo em branco padrão

D:\CreateBundleExamples> tak create bundle --name SampleBundle
Creating loose touch adaptation bundle 'SampleBundle'.
Creating bundle config file.
Creating layouts and assets directories.
Creating language directories.
Creating context file.
Added 1 templates to bundle.
Created loose touch adaptation bundle at 'D:\CreateBundleExamples\SampleBundle'.

Saída:

D:.
└───CreateBundleExamples
    └───SampleBundle
        │   context.json
        │   takxconfig.json
        │
        ├───assets
        │   └───neutral
        │       ├───@1.0x
        │       ├───@1.5x
        │       ├───@2.0x
        │       ├───@3.0x
        │       └───@4.0x
        └───layouts
            └───neutral
                    blank.json

Criar um novo pacote em uma unidade diferente, com alguns idiomas de layout, modelos e nomes de diretório personalizados

C:\> tak create bundle --destination D:\CreateBundleExamples\SomeFolder\AnotherFolder\SampleBundle --layout-languages fr fr-FR en-US --templates Menu Cinematic RacingBasic RacingAdvanced --layouts-dir touch-control-layouts --assets-dir touch-control-assets --context-file touch-control-context
Creating loose touch adaptation bundle 'SampleBundle'.
Creating bundle config file.
Creating layouts and assets directories.
Creating language directories.
Creating context file.
Added 4 templates to bundle.
Created loose touch adaptation bundle at 'D:\CreateBundleExamples\SomeFolder\AnotherFolder\SampleBundle'.

Saída:

D:.
└───CreateBundleExamples
    └───SomeFolder
        └───AnotherFolder
            └───SampleBundle
                │   takxconfig.json
                │   touch-control-context.json
                │
                ├───touch-control-assets
                │   └───neutral
                │       ├───@1.0x
                │       ├───@1.5x
                │       ├───@2.0x
                │       ├───@3.0x
                │       └───@4.0x
                └───touch-control-layouts
                    ├───en
                    │   └───en-US
                    │           cinematic.json
                    │           menu.json
                    │           racing-advanced.json
                    │           racing-basic.json
                    │
                    ├───fr
                    │   │   cinematic.json
                    │   │   menu.json
                    │   │   racing-advanced.json
                    │   │   racing-basic.json
                    │   │
                    │   └───fr-FR
                    │           cinematic.json
                    │           menu.json
                    │           racing-advanced.json
                    │           racing-basic.json
                    │
                    └───neutral
                            cinematic.json
                            menu.json
                            racing-advanced.json
                            racing-basic.json

No comando, especificar ‘fr’ e ‘fr-FR’ com a opção —layout-languages faz com que os modelos sejam adicionados a cada diretório correspondente. No entanto, como apenas ‘en-US’ foi especificado, os modelos são adicionados exclusivamente ao diretório ‘en-US’, e não ao diretório pai ‘en’. Os modelos são sempre adicionados ao diretório neutral, independentemente dessas especificações.

O arquivo de configuração do pacote (takxconfig.json) produzido refletirá uma configuração que representa os parâmetros passados para o comando create bundle.

{
  "$schema": "https://raw.githubusercontent.com/microsoft/xbox-game-streaming-tools/main/touch-adaptation-kit/schemas/takxconfig/v1/takxconfig.json",
  "layouts": {
    "path": "touch-control-layouts"
  },
  "assets": {
    "path": "touch-control-assets"
  },
  "context": {
    "path": "touch-control-context.json"
  },
  "version": "1.0.0.0",
  "versionName": "Initial"
}

Criar layout

O subcomando create layout permite adicionar um novo layout a um pacote não empacotado existente. A saída produzida por create bundle pode ser usada como entrada para create layout, fornecendo o arquivo takxconfig.json criado na raiz do pacote não empacotado como valor da opção --takx-config-file. Assim como em create bundle, um modelo pode ser usado para a criação de layout neste comando; caso contrário, o padrão é Blank. Também há suporte para adicionar layouts a vários diretórios de idioma de layout, e as mesmas regras sobre o arquivo não existir ou sobre a necessidade de --overwrite também se aplicam.

Opções

Use as opções da tabela a seguir para configurar a criação de um layout em um pacote de adaptação por toque não empacotado.

Opção	Descrição
`--takx-config-file` `--takxconfig`	OBRIGATÓRIO. Caminho para o arquivo de configuração do pacote. Deve se chamar `takxconfig.json`.
`--name`	Nome do layout. Este também será o nome do arquivo. É recomendável que os layouts sejam nomeados da forma que melhor se adapte ao jogo. Padrão: nome do modelo usado (por exemplo, `shooter-basic.json`).
`--languages`	Lista de marcas de idioma IETF para as quais o layout deve ser adicionado. O layout sempre será adicionado ao diretório de idioma de layout `neutral`, independentemente do valor passado aqui. Se uma marca de idioma for especificada aqui e nenhum diretório correspondente for encontrado no diretório raiz de layouts, o(s) diretório(s) será(ão) criado(s). Padrão: lista vazia.
`--all-languages` `--all`	Cria o layout em todos os subdiretórios de idioma encontrados no diretório raiz de layouts especificado no arquivo de configuração do pacote (`takxconfig.json`). Não pode ser definido como `true` quando `--languages` é especificado. Padrão: `false`
`--template`	Modelo a ser usado para o layout. Exibir a lista de modelos disponíveis. Padrão: `Blank`
`--overwrite`	Substitui quaisquer arquivos de layout existentes com o mesmo nome. Isso é OBRIGATÓRIO se algum subdiretório de idioma no diretório raiz de layouts contiver arquivos JSON com o mesmo nome. Por exemplo, se `--name` for `test`, `--languages` estiver definido como `en-US` e o diretório `en-US` não contiver um arquivo chamado `test.json` enquanto `neutral` contém, o comando não será executado sem que `--overwrite` seja especificado. Padrão: `false`
`--set-default` `--default`	Define o layout criado como o layout padrão no arquivo de configuração do pacote (`takxconfig.json`). Padrão: `false`

Exemplos

Os exemplos a seguir demonstram como criar um novo layout em um pacote de adaptação por toque não empacotado existente.

Criar um novo layout simples usando o modelo Blank padrão.

D:\CreateLayoutExamples\SampleBundle> tak create layout --name sample-layout --takxconfig .\takxconfig.json
Verifying bundle configuration file (takxconfig.json).
Verification complete. 0 error(s), 0 warning(s) and 0 note(s) found.
Created layout 'sample-layout' using template 'Blank' in 1 directories.

Saída:

D:.
└───CreateLayoutExample
    └───SampleBundle
        │   context.json
        │   takxconfig.json
        │
        └───layouts
            └───neutral
                    sample-layout.json

Criar um novo layout usando um modelo específico para vários idiomas no pacote.

D:\CreateLayoutExamples> tak create layout --takxconfig .\SampleBundle\takxconfig.json --template ShooterBasic --languages ja-JP en en-US
Verifying bundle configuration file (takxconfig.json).
Verification complete. 0 error(s), 0 warning(s) and 0 note(s) found.
WARNING: A language directory for 'ja-JP' does not exist under the root layouts directory. It will be created, as well as any relevant parenting directories if applicable to the language.
WARNING: A language directory for 'en' does not exist under the root layouts directory. It will be created, as well as any relevant parenting directories if applicable to the language.
WARNING: A language directory for 'en-US' does not exist under the root layouts directory. It will be created, as well as any relevant parenting directories if applicable to the language.
Created layout 'shooter-basic' using template 'ShooterBasic' in 4 directories.

Saída:

D:.
└───CreateLayoutExample
    └───SampleBundle
        │   context.json
        │   takxconfig.json
        │
        └───layouts
            ├───en
            │   │   shooter-basic.json
            │   │
            │   └───en-US
            │           shooter-basic.json
            │
            ├───ja
            │   └───ja-JP
            │           shooter-basic.json
            │
            └───neutral
                    shooter-basic.json

O layout foi criado no diretório ‘en’, mas não no diretório ‘ja’, pois o primeiro foi o único especificado no parâmetro ‘—languages’.

Criar um novo layout para todos os idiomas

D:\CreateLayoutExamples> tak create layout --takxconfig .\SampleBundle\takxconfig.json --all-languages
Verifying bundle configuration file (takxconfig.json).
Verification complete. 0 error(s), 0 warning(s) and 0 note(s) found.
Created layout 'blank' using template 'Blank' in 5 directories.

Saída:

D:.
└───SampleBundle
    │   context.json
    │   takxconfig.json
    │
    └───layouts
        ├───en
        │   │   blank.json
        │   │   shooter-basic.json
        │   │
        │   └───en-US
        │           blank.json
        │           shooter-basic.json
        │
        ├───ja
        │   │   blank.json
        │   │
        │   └───ja-JP
        │           blank.json
        │           shooter-basic.json
        │
        └───neutral
                blank.json
                shooter-basic.json

Confira também

Ferramenta de linha de comando do Touch Adaptation Kit (tak.exe)

Porting

Build Paths

Criar pacote

Opções

Exemplos

Criar layout

Opções

Exemplos

Confira também

​Criar pacote

​Opções

​Exemplos

​Criar layout

​Opções

​Exemplos

​Confira também

Criar pacote

Opções

Exemplos

Criar layout

Opções

Exemplos

Confira também