Modding:Setting up your Development Environment/ru: Difference between revisions

From Vintage Story Wiki

Modding:Setting up your Development Environment/ru (view source)

Revision as of 10:32, 6 December 2023

8,044 bytes added ,  5 months ago
Created page with "Но это не обязательно при создании нового мода, так как команда <code>dotnet new vsmod</code> установить новую версию шаблона, если она доступна."
(Created page with "Но прежде чем вы сможете начать работать, вы должны сначала настроить ModTools.")
(Created page with "Но это не обязательно при создании нового мода, так как команда <code>dotnet new vsmod</code> установить новую версию шаблона, если она доступна.")
 
(75 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>{{GameVersion|1.15}}
<languages/>
 
{{GameVersion|1.18.8-rc.1}}
__FORCETOC__
__FORCETOC__
== Программное обеспечение ==
== Программное обеспечение ==


Когда вы будете готовы приступить к кодированию модов для Vintage Story, вы, вероятно, захотите настроить среду разработки, которая упростит процесс кодирования и тестирования ваших творений. Есть несколько приложений, которые помогут вам в разработке модов. Вот несколько предложений:
Когда вы будете готовы приступить к кодированию модов для Vintage Story, вы, вероятно, захотите настроить среду разработки, которая упростит процесс кодирования и тестирования ваших творений. Vintage Story разрабатывается на C# и начиная с версии 1.18.8 мы перешли на .NET 7.
 
Есть несколько приложений, которые помогут вам в разработке модов. Вот некоторые из них, поддерживающие наш шаблон:
 
* [https://www.visualstudio.com/ru/vs/community/ Visual Studio Community] — это бесплатная и очень мощная среда разработки от Microsoft и, возможно, имеет наилучшую поддержу С# и .NET, которые в свою очередь тоже разработаны Microsoft. Это также инструмент, который команда Vintage Story использует при билде игры. Она также имеет [https://www.visualstudio.com/vs/mac/ MacOS версию]. При использовании установите пакет <code>.NET desktop development</code>.
 
* [https://www.jetbrains.com/rider/ Jetbrains Rider] — это платная, мощная и удобная среда разработки специально спроектированная для .NET. Поскольку она создана для .NET, она также имеет очень хорошую поддержку всех функций, которые могут вам понадобиться, и при этом является полностью кроссплатформенной. Она также используется командой Vintage Story при разработке игры.
 
* [https://code.visualstudio.com/ Visual Studio Code] — это бесплатный, лёгкий и универсальный редактор кода, разработанный Microsoft. Он поддерживает множество языков программирования и предлагает широкий выбор функциональных расширений. Расширение для поддержки C# — отличный выбор для начала создания модов. Этот редактор широко используется нашим сообществом мододелов.
 
Хоть вы и можете использовать любой редактор для работы с исходном кодом, мы настоятельно рекомендуем использовать один из вышеперечисленных инструментов, чтобы ваши процессы стали гораздо удобнее.
 
Выберите одну из вышеперечисленных IDE или другие альтернативы. Мы предлагаем использовать '''Visual Studio Community''' для Windows. Для Linux вы можете использовать '''Visual Studio Code''' или '''Rider'''.
 
Примечание: Если вы используете Linux и собираетесь ставить Visual Studio Code или Rider из '''Flatpak''' или '''snap'''? имейте в виду, что могут возникнуть некоторые проблемы с использованием .NET или переменных среды. Так что, по возможности используйте нативные методы установки.
 
 
Далее вам нужно будет установить [https://dotnet.microsoft.com/en-us/download/dotnet/7.0 .NET 7 SDK] (Комплект для разработки программного обеспечения), который также будет включать .NET 7 Dekstop Runtime, необходимый для запуска игры начиная с версии 1.18.8-rc.1.
 
Убедитесь, что .NET 7 SDK установился правильно, выполнив следующую команду в терминале:
 
''В Windows откройте приложение Windows PowerShell, которое предустановлено во всех современных версиях Windows (10 / 11).''
 
<syntaxhighlight lang=shell>
dotnet --list-sdks
</syntaxhighlight>
 
Она выведет список установленных SDK, одна из которых, должна иметь <code>7.0.xxx</code>. Если это так, то можете продолжать.
 
<div lang="en" dir="ltr" class="mw-content-ltr">
== Setup the Environment ==
Our Mod template makes use of the environment variable <code>VINTAGE_STORY</code>. Which we will set up to contain the path of where your game is installed. The use of the environment helps to keep the setup and the template simple so we recommend using it and will cover it in this article.
</div>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
The <code>VINTAGE_STORY</code> Environment Variable simplifies reusing your Vintage Story game installation path and helps if multiple modders work on the same project to reference the <code>VINTAGE_STORY</code> Environment Variable and have their game installed where ever they want.
</div>
 
=== Windows ===
 
<div lang="en" dir="ltr" class="mw-content-ltr">
Here you have two options to set the environment variable:
* Use this short PowerShell script. Open the ''Windows PowerShell'' Application and paste the following into it and hit ''ENTER''
<syntaxhighlight lang=shell>
[Environment]::SetEnvironmentVariable("VINTAGE_STORY", "$Env:AppData\Vintagestory", "User")
</syntaxhighlight>
</div>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
Change <code>$Env:AppData\Vintagestory</code> if you used a custom installation path for your game.
</div>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
* Follow these manual steps to set the Environment variable
Search in Windows search for <code>Edit the system environment variables</code> > <code>Environment Variables...</code> > User variables for USER > New > Add insert the Variable name: <code>VINTAGE_STORY</code> and add the path to your Vintage Story installation.
[[File:Win env.png|400px|center|frameless|alt=Setup Windows environment variable]]
</div>


* [https://www.visualstudio.com/en/vs/community/ Visual Studio Community] это бесплатная и очень мощная среда разработки, описанная в руководстве ниже. Это также инструмент, который команда Vintage Story использует для создания игры. Он также имеет [https://www.visualstudio.com/vs/mac/ MacOS версию].
<div lang="en" dir="ltr" class="mw-content-ltr">
For example, the default installation directory would be <code>C:\Users\<Username>\AppData\Roaming\Vintagestory</code>, (replace <Username> with your username) if you are not sure where yours is type <code>%appdata%</code> into the URL field in the File Explorer and hit ENTER. It will take you to your AppData\Roaming folder where Vintage Story should be installed if you haven't changed the default installation location.
</div>


* [https://www.jetbrains.com/rider/ Jetbrains Rider] — это бесплатная и современная среда разработки с бесшовной поддержкой проектов, сочетаний клавиш и макетов Visual Studio. Это корпоративный продукт, и некоторые функции заблокированы лицензией (проверка дублирования кода, инструменты веб-разработчика), но все функции, необходимые для разработки модов VS, бесплатны. Функции индексации/перехода к ссылкам и встроенные функции декомпиляции очень эффективны, так как вы можете нажать на метод, который использует Vintage Story, и он покажет вам код, стоящий за ним. Обратите внимание, что в настоящее время в нем есть одна ошибка + задокументировано обходное решение. [https://github.com/anegostudios/vsmodexamples/issues/11 тут].
<div lang="en" dir="ltr" class="mw-content-ltr">
[[File:Win appdata.png|400px|frameless|center|alt=find the default installation path of vintage story]]
Note:
Do not confuse the <code>AppData\Roaming\VintagestoryData</code> directory with the <code>AppData\Roaming\Vintagestory</code> folder. The <code>VintagestoryData</code> directory only holds your Settings, Logs, Savegames and Mods.
</div>


* [https://code.visualstudio.com/ Visual Studio Code] очень облегченная версия Visual Studio. Наш драгоценный член сообщества [https://twitter.com/koppeh?lang=en copygirl] использует этот инструмент, а также [https://github.com/copygirl/howto-example-mod написал инструкцию по настройке github]
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Linux and Mac ===
To set an environment variable in Linux/Mac you need to add the following to your shells startup file:
</div>


* [https://www.monodevelop.com/ MonoDevelop] — еще одна IDE, более легкая, чем Visual Studio Community.
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang=shell>
export VINTAGE_STORY="$HOME/ApplicationData/vintagestory"
</syntaxhighlight>
Replace the path with the one where your Vintagestory installation is located. The above path should point to your install when you installed Vintagestory using the install.sh script.
</div>


* [https://notepad-plus-plus.org/ Notepad++] ваш самый простой инструмент для редактирования текста с некоторыми дополнительными функциями. На самом деле, вы можете кодировать моды в любом текстовом редакторе. Однако при программировании отсутствует мгновенная контекстно-зависимая обратная связь, что очень полезно. Если вы выберете этот путь, вы сможете использовать саму игру для проб и ошибок, перезагрузив их во время игры.
<div lang="en" dir="ltr" class="mw-content-ltr">
Run <code>echo $SHELL</code> in a terminal to see what shell you are using.
</div>


== Установить средство разработки ==
<div lang="en" dir="ltr" class="mw-content-ltr">
* For Bash place it in: <code>~/.bashrc</code> or <code>~/.bash_profile</code> at the end
* For Zsh place it in: <code>~/.zshrc</code> or <code>~/.zprofile</code> at the end
* If you use another shell see their documentation on how their shell startup file is called
Note: If you are using <code>~/.bash_profile</code> or <code>~/.zprofile</code> you will have to Logout and Login again to apply the changes. When using <code>~/.bashrc</code> or <code>~/.zshrc</code> you only need to restart the application that needs to use the environment variable (Visual Studio, Rider, Visual Studio Code, Terminal).
</div>


VintageStory разработан на C#. Выберите одну из вышеперечисленных IDE или другие альтернативы. Мы предлагаем использовать '''Visual Studio Community''' для Windows. Для Linux вы можете использовать '''Visual Studio Code''', '''Rider''' или '''MonoDevelop'''.


После загрузки IDE вы можете получить проект [https://github.com/anegostudios/vsmodtemplate мода] или вручную настроить проект мода. Шаблон мода предлагает удобный инструмент для настройки нескольких проектов модов, а также для быстрой упаковки и получения готового к отправке мода.
== Создание мода ==


=== Руководство по установке в Windows/macOS с Visual Studio ===
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Mod Template package ===
</div>


{| class="wikitable"
<div lang="en" dir="ltr" class="mw-content-ltr">
|-
The first and recommended option would be to use the ''template package''.
! scope="col"| OS
</div>
! scope="col"| Repo
! scope="col"| Command
|-
| Windows
| [https://visualstudio.microsoft.com/downloads/ скачать exe]
| Запустить загруженный файл
|-
| macOS
| [https://visualstudio.microsoft.com/downloads/ скачать dmg]
| Запустить загруженный файл
|}


=== Руководство по установке на Linux/macOS с MonoDevelop ===
<div lang="en" dir="ltr" class="mw-content-ltr">
Install the mod [https://github.com/anegostudios/VSdotnetModTemplates Mod template package] using the following command on the Terminal:
</div>


Вы можете использовать MonoDevelop IDE для создания модов VS в Linux. Инструкции по загрузке приведены ниже, выберите свою ОС и перейдите по ссылке, чтобы добавить репозиторий, затем запустите команду установки.
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang=shell>
dotnet new install VintageStory.Mod.Templates
</syntaxhighlight>
</div>


{| class="wikitable"
<div lang="en" dir="ltr" class="mw-content-ltr">
|-
This will download the latest mod template package from [https://www.nuget.org/packages/VintageStory.Mod.Templates nuget.org]
! scope="col"| OS
</div>
! scope="col"| Repo
! scope="col"| Command
|-
| Debian 8-10
| [https://www.monodevelop.com/download/#fndtn-download-lin-debian repo]
| <code>sudo apt-get install monodevelop</code>
|-
| Ubuntu 14.04-20.04
| [https://www.monodevelop.com/download/#fndtn-download-lin-ubuntu repo]
| <code>sudo apt-get install monodevelop</code>
|-
| CentOS / RedHat
| [https://www.monodevelop.com/download/#fndtn-download-lin-centos repo]
| <code>yum install monodevelop</code>
|-
| Используя Flatpak
| [http://flatpak.org/getting.html Скачать Flatpak]
| <code>flatpak install --user --from https://download.mono-project.com/repo/monodevelop.flatpakref</code>
|-
| macOS
| [https://www.monodevelop.com/developers/building-monodevelop/ руководство по сборке]
| Используйте Visual Studio или соберите из исходного кода
|-
| Другие
| [https://github.com/mono/monodevelop Компиляции из исходников]
| Следуйте инструкциям для компиляции из исходников
|}


=== Руководство по установке на Linux / macOS с Visual Studio Code ===
<div lang="en" dir="ltr" class="mw-content-ltr">
Once the template is installed you will see it inside Visual Studio and Rider. From there you can use the templates to create a new Project.
</div>


Вы можете использовать Visual Studio Code для создания модов VS в Linux. Инструкции по загрузке приведены ниже, выберите свою ОС и перейдите по ссылке, чтобы загрузить ее.


{| class="wikitable"
==== Visual Studio ====
|-
! scope="col"| OS
! scope="col"| Download
! scope="col"| Command
|-
| Debian 8-10
| [https://code.visualstudio.com/download скачать deb]
| <code>sudo dpkg -i /path/to/vscode/file.deb && sudo apt-get install -f</code>
|-
| Ubuntu 18.04-20.04
| [https://code.visualstudio.com/download скачать deb]
| <code>sudo apt install /path/to/vscode/file.deb</code>
|-
| CentOS / RedHat / Fedora / SUSE
| [https://code.visualstudio.com/download скачать rpm]
| <code>rpm -ih /path/to/vscode/file.rpm</code>
|-
| Arch
| [https://aur.archlinux.org/packages/visual-studio-code-bin пакет]
| <code>yay -S visual-studio-code-bin</code>
|-
| Использовать Snap
| [https://snapcraft.io/docs/installing-snapd скачать <code>snapd</code>]
| <code>sudo snap install code --classic</code>
|-
| macOS
| [https://code.visualstudio.com/download скачать zip]
| Запустить загруженный файл
|-
| Другие
| [https://github.com/microsoft/vscode компилирование из исходников]
| Следуйте инструкциям для компиляции из исходников
|}


=== Руководство по установке на Windows / Linux / macOS с JetBrains Rider ===
<div lang="en" dir="ltr" class="mw-content-ltr">
We advise you to check the option  <code>Place solution and project in the same directory</code> for Visual Studio
This will flatten the project tree by one folder and make it easier to navigate.
</div>


Вы можете использовать Jetbrains Rider для создания модов VS в Linux. Инструкции по загрузке приведены ниже, выберите свою ОС и перейдите по ссылке, чтобы загрузить ее.
<div lang="en" dir="ltr" class="mw-content-ltr">
If you don't want the log output to show up in a separate window you can check the option <code>SuppressWindowsConsoleWindow</code>. When enabled the log output will still be shown inside the Visual Studio Debug Output.
</div>


{| class="wikitable"
<div lang="en" dir="ltr" class="mw-content-ltr">
|-
Open Visual Studio and click on ''Create a new project''. If you installed the ''VintageStory.Mod.Templates'' you can then select '''Vintage Story Mod'''.
! scope="col"| OS
<gallery mode="packed-hover" widths=400px heights=300px>
! scope="col"| Download
File:Vs-cp-template.png|Visual Studio Mod Template
! scope="col"| Command
File:Vs-cp-template-setup.png|Visual Studio Mod Template setup
|-
File:Vs-cp-template-options.png|Visual Studio Mod Template options
| Windows
</gallery>
| [https://www.jetbrains.com/rider/download/#section=windows скачать exe]
</div>
| Запустить загруженный файл
|-
| Arch
| [https://aur.archlinux.org/packages/rider Пакет]
| <code>yay -S rider mono mono-msbuild</code>
|-
| Используя Toolbox
| [https://www.jetbrains.com/help/idea/installation-guide.html#toolbox СкачатьToolbox]
| Следуйте приведенным инструкциям для вашей ОС
|-
| Используя Snap
| [https://snapcraft.io/docs/installing-snapd Скачать <code>snapd</code>]
| <code>sudo snap install rider --classic</code>
|-
| macOS
| [https://www.jetbrains.com/rider/download/#section=mac Скачать dmg]
| Запустить загруженный файл
|-
| Другие
| [https://www.jetbrains.com/rider/download/#section=linux Скачать <code>.tar.gz</code>]
| <code>sudo tar -xzf ideaIU.tar.gz -C /opt && cd /opt/idea-dir-edit-me && sudo ./idea.sh</code>
|}


== Шаблоны модов ==
==== Rider ====


* [https://github.com/anegostudios/vsmodtemplate/releases/latest '''Официальный шаблон мода для Visual Studio'''] который рассматривается в этой статье.
<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://github.com/copygirl/howto-example-mod установка copygirl's VSCode]
We advise you to check the option <code>Put solution and project in the same directory</code> for Rider.
This will flatten the project tree by one folder and make it easier to navigate.
</div>


== Настройка с использованием официального шаблона мода ==
<div lang="en" dir="ltr" class="mw-content-ltr">
Open Rider and click on ''New Solution''. If you installed the ''VintageStory.Mod.Templates'' you can then select '''Vintage Story Mod'''.
</div>


Для начала загрузите решение VSModTemplate с [https://github.com/anegostudios/vsmodtemplate/releases/latest GitHub]. Теперь вам просто нужно распаковать zip-архив в нужное место.
<div lang="en" dir="ltr" class="mw-content-ltr">
[[File:Rider-cp-template.png|400px|frameless|center|alt=Rider Mod Template|Rider Mod Template]]
</div>


[[File:VSMods9.png]]


Перейдите к <code>vsmodtemplate-x.y.z</code> и дважды щелкните <code>VSMods.sln</code> (работает, только если установлена Visual Studio). В качестве альтернативы вы также можете запустить Visual Studio, нажав <code>File -> Open -> Project/Solution...</code>, перейти к извлеченной папке и выбрать <code>VSMods.sln</code>.
<div lang="en" dir="ltr" class="mw-content-ltr">
Note: Unfortunately as of writing this Rider does not support those template options as Visual Studio in the UI yet but you can check this [https://youtrack.jetbrains.com/issue/RIDER-16759/Support-parameters-in-custom-project-templates issue] for updates.
For now you can make use of those options using the CLI see the  [[#Visual Studio Code|Visual Studio Code]] section for how to use it.
</div>


Но прежде чем вы сможете начать работать, вы должны сначала настроить ModTools.
==== Visual Studio Code ====


=== Run ModTools ===
<div lang="en" dir="ltr" class="mw-content-ltr">
To create a new Mod using the template when using Visual Studio Code you have to resort to using the command line for now since there is no UI that supports the options as well.
Open a folder in Visual Studio Code where you want your mod to be. Then open the terminal within Visual Studio code ''Terminal'' > ''New Terminal''.
</div>


The ModTools allow you to do various tasks rather easily by typing in a command. Each platform requires a different way to start it.
<div lang="en" dir="ltr" class="mw-content-ltr">
Please note, the mod tools have only been tested with Visual Studio and MonoDevelop, but they are not required to mod the game, it merely simplifies some of the tasks.
* Create a new Mod Project with launch.json and task.json to easily start it and a Solution file. ''Other IDE's create that automatically so that is why we have this additional <code>--AddSolutionFile</code> flag for VS Code.''
<syntaxhighlight lang=shell>
dotnet new vsmod --IncludeVSCode --AddSolutionFile
</syntaxhighlight>
</div>


==== Windows ====
<div lang="en" dir="ltr" class="mw-content-ltr">
For all possible options run the following in the terminal:
<syntaxhighlight lang=shell>
dotnet new vsmod --help
</syntaxhighlight>
</div>


Double-click <code>vsmodtools.exe</code>.
<div lang="en" dir="ltr" class="mw-content-ltr">
Once you opened or created a template Visual Studio will prompt you to install the recommended extension, click on ''Show Recommendations'' and install the the pre-release version of the [https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit C# Dev Kit] extension. This will also install the required [https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp C#] automatically for you.
These two extensions are recommended and will add Syntax highlighting, Autocomlet and many more much-needed features for writing C# code.
</div>


==== Linux ====
<div lang="en" dir="ltr" class="mw-content-ltr">
==== Other / Commandline ====
If want to use the Commandline you can use all template options on the Commandline in any Terminal Application with the help of the ''dotnet'' command.
</div>


Open a terminal and navigate to this folder and enter <code>mono vsmodtools.exe</code>.
<div lang="en" dir="ltr" class="mw-content-ltr">
* Create a new VS mod in the folder ''mytestmod'' in the current location of the terminal.
<syntaxhighlight lang=shell>
dotnet new vsmod --AddSolutionFile -o mytestmod
</syntaxhighlight>
</div>


==== Mac OS ====
<div lang="en" dir="ltr" class="mw-content-ltr">
* or create a dll/code only mod
<syntaxhighlight lang=shell>
dotnet new vsmoddll --AddSolutionFile -o mytestmod
</syntaxhighlight>
</div>


Double-click <code>modtools.command</code>.
<div lang="en" dir="ltr" class="mw-content-ltr">
For all possible options run the following in the terminal:
<syntaxhighlight lang=shell>
dotnet new vsmod --help
</syntaxhighlight>
</div>


[[File:ModTools.png]]
<div lang="en" dir="ltr" class="mw-content-ltr">
When using the Commandline you can specify these options like so:
</div>


=== Setup ===
<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang=shell>
# Will create a new Mod Project with the dependency for VSSurvivalMod
dotnet new vsmod --AddSolutionFile --IncludeVSSurvivalMod -o mytestmod
</syntaxhighlight>
</div>


{{Syntax|setup [optional path]}}
<br>
----
<br>


Before doing anything else you have to setup your workspace. Just type in <code>setup</code> and it will automatically try to locate your Vintage Story installation directory. If it cannot find it, you will be asked to type in the full path. Once you have entered your path, it will update your project files so you can start to work with it. Now open the project again and run your first test by clicking <code>Start</code> [[File:VSMods10.png]]. If everything has been set up correctly, Vintage Story should start.
<div lang="en" dir="ltr" class="mw-content-ltr">
Finally in <code>mytestmod\mytestmod\modinfo.json</code>
change the <code>name</code>, <code>modid</code> , <code>authors</code> and <code>description</code> to describe your mod.
</div>


=== Project Setup (ZIP) ===
==== Обновление шаблонов ====


The source mod system lets you build zip mods that can ship source code besides their assets. The source code is compiled during run-time by the modloader engine. This has the great advantage of being open and easy to modify on the run, but also comes with one major disadvantage, which is that the inbuilt source code compiler can only compile code up until C# 6.0, so newer language features are not supported. If this is a showstopper for you, we advise you to build a compiled mod.
Чтобы обновить все установленные шаблоны, выполните команду:
<syntaxhighlight lang=shell>
dotnet new update
</syntaxhighlight>


==== Add Mod ====
Но это не обязательно при создании нового мода, так как команда <code>dotnet new vsmod</code> установить новую версию шаблона, если она доступна.


{{Syntax|add <modid>}}
==== Структура папок ====


Adds a new mod project to your workspace, also generates an <code>assets</code>, a <code>src</code> folder and a <code>modinfo.json</code> file. The mod will be added to your visual studio solution and will be loaded by Vintage Story. Make sure to fill in all additional information in <code>modinfo.json</code>.
Вот обзор того, где находятся файлы в вашем моде.
<table id="treeviewtable" class="table table-bordered tt-table" style='table-layout: fixed'>
  <tr style=''>
    <th width='300' align='left'>Название</th>
    <th width='600' align='left'>Описание</th>
  </tr>
  <tr>
    <td><div class="tt" data-tt-id="root">mytestmod</div></td>
    <td></td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_vscode" data-tt-parent="root">.vscode</div></td>
    <td>Если вы указали --IncludeVSCode, то эта папка будет содержать всё необходимое для запуска, упаковки и дебага вашего мода в Visual Studio Code.</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_cakebuild" data-tt-parent="root">CakeBuild</div></td>
    <td>Этот проект содержит код, который билдит mytestmod_x.x.x.zip. Вы можете выполнить его, выбрав CakeBuild в Run Configuration.</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_mytestmod" data-tt-parent="root">mytestmod</div></td>
    <td>Это ваш проект. Он содержит весь ваш код, ассеты и modinfo.json</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_assets" data-tt-parent="p_mytestmod">assets</div></td>
    <td>Ваши ассеты. Смотри '''{{pll|Modding:Asset System|nsp=0}}'''</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_modinfo" data-tt-parent="p_mytestmod">modinfo.json</div></td>
    <td>Описывает ваш мод. Автор, зависимости, название и многое другое. Смотри '''{{pll|Modinfo}}'''</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_properties" data-tt-parent="p_mytestmod">Properties</div></td>
    <td></td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_launchsettings" data-tt-parent="p_releases_properties">launchSettings.json</div></td>
    <td>Здесь содержится информация о том, как запустить ваш мод (Visual Studio, Rider). Вы можете добавить пользовательские параметры запуска, чтобы, например, при старте запускаться прямо в мир. Запустите Vintagestory.exe -h, чтобы увидеть все параметры из терминала, открытого в папке Vintagestory.</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_csproj" data-tt-parent="p_mytestmod">mymod.csproj</div></td>
    <td>csproj вашего мода. Содержит информацию о версии .NET и зависимостях (например, VintagestoryAPI).</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases" data-tt-parent="root">Releases</div></td>
    <td>Будет содержать релиз вашего мода после выполнения CakeBuild.</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_mymtestmod" data-tt-parent="p_releases">mytestmod</div></td>
    <td>Файлы мода перед упаковкой в .zip архив.</td>
  </tr>
  <tr>
    <td scope="row"><div class="tt" data-tt-id="p_releases_zip" data-tt-parent="p_releases">mytestmod_x.x.x.zip</div></td>
    <td>Готовый к релизу мод в виде zip-архива.</td>
  </tr>


==== Delete Mod ====
</table>


{{Syntax|delete <modid>}}
=== Проект-шаблон мода ===


Before executing, make sure your project is closed, otherwise you might run into some difficulties. Running this command will delete the given mod completely (irreversible).
<div lang="en" dir="ltr" class="mw-content-ltr">
Use the [https://github.com/anegostudios/vsmodtemplate Github Mod template] to create a new mod
</div>


==== Pack Mod ====
{{Syntax|pack <modid>}}


Creates a mod zip file and places it in <code>/releases/<modid>/<modid>_v<modversion>.zip</code>. This file is ready for use and can be shared with other people.
<div lang="en" dir="ltr" class="mw-content-ltr">
The Github Mod template provides an easy way to get the basics for mod setup so you can start directly with adding your modifications to the game.
</div>


{{Syntax|pack-all}}
<div lang="en" dir="ltr" class="mw-content-ltr">
* Without using git and Github account
</div>


Packs all mods in your workspace at once.
<div lang="en" dir="ltr" class="mw-content-ltr">
To get a copy of the template click the <code><> Code</code> button on the GitHub repository site. Then download the template as ZIP file and extract it.
</div>


=== Project Setup (Compiled Zip) ===
<div lang="en" dir="ltr" class="mw-content-ltr">
* Using Github and or git command
</div>


Both dll and zip mods have their advantages and disadvantages, so why not combine them together? This project setup is very similar to zip. Instead of adding the source code to the zip file, it uses the compiled dll. This allows you to have all the dll benefits while still having the zip mod asset structure.
<div lang="en" dir="ltr" class="mw-content-ltr">
You can directly click on <code>Use this template</code> on the GitHub repository site to create a copy of it to your GitHub account.
After that, you can clone your new repository to your computer.
</div>


==== Add Mod ====
<div lang="en" dir="ltr" class="mw-content-ltr">
If you do not use GitHub just clone the repo and upload it to your preferred Git hosting provider (Gitlab, BitBucket, ...)
</div>


{{Syntax|add <modid> compiled}}
<div lang="en" dir="ltr" class="mw-content-ltr">
<br>
With a local copy of the template, you can go ahead and open the ''ModTemplate.sln'' either in Visual Studio, Rider or Open the folder in Visual Studio Code. The Template is ready to use for any of the aforementioned IDE's. Now you can already start the mod with the game.
</div>


Adds a compiled zip mod template to your workspace. The difference is that it uses a compiled dll instead of the actual source code. All other commands are equal to the zip ones.
<div lang="en" dir="ltr" class="mw-content-ltr">
When opened you need to change the following to release the mod since a mod has to have a unique ''modid'' for the VSModDB:
<br>
</div>


==== Set Mod ====
<div lang="en" dir="ltr" class="mw-content-ltr">
In <code>modtemplate\resources\modinfo.json</code>
change the <code>name</code>, <code>modid</code> , <code>authors</code> and <code>description</code> to describe your mod.
</div>


{{Syntax|set <modid> <source&#124;compiled>}}
<div lang="en" dir="ltr" class="mw-content-ltr">
For a full list of available options see '''[[Modinfo | Modinfo]]'''.
</div>


Sets the given zip mod either to source or compiled. This can be useful if you want to change the type of your mod later on.
<div lang="en" dir="ltr" class="mw-content-ltr">
The <code>modid</code> has to contain only lowercase letters and numbers. No special chars, whitespaces, uppercase letters, etc. are allowed.
</div>


=== Project Setup (DLL) ===
<div lang="en" dir="ltr" class="mw-content-ltr">
Next, rename the folder <code>modtemplate\resources\assets\mymodid</code> to match what your <code>modid</code> is.
</div>


Dll mods are way more powerful than source mods, but they have two major downsides. Firstly, they are not able to carry assets which will be loaded by the game, secondly because they are so powerful they can be dangerous. Besides that dll mods can (unlike the others) have cross mod references, provide APIs and use C# 7. We recommend this type of mod for more experienced mod developers.
<div lang="en" dir="ltr" class="mw-content-ltr">
Finally change in the file <code>modtemplate\modtemplateModSystem.cs</code> the line
<syntaxhighlight lang=cs>
Lang.Get("mymodid:hello")
</syntaxhighlight>
from <code>mymodid</code> to your new modid.
</div>


==== Add Mod ====
<div lang="en" dir="ltr" class="mw-content-ltr">
The file <code>modtemplate\modtemplateModSystem.cs</code> can be called whatever you like.
</div>


{{Syntax|add-dll <modid>}}
<div lang="en" dir="ltr" class="mw-content-ltr">
(Optional) Further, you can change the name <code>ModTemplate</code> to whatever you like as long as you change all of the following:
* Folder <code>ModTemplate</code>
* File <code>ModTemplate\ModTemplate.csproj</code>
* In File <code>CakeBuild\Program.cs</code> on line
<syntaxhighlight lang=cs>
ProjectName = "ModTemplate";
</syntaxhighlight>
</div>


Adds a new mod project to your workspace. A generated <code>AssemblyInfo.cs</code> file will be in your properties folder, it contains the mod information (name, author, version, description etc.) so make sure to change them before you spread the mod to other people. The mod will be added to your visual studio solution and will be loaded by VintageStory.
<div lang="en" dir="ltr" class="mw-content-ltr">
''If you are on linux and used the Github Template'' make sure to update in <code>ModTemplate\Properties\launchSettings.json</code> the <code>executablePath</code>. There you need to remove the <code>.exe</code>
</div>


==== Delete Mod ====
=== Запуск мода ===


{{Syntax|delete <modid>}}
==== Запуск мода в Visual Studio ====
[[File:Vs-cp-start.png|600px|frameless|center|alt=Запуск мода в Visual Studio|Запуск мода в Visual Studio]]


Before executing, make sure your project is closed, otherwise you might run into some difficulties. Running this command will delete the given mod completely (irreversible).
==== Запуск мода в Rider ====
<gallery mode="packed-hover" widths=500px heights=100px>
File:Rider-cp-start-new-ui.png|Запуск мода в Rider (Новый UI)
File:Rider-cp-start.png|Запуск мода в Rider
</gallery>
==== Запуск мода в Visual Studio Code ====
[[File:Vsc-cp-start.png|400px|frameless|center|alt=Запуск мода в Visual Studio Code|Запуск мода в Visual Studio Code]]


==== Release Mod ====
Если у вас возникли проблемы, вы можете узнать больше из проекта [https://github.com/anegostudios/vsmodexamples vsmodexamples]


Once you launch VintageStory in your workspace, the DLL mod will be compiled. You can find it in your <code>mods</code> folder, with the give name: <code><modid>.dll</code>. If you want to upload this mod or share it with your friends this is the file you need to use.
== Упаковка мода ==


== Manual setup ==
<div lang="en" dir="ltr" class="mw-content-ltr">
With the new template, we are using the [https://cakebuild.net/ Cake] build system. This includes a second Project within the Solution in the template.
In all supported IDE's you can select from the dropdown that you used to launch the mod the <code>CakeBuild</code> option and run it.
''When using Visual Studio Code you can also create a package by running the package task. For that got to <code>Terminal</code> > <code>Run Task...</code> and select <code>package</code>.''
</div>


* Create a new project
<div lang="en" dir="ltr" class="mw-content-ltr">
* Add at least a library reference to the <code>VintageStoryApi.dll</code> (on Windows it's located in the installation directory)
It will perform a JSON validation on your assets so they are at least parsable by Newtonsoft.Json and then build a <code>Releases/mymodid_1.0.0.zip</code>. The version is taken from the <code>mymod/modinfo.json</code> file.
* Open the project properties. Under debug select "Start external program" select the <code>VintageStory.exe</code>. Also adjust the working directory to where the executable is located.
</div>
* If you compile to a .dll file, set up a ModInfo attribute in your AssemblyInfo.cs ([https://github.com/anegostudios/vsmodtemplate/blob/master/Properties/AssemblyInfo.cs example])
** Add the following command line arguments: <code>-openWorld="modsamplestest" -pcreativebuilding --addModPath="C:\path\to\your\bin\folder" --addOrigin="C:\path\to\your\assets\folder\if\you\have\any"</code>
* If want to ship a source mod or mod with assets, set up a <code>modinfo.json</code> ([https://github.com/copygirl/CarryCapacity/blob/master/resources/modinfo.json example]). Make sure your folders are set up in a way that the modPath contains the modinfo.json and a folder named "src" containing your source files. Optionally it can also contain an assets folder for your assets.
** Add the following command line arguments: <code>-openWorld="modsamplestest" -pcreativebuilding --addModPath="C:\path\to\your\modPath"</code>
* I recommend adding the [https://github.com/anegostudios/vsmodexamples/blob/master/Mods/RedirectLogs/src/RedirectLogs.cs RedirectLogs.cs] file to your project, so that you can see the log output in your visual studio output window. Be sure not to ship your mod with it though.
* Run the project and hope for the best :D
* To ship a mod have a look at [[Mod Packaging]]


If you are having troubles, you might be able to learn from the [https://github.com/anegostudios/vsmodexamples vsmodexamples project]
<div lang="en" dir="ltr" class="mw-content-ltr">
Congratulations now you have your mod development environment set up and a ready-to-release mod package.
</div>


= Moving Forward =
<div lang="en" dir="ltr" class="mw-content-ltr">
Note: Make sure you use your own unique <code>modid</code> else you won't be able to upload the mod to the VSModDB.
</div>


If you've successfully managed to setup your development environment and can run Vintage Story through the '''VSMods''' project in your IDE then it's time to get started on your first code mod. At this point there are many options you can choose from as code mods can alter almost any aspect of the game. However, the best place to start is likely one again with Blocks and Items (since you should be familiar with making them using JSONS by this point).
= Дальнейшее продвижение =


Head over to the '''[[Modding:Advanced Blocks | Advanced Blocks]]''' page to make your first advanced code block.
Если вам удалось настроить среду разработки и запустить Vintage Story через проект мода в вашей IDE, то пришло время приступить к работе над своим первым модом кода. На данный момент есть много вариантов, которые вы можете выбрать, поскольку моды кода могут изменить практически любой аспект игры. Тем не менее, лучше всего начать с блоков и элементов (поскольку к этому моменту вы уже должны быть знакомы с их созданием используя JSON-ы).


Or head over to the '''[[Modding:Advanced Items | Advanced Items]]''' page to make your first advanced code item.
Перейдите на страницу '''[[Modding:Advanced Blocks/ru|Продвинутые блоки]]''', чтобы создать свой первый продвинутый блок кода.


{{Navbox/modding/ru|Vintage Story}}
Или перейдите на страницу '''{{Not translated|Modding:Advanced Items/ru|Продвинутые предметы|Modding:Advanced Items}}''', чтобы создать свой первый продвинутый предмет кода.
{{Navbox/modding}}
Nyuhnyash
Confirmedusers
1,783

edits

Retrieved from "https://wiki.vintagestory.at/index.php/Special:MobileDiff/43322...144952"