Modding:Упаковка мода

Эта страница проверялась в последний раз для версии Vintage Story 1.15.

Если ваш мод изменяет только визуальные эффекты, звуки и другие «тематические» активы, см. также страницу пакета тем.

Zip-файлы

Чтобы мод было легко установить и использовать, его следует запаковать в zip-файл. Любые активы (изображения, файлы .json и т. д.) помещаются в каталог «assets» в корне zip-файла, любые исходные файлы в папку «src», а любые библиотеки DLL (и, возможно, файлы PDB) помещаются непосредственно в zip-файл. Корневая папка.

Обратите внимание, что если у вас есть мод с кодом, который не имеет ресурсов (т. е. ваш мод представляет собой единственную DLL C#), можно отправить чистую DLL, не упаковывая ее в zip-архив. Однако это не очень хорошая идея, так как при таком распространении трудно включить файл PDB, а загрузка DLL непосредственно в Windows может привести к проблемам с загрузкой вашего мода из-за политик безопасности, применяемых к файлам, загруженным из Интернета.

Zip File Structure
.zip
assets
domain
asset files (tree overview)
modinfo.json
modicon.png
compiled sources files (*.dll and *.pdb)
src
source code files - folders allowed (*.cs)

Информационный файл

Для каждого мода в zip-файле требуется modinfo.json внутри корневого каталога архива. В противном случае весь мод будет проигнорирован. В этом информационном файле указывается, что это за мод, его название, автор и т. д.

Пример информационного файла пакета тем (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",

Помимо"type": "content", существует также "type": "theme" и "type": "code".

• "type": "content": определяет этот мод как Content Mod. Модификации контента не могут содержать код C# (если это так, они будут проигнорированы).
• "type": "theme": определяет этот мод как Theme Pack. Тематические пакеты не могут переопределить игровой процесс, влияющий на категории активов (такие как типы блоков, типы предметов и т. д.), и код C# не будет загружен.
• "type": "code": Определяет этот мод как Code Mod. Модификации кода аналогичны модификациям содержимого, за исключением того, что они также могут загружать код C#, чтобы делать то, что невозможно с помощью JSON.

  "dependencies": {
    "game": "1.5.3"
  },

Означает, что для этого требуется как минимум VintageStory v1.5.3 или более новая версия. Для получения дополнительной информации см. модинфо.

Значок

Примечание: Иконки модов поддерживаются, начиная с версии 1.16.

Файл modicon.png (если он существует) будет использоваться и отображаться в меню менеджера модов.

Распространение и установка

Чтобы установить мод, просто поместите zip-файл в каталог Mods в вашем каталоге Vintage.

Вы можете загрузить свой мод в Базу модов Vintage Story, чтобы люди могли его найти.

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.