Редактирование:Структура модов

<div class="mw-parser-output"><h2>Структура модов</h2><p>Мод под Inner Core представляет из себя директорию с файлом построения build.config, так же могут присутствовать несколько дополнительных файлов, таких как файл описания и стандартный файл конфигурации. Последний будет создан автоматически.
</p><p>Если вы не хотите вдаваться в подробности построения модов, вы можете использовать стандартный шаблон мода, который описан <a href="InnerCore%2F%D0%A1%D1%82%D0%B0%D0%BD%D0%B4%D0%B0%D1%80%D1%82%D0%BD%D1%8B%D0%B9%20%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%20%D0%BC%D0%BE%D0%B4%D0%BE%D0%B2">здесь </a>.
</p>
<h2>Конфиг и описание</h2>
<p>Файл конфига - config.json - задается в формате JSON и генерируется, либо исправляется автоматически. Всегда будет присутствовать значение enabled, которое включает/выключает весь мод. Содержимое этого файла будет визуализировано в меню мода, которое открывается через меню Inner Core. Работа с этим файлом производистся целиком из кода.
</p><p>Файл информации - mod.info - задается в формате JSON и может не пристуствовать, однако тогда информации о моде в меню Inner Core не будет, название мода будет по имени директории и т.д. 
</p><p>Формат файла mod.info:
</p><p><pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="javascript">{
    &quot;name&quot;:&quot;Имя мода&quot;,
    &quot;author&quot;:&quot;Автор мода&quot;,
    &quot;version&quot;:&quot;Версия мода в любом формате&quot;,
    &quot;description&quot;:&quot;Краткое описание мода&quot;
}</syntaxhighlight></pre>
</p><p>Также директоря мода может содержать файл mod_icon.png, который будет являться иконкой мода в меню Inner Core. Важен только формат - png - размер может быть любым.
</p>
<h2>Основные параметры</h2>
<p>Файл построения задается в формате JSON и имеет несколько разделов, в которых описываются различные настройки и элементы мода.
</p>
<pre class="_fck_mw_lspace">Первый раздел - defaultConfig - является обязательным и описывает основные параметры построения мода. С ним содержимое файла построения будет выглядеть следующим образом (комментарии, помеченные символом #, присутствовать не должны):
</pre>
<p>{
</p>
<pre class="_fck_mw_lspace">   "defaultConfig": {
       "api":"CoreEngine", #API, которое будет использовано для всех выполняемых файлов по-умолчанию, варианты API будут перечислены далее
       "buildType":"develop", #Этот параметр при разработке должен быть develop, далее он будет изменяться с помощью Inner Core
       "libraryDir":"lib/", #Необязательный параметр, который задает стандартную директорию, откуда будут загружаться библиотеки.
   }
</pre>
<p>}
</p><p>API задает абсолютное большинство методов, которые могут использовать исполняемые файлы мода. Однако есть набор базовых методов, которые доступны для конкретных типов выполняемых файлов.
</p><p>Виды API:
</p>
<ul><li> CoreEngine - Основной и самый объемный API для разработки модов. В основном вам нужно будет использовать его, остальные варианты более ситуативны и не нужны в большинстве случаев.</li>
<li> AdaptedScript - Реализует основные возможности, однако не имеет различных реализаций, сильно упрощающих разработку, таких как Tile Entity.</li></ul>
<p>Исполняемые файлы<br />
Исполняемые файлы содержат исходный код мода, написаный под нужный вариант API на JavaScript, которые будут выполняться в различные моменты, зависящие от их типа. Так же их можно строить из отдельных директорий и компилировать в байт-код из меню Inner Core для быстродействия и лучшего дебага (релизные версии мода).
</p><p>Исполняемые файлы описываются в разделе compile, который является массивом. Их может быть сколько угодно много:
{
</p>
<pre class="_fck_mw_lspace">   "defaultConfig": {
       ...
   },
   ...
   "compile": [
       {
           "path":"Локальный путь к файлу, к примеру main.js, source/logger.js",
           "sourceType":"Тип исполняемого файла, они будут перечислены далее",
           "sourceName":"Имя, необязательный параметр, будет использовано при выводе ошибок",
           "api":"Тип API, если вы хотите выбрать не тот тип, который вы указали в defaultConfig конкретно для этого файла, иначе этот параметр не нужен"
       },
       ...
   ]
</pre>
<p>}
</p><p>Типы исполняемых файлов:
</p>
<ol><li> mod - В этом типе файлов находится основной исходный код модов, задающий их контент.</li>
<li> launcher - Должен присутствовать только один файл этого типа. В нем осуществляется запуск мода в определенный момент (Например если мод использует API другого мода, он должен запуститься только после его загрузки и т.п.). Если никаких дополнительных условий для запуска не нужно, он просто должен содержать команду Launch();</li>
<li> library - Библиотека. Может с помощью специальных методов, доступных только этому типу файлов, регистрировать новые модули API, которые используются модами, если те эту библиотеку импортируют. Этот тип файлов не надо описывать, если он находится в директории, заданной в параметре libraryDir.</li>
<li> preloader - Отдельный специфический тип файла, который будет выполняться до загрузки MCPE после загрузки ресурсов и требуется для их создания и изменения. На момент написания данной документации, использует отдельный тип API, который еще плохо реализован.</li>
<li> custom - Выполняется только с помощью специального метода - runCustomSource(), вызванного из остальных типов исполняемых файлов. Может принимать параметры.</li></ol>
<p>Подробнее про каждый тип файлов и их специальные методы и значения будет рассказано в <a href="InnerCore%2F%D0%91%D0%B0%D0%B7%D0%BE%D0%B2%D1%8B%D0%B5%20%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D1%8B%20%D0%B8%20%D0%BF%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%BD%D1%8B%D0%B5%20%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D0%BD%D1%8F%D0%B5%D0%BC%D1%8B%D1%85%20%D1%84%D0%B0%D0%B9%D0%BB%D0%BE%D0%B2">отдельной главе </a>.
</p><p>
</p>
<h2>Построение исполняемых файлов</h2>
<p>Исполняемым файлам можно задавать построение из отдельных директорий. Построение происходит из многих файлов, которые описываются в файле построения. Этот метод позволяет разбивать код на части и группировать их, а не писать один огромный файл. Это дает не только читабельность, но так же позволяет более оптимально компилировать моды и дебажить их в продакшине.
</p><p>Директории построения задаются в разделе buildDirs, который является массивом:
{
</p>
<pre class="_fck_mw_lspace">   "defaultConfig": {
       ...
   },
   ...
   "buildDirs": [
       {
           "dir":"dir/to/build/", #Директория, из которой будет выполняться построение, должна заканчиваться символом /
           "targetSource":"dir/to/source/file", #Файл, в который будет выполняться построение. ВАЖНО: содержимое файла будет полностью перезаписываться при каждом построении, так что не стоит там что либо писать.
       },
       ...
   ]
</pre>
<p>}
</p><p>Директория построения задается следующим образом:
</p>
<ul><li> Она должна содержать файлы с кодом, которые вы хотите объединить в исполняемый файл. Они могут находиться в дочерних директориях и иметь любые названия.</li>
<li> Она должна содержать файл построения .includes, в нем прописаны все локальные пути файлов, которые участвуют в построении в нужном порядке, так же он может содержать комментарии (// или #) и пустые строки</li></ul>
<p>Пример содержимого .includes:
</p><p>
</p>
<pre>// Предположим, что .includes находится в директории dev/ в моде&lt;br&gt;&lt;br&gt;// Этот файл должен находиться на пути dev/header.js
header.js&lt;br&gt;&lt;br&gt;// Эти файлы соответсвенно должны находиться в dev/source/
source/blocks.js
source/items.js</pre>
<p>Важно понимать, что каждый из этих файлов должен быть завершенным куском кода, потому что каждый из них компилируется по отдельности. Т.е. нельзя начать блок в одном файле и закончить в следующем.
</p><p>
</p>
<h2>Ресурсы</h2>
<p>Ресурсы модов делятся на две группы - текстуры интерфейса (GUI) и остальные (блоки, предметы, текстуры для моделей и т.п.). Какие бывают типы ресурсов будет рассказано в <a href="InnerCore%2F%D0%A0%D0%B5%D1%81%D1%83%D1%80%D1%81%D1%8B">отдельной главе </a>.
Директории ресурсов описываются в разделе resources, их может быть сколько угодно много:
{
</p>
<pre class="_fck_mw_lspace">   "defaultConfig": {
       ...
   },
   ...
   "resources": [
       {
           "path":"resource/dir/", #Директория ресурсов, должна заканчиваться символом /
           "resourceType":"resource|gui", #Тип подгрузки ресурсов: resource - внутриигровые ресурсы, gui - текстуры интерфейса
       },
       ...
   ]
</pre>
<p>}
</p>
<div class="mw-parser-output"><div class="mw-highlight mw-content-ltr" dir="ltr">
<pre>{    &quot;defaultConfig&quot;: {        ...    },    ...    &quot;resources&quot;: [        {            &quot;path&quot;:&quot;resource/dir/&quot;, #Директория ресурсов, должна заканчиваться символом /            &quot;resourceType&quot;:&quot;resource|gui&quot;, #Тип подгрузки ресурсов: resource - внутриигровые ресурсы, gui - текстуры интерфейса        },        ...    ]}</pre></div>
</div>
<div class="mceNonEditableOverlay"> </div>
<p>Подробно о ресурсах и их использовании будет рассказано <a href="InnerCore%2F%D0%A0%D0%B5%D1%81%D1%83%D1%80%D1%81%D1%8B">отдельно </a>.
</p></div>