Modding:Mod Packaging/ru: Difference between revisions

From Vintage Story Wiki
(Created page with "Моддинг: Упаковка мода")
 
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>{{GameVersion|1.15}}
<languages/>{{GameVersion|1.15}}


If your mod changes only visuals, sounds, and other "theming" assets, refer also to the [[Modding:Theme_Pack|Theme Pack]] page.
Если ваш мод изменяет только визуальные эффекты, звуки и другие «тематические» активы, см. также страницу [[Modding:Theme_Pack/ru|пакета тем]].


== Zip Files ==
== Zip-файлы ==


To make your mod easy to install and use, it should be packed into a [https://en.wikipedia.org/wiki/Zip_(file_format) zip file]. Any assets (images, .json files, etc) go in a "assets" directory in the root of the zip, any source files into the "src" folder and any DLLs (and optionally, PDB files) go directly into the zip file root folder.
Чтобы мод было легко установить и использовать, его следует запаковать в [https://en.wikipedia.org/wiki/Zip_(file_format) zip-файл]. Любые активы (изображения, файлы .json и т. д.) помещаются в каталог «assets» в корне zip-файла, любые исходные файлы в папку «src», а любые библиотеки DLL (и, возможно, файлы PDB) помещаются непосредственно в zip-файл. Корневая папка.


Please note that if you have a code mod that has no assets (AKA, your mod is a single C# DLL), it is possible to ship the bare DLL without packing it into a zip. This is not really a good idea though, as when distributed this way it is hard to include a PDB file and downloading DLLs directly in Windows can lead to issues with your mod failing to load due to security policies applied to files downloaded from the internet.
Обратите внимание, что если у вас есть мод с кодом, который не имеет ресурсов (т. е. ваш мод представляет собой единственную DLL C#), можно отправить чистую DLL, не упаковывая ее в zip-архив. Однако это не очень хорошая идея, так как при таком распространении трудно включить файл PDB, а загрузка DLL непосредственно в Windows может привести к проблемам с загрузкой вашего мода из-за политик безопасности, применяемых к файлам, загруженным из Интернета.


<table id="treeviewtable" class="table table-bordered tt-table" style='table-layout: fixed'>
<table id="treeviewtable" class="table table-bordered tt-table" style='table-layout: fixed'>
Line 42: Line 42:
</table>
</table>


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


Every zip-file mod requires a <code>modinfo.json</code> inside the root directory of the archive. Otherwise the entire mod will be ignored. This info file specifies what kind of mod it is, its name, author, etc.
Для каждого мода в zip-файле требуется <code>modinfo.json</code> внутри корневого каталога архива. В противном случае весь мод будет проигнорирован. В этом информационном файле указывается, что это за мод, его название, автор и т. д.


An example of a theme pack info file (<code>modinfo.json</code>):
Пример информационного файла пакета тем (<code>modinfo.json</code>):
<syntaxhighlight lang=json>
<syntaxhighlight lang=json>
{
{
Line 69: Line 69:
</syntaxhighlight>
</syntaxhighlight>


Besides <code>"type": "content"</code>, there is also <code>"type": "theme"</code> and <code>"type": "code"</code>.
Помимо<code>"type": "content"</code>, существует также <code>"type": "theme"</code> и <code>"type": "code"</code>.


* <code>"type": "content"</code>: Defines this mod as being a '''Content Mod'''. Content Mods cannot contain any C# code (if it does they will be ignored).
* <code>"type": "content"</code>: определяет этот мод как '''Content Mod'''. Модификации контента не могут содержать код C# (если это так, они будут проигнорированы).
* <code>"type": "theme"</code>: Defines this mod as being a '''Theme Pack'''. Theme Packs cannot override gameplay affecting assets categories (such as blocktypes, itemtypes and so on) and no C# code will be loaded.
* <code>"type": "theme"</code>: определяет этот мод как '''Theme Pack'''. Тематические пакеты не могут переопределить игровой процесс, влияющий на категории активов (такие как типы блоков, типы предметов и т. д.), и код C# не будет загружен.
* <code>"type": "code"</code>: Defines this mod as being a '''Code Mod'''. Code Mods are the same as a Content Mods, except they can also load C# code to do things that are not possible with JSON.
* <code>"type": "code"</code>: Определяет этот мод как '''Code Mod'''. Модификации кода аналогичны модификациям содержимого, за исключением того, что они также могут загружать код C#, чтобы делать то, что невозможно с помощью JSON.


<syntaxhighlight lang=json>
<syntaxhighlight lang=json>
Line 81: Line 81:
</syntaxhighlight>
</syntaxhighlight>


Means it requires at least VintageStory v1.5.3 or a newer version. For more info see [[Modinfo]].
Означает, что для этого требуется как минимум VintageStory v1.5.3 или более новая версия. Для получения дополнительной информации см. [[Modinfo/ru|модинфо]].


== Icon ==
== Значок ==


  '''Note:''' Mod icons supported starting from 1.16.
  '''Примечание:''' Иконки модов поддерживаются, начиная с версии 1.16.
The file <code>modicon.png</code> (if it exists) will be used and shown in the mod manager menu.
Файл <code>modicon.png</code> (если он существует) будет использоваться и отображаться в меню менеджера модов.


[[File:Example Mod.png]]
[[File:Example Mod.png]]


== Distribution and Installation ==
== Распространение и установка ==


To install a mod simply place the zip file in the <code>Mods</code> directory in your [[Vintagestory folder|Vintagestory directory]].
Чтобы установить мод, просто поместите zip-файл в каталог <code>Mods</code> в вашем [[Vintagestory folder/ru|каталоге Vintage]].


You can upload your mod to the [https://mods.vintagestory.at/ Vintage Story Mod Database] so people can find it.
Вы можете загрузить свой мод в [https://mods.vintagestory.at/ Базу модов Vintage Story], чтобы люди могли его найти.




{{Navbox/modding|Vintage Story}}
{{Navbox/modding/ru|Vintage Story}}

Latest revision as of 12:04, 21 February 2022

Other languages:

Эта страница проверялась в последний раз для версии 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 (если он существует) будет использоваться и отображаться в меню менеджера модов.

Example Mod.png

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

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

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


Icon Sign.png

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.

Modding
Modding Introduction Getting Started • Пакет тем
Content Modding Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts
Code Modding Code Mods • Setting up your Development Environment
Property Overview Item • Entity • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • World properties
Workflows & Infrastructure Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine
Additional Resources Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters
Example Mods • API Docs • GitHub Repository


Retrieved from "https://wiki.vintagestory.at/index.php?title=Modding:Mod_Packaging/ru&oldid=35912"