XCOM2 SDK Quickstart

XCOM 2: SDK – Guia prá tico
Conteúdo
Introdução..................................................................................................................................................... 1
Como começar .............................................................................................................................................. 2
Instale o SDK de XCOM 2 no Steam .......................................................................................................... 2
Instale o 2013 Visual Studio Isolated Shell Redistributable ...................................................................... 2
Execute o ModBuddy para XCOM 2.......................................................................................................... 2
Configuração inicial ................................................................................................................................... 3
Página inicial ............................................................................................................................................. 4
Novo projeto ............................................................................................................................................. 4
Estrutura de um mod .................................................................................................................................... 4
Componentes de um mod ........................................................................................................................ 4
Como construir ......................................................................................................................................... 5
Como testar............................................................................................................................................... 6
Como publicar ........................................................................................................................................... 7
Como publicar na Oficina Steam............................................................................................................... 7
Como publicar de maneira independente ................................................................................................ 8
Introdução
O SDK (Kit de Desenvolvimento de Software) de XCOM 2 para criar mods consiste em três componentes
principais:
1. ModBuddy, da Firaxis, com extensões de XCOM 2
2. Versão de 64 bits do UnrealEd para XCOM 2
a. Este executável também é capaz de rodar comandos da UE3, como o compilador de
script ou o cooker.
3. Conteúdo incluso em XCOM 2
a. Pacotes e mapas uncooked
b. Código fonte do Unreal script
O objetivo deste guia prático é demonstrar como fazer o ModBuddy funcionar e como usá-lo para abrir
e publicar um mod de exemplo.
Como começar
O primeiro passo para criar um mod para XCOM 2 é executar o ModBuddy.
Instale o SDK de XCOM 2 no Steam
O SDK de XCOM 2 está disponível no Steam em Biblioteca -> Ferramentas.
Navegue até Ferramentas:
Encontre o SDK de XCOM 2 com o nome "XCOM 2 SDK" e selecione Instalar nas opções do menu de
clique com o botão direito.
Instale o 2013 Visual Studio Isolated Shell Redistributable
O ModBuddy para XCOM 2, similar a outras versões do ModBuddy lançadas para Civilization, usa o
Visual Studio Isolated Shell para proporcionar um IDE (Ambiente de Desenvolvimento Integrado) para a
criação de mods. Você pode encontrar o Redistributable instalado no diretório de instalação do jogo, na
pasta "Binaries\Redist". Exemplo: "\SteamLibrary\steamapps\common\XCOM 2 SDK\Binaries\Redist"
Execute o ModBuddy para XCOM 2
Selecione "Play Game" (Jogar) no SDK de XCOM 2 no Steam para executar o ModBuddy para XCOM 2. O
IDE poderá levar um tempo para carregar na primeira vez.
Configuração inicial
Após executar o ModBuddy pela primeira vez, o usuário deverá definir as configurações gerais no IDE de
acordo com o local de instalação do XCOM 2. Selecione Tools -> Options (Ferramentas -> Opções) e role
até o final do menu de opções conforme a imagem abaixo. Verifique se os caminhos estão corretamente
definidos.
XCOM 2 Install Path (Caminho de instalação de XCOM 2) – Este caminho deve se referir à instalação do
JOGO, terminando em XComGame.
XCOM 2 User Path (Caminho de usuário de XCOM 2) – Este caminho deve se referir à instalação do
SDK, terminando em XComGame.
Por padrão, a informação de construção do Visual Studio Isolated Shell é definida como "minimal"
(mínima). Para receber informações sobre o processo de construção/compilador de script, você deverá
alterar essa configuração. Selecione Tools -> Options -> Projects and Solutions -> Build and Run
(Ferramentas -> Opções -> Projetos e soluções -> Construção e execução). Altere a opção dos dois
menus expansíveis "verbosity" (verbosidade) para "Normal" e então selecione OK.
Página inicial
Quando o IDE for executado pela primeira vez, o usuário verá uma página
inicial com opções para criar novos projetos de mod, abrir um projeto de
mod existente e acessar a lista de projetos de mod abertos recentemente.
Neste guia prático, criaremos um novo projeto de mod, então selecione
"New Mod" (Novo mod).
Novo projeto
Após selecionar "New Mod", o usuário verá a janela à
direita. Por padrão, ela exibirá modelos instalados de
projetos de XCOM 2 que podem ser usados para criar
um novo projeto.
Neste guia, escolheremos o modelo de projeto
ExampleWeapon. Ele é um projeto de exemplo, e,
portanto, contém todos os arquivos de configuração,
código de script, arquivos de localização e pacotes de
conteúdo necessários para adicionar uma nova arma
ao jogo.
Selecione ExampleWeapon e então OK.
Estrutura de um mod
Agora que criamos um projeto de mod, podemos revisar o que compõe um mod, assim como construir,
testar e publicar nosso mod.
Componentes de um mod
Os mods para XCOM 2 são compostos de vários tipos diferentes de dados combinados para realizar
alterações na versão base do jogo.
Código de script: código de script é o tipo mais poderoso de conteúdo de mod. No nosso mod de arma
de exemplo, o código de script define um modelo de dados,
que são os dados de jogabilidade descrevendo como a nova
arma funciona. Quanto dano ela causa? Que melhorias ela
aceita? Que nível técnico ela requer? Ela precisa ser construída ou está disponível desde o início?
Quanto ela custa? Modelos de dados apenas arranham a superfície do que pode ser adicionado usando
script. O código de script, se usado para sobrescrever o script base do jogo, pode ser utilizado para fazer
um jogo XCOM totalmente diferente.
Pacotes de conteúdo Unreal: pacotes de conteúdo Unreal podem ser arquivos UPK ou MAP. Esses
arquivos contêm o conteúdo do jogo: malhas, texturas,
animações, sons, modelos de física, arquétipos, etc. No
nosso mod de exemplo, há um pacote único chamado WP_ModExampleWeapon_CV, que define como
nossa nova arma soará, disparará, como será sua aparência, que projéteis ela usará, como ela cairá
quando for descartada, etc. Esse pacote é referenciado pelo modelo de dados de script acima. Pacotes
de conteúdo são criados por meio do UnrealEd, que explicaremos posteriormente.
Arquivos config: arquivos config, ou INIs, são usados para fornecer configurações e valores padrão ao
jogo. Seu uso é conveniente por não ser necessário
recompilar o jogo para alterá-los e porque o sistema de
processamento de arquivos config da UE3 permite que configurações config individuais sejam
sobrescritas sem alterar o restante. Esse útil comportamento pode ser observado no nosso mod de
arma de exemplo, no qual XComEditor e XComEngine, dois arquivos config com grande quantidade de
configurações, simplesmente adicionam nosso pacote de mod às listas que informam a engine da
existência do nosso pacote de script modificado. Dessa forma, a coexistência de vários mods editando os
mesmos arquivos config se torna possível... de maneira geral.
Arquivos de localização: arquivos loc são apenas arquivos config disfarçados, mas possuem um
propósito especializado: proporcionar todo o texto
disponível ao jogador no jogo. No nosso mod de arma de
exemplo, linhas do idioma inglês (INT) são proporcionadas para preencher o apelido e outros campos
necessários para a arma ser corretamente exibida no jogo.
Readme.txt e ModPreview.jpg: a imagem ModPreview será usada para representar o mod na Oficina
Steam, e o Readme.txt pode conter instruções ou outras informações relacionadas ao mod.
Como construir
Após o conteúdo do mod ter sido criado e estar pronto para ser
testado, será a hora de construir o mod de forma que o jogo possa
carregá-lo. Para isso, use a opção Build -> Build Solution (Construção ->
Solução de construção) na barra de ferramentas.
Janela Output: após selecionar
Build Solution, o IDE exibirá o
progresso da construção na
janela Output do aplicativo.
Durante o processo de
construção, o ModBuddy criará
os arquivos necessários para
testar e publicar o mod. Parte
desse processo é a compilação do
código de script. Certifique-se de
checar os resultados da
compilação do script por códigos de sucesso ou erro.
Como testar
Ao desenvolver um mod, recomenda-se testá-lo localmente antes de disponibilizá-lo na Oficina Steam.
O SDK de XCOM 2 fornece um mecanismo para fazer isso através do menu DEBUG.
Selecione a opção Start Debugging (Iniciar debugging) no menu DEBUG
para iniciar o processo de testes. Isso construirá o mod e então executará
o launcher de XCOM 2.
Selecione o mod "ExampleWeapon" e então Play
(Jogar). O launcher enumerará todos os mods subscritos
ou instalados pelo usuário. Mods locais ou
independentes terão seu caminho relativo no campo de
descrição. Selecionar Play executará XCOM 2 com o mod
ExampleWeapon habilitado.
Verifique se o mod está operando corretamente no jogo. O mod ExampleWeapon adiciona uma nova
arma disponibilizada desde o início do jogo. Então, para testá-lo, iniciaremos uma campanha para um
jogador e equiparemos um soldado com a nova arma.
Aqui está o código de script do modelo que define as propriedades que queremos ver na arma:
E aqui o mod rodando em XCOM 2:
Agora que confirmamos que o mod opera conforme desejado, já podemos publicá-lo.
Como publicar
Os mods podem ser publicados por meio da Oficina Steam ou distribuídos como pacotes independentes.
Como publicar na Oficina Steam
Para publicar na Oficina Steam, primeiro acesse a página
dela e verifique se sua conta aceitou o Acordo de Assinatura
do Steam. Isso pode ser encontrado em Comunidade ->
Oficina -> Seus arquivos -> Ver Acordo Legal.
A seguir, selecione a opção Tools -> Publish (Ferramentas -> Publicar)
disponível no IDE de XCOM 2. Isso iniciará o processo de envio de UGC
(Conteúdo Gerado por Usuários) na Oficina Steam.
Informações relacionadas à criação de
itens na Oficina e ao processo de envio
serão exibidas na janela Output do IDE.
Acesse a página dos seus itens da Oficina
Steam para visualizar o mod publicado.
Tenha em mente que, quando um mod é
enviado pela primeira vez, sua visibilidade
é definida como Oculto. Para
disponibilizar o mod publicamente, sua
visibilidade deverá ser alterada.
Como publicar de maneira independente
Publicar mods independentes envolve criar um pacote com o conteúdo do mod para distribuir através
de outra fonte que não o Steam.
Para publicar um mod independente, localize o diretório base do SDK de XCOM 2 e
a pasta XComGame\Mods dentro dele. Ele geralmente estará em uma pasta de
biblioteca ou de instalação do Steam – como neste exemplo à direita.
Crie um zip/pacote com a pasta ExampleWeapon para redistribuição.
Para instalar o mod na máquina de um usuário, basta descompactar a pasta
ExampleWeapon no mesmo local de XComGame\Mods no seu diretório de
instalação de XCOM 2.