Modificação: Embalagem Mod

From Vintage Story Wiki
This page is a translated version of the page Modding:Mod Packaging and the translation is 76% complete.

Esta página foi verificada pela última vez para a versão do Vintage Story 1.19.8.

Arquivos compactados

Para tornar seu mod fácil de instalar e usar, ele deve ser compactado em um arquivo zip. Quaisquer ativos (imagens, arquivos .json, etc.) vão para um diretório "assets" na raiz do zip, quaisquer arquivos de origem para a pasta "src" e quaisquer DLLs (e opcionalmente, arquivos PDB) vão diretamente para a pasta raiz do arquivo zip.

Observe que se você tiver um mod de código sem ativos (também conhecido como seu mod é uma única DLL C#), é possível enviar a DLL simples sem compactá-la em um zip. No entanto, isso não é realmente uma boa ideia, pois quando distribuído dessa forma é difícil incluir um arquivo PDB e baixar DLLs diretamente no Windows pode levar a problemas de falha no carregamento do seu mod devido a políticas de segurança aplicadas a arquivos baixados da Internet.

</tabela>

Arquivo de informações

Cada mod de arquivo zip requer um modinfo.json dentro do diretório raiz do arquivo. Caso contrário, todo o mod será ignorado. Este arquivo de informações especifica que tipo de mod é, seu nome, autor, etc.

Um exemplo de arquivo de informações de pacote de tema (modinfo.json):

{
  "type": "content",
  "modid": "creativemdexamplemod",
  "name": "My Example Content Mod",
  "description" : "This is an example mod, which does nothing",
  "authors": ["CreativeMD"],
  "version": "1.0",
  "dependencies": { 
	"game": "",
	"survival": ""
  },
  "website": "http://example.com"
}

  "type": "content",

Além de "type": "content", também existem "type": "theme" e "type": "code".

  • "type": "content": Define este mod como sendo um Mod de Conteúdo. Mods de conteúdo não podem conter nenhum código C# (se contiverem, serão ignorados).
  • "type": "theme": Define este mod como sendo um Pacote Temático. Os pacotes temáticos não podem substituir a jogabilidade que afeta categorias de ativos (como tipos de blocos, tipos de itens e assim por diante) e nenhum código C# será carregado.
  • "type": "code": Define este mod como sendo um Mod de Código. Code Mods são iguais aos Content Mods, exceto que também podem carregar código C# para fazer coisas que não são possíveis com JSON.
  "dependencies": {
    "game": "1.5.3"
  },

Significa que requer pelo menos VintageStory v1.5.3 ou uma versão mais recente. Para mais informações consulte Modinfo.

Ícone

O arquivo modicon.png (se existir) será usado e mostrado no menu do gerenciador de mod.

Distribuição e Instalação

Para instalar um mod de forma simples, você pode colocar o arquivo zip no diretório Mods em seu VintagestoryData folder ou na pasta Mods em sua pasta de instalação do Vintage Story.

Você pode enviar seu mod para o Vintage Story Mod Database para que as pessoas possam encontrá-lo.



Estrutura do arquivo zip
.zip
ativos
domínio
arquivos de ativos (visão geral da árvore)
modinfo.json
modicon.png
arquivos fontes compilados (*.dll e *.pdb)
src
arquivos de código-fonte - pastas permitidas (*.cs)
Modificação
"" Noções básicas Contente Código Tipos de ativos Criador de modelo Solução de problemas Motor VS
"" Noções básicas de conteúdo Tutoriais Conceitos e Guias Todas as páginas de conteúdo
"" Modificações de conteúdo Desenvolvendo um Mod de Conteúdo Embalagem e Liberação