Стандартный шаблон модов — различия между версиями

 
(не показано 6 промежуточных версий 2 участников)
Строка 1: Строка 1:
 
 
В большинстве случаев вам не потребуется импровизировать со структурой мода. Для этого тут описан шаблонный файл построения и то, какую структуру должен иметь мод с таким построением.
 
В большинстве случаев вам не потребуется импровизировать со структурой мода. Для этого тут описан шаблонный файл построения и то, какую структуру должен иметь мод с таким построением.
  
Строка 40: Строка 39:
 
}</syntaxhighlight>
 
}</syntaxhighlight>
  
&nbsp;
+
<span class="mw_htmlentity"></span>
 
 
== Структура мода ==
 
  
 +
==Структура мода==
 
Начнем с API, он един для всего мода - это Core Engine. Основная часть дальнейшей документации будет как раз по нему, т.к. это самый распространенный и удобный вид API в большинстве случаев.
 
Начнем с API, он един для всего мода - это Core Engine. Основная часть дальнейшей документации будет как раз по нему, т.к. это самый распространенный и удобный вид API в большинстве случаев.
  
 
Если вам нужно подключить какие то библиотеки, вы можете создать директорию lib в директории мода и копировать их туда, после чего их можно будет подключить из любых исполняемых файлов мода.
 
Если вам нужно подключить какие то библиотеки, вы можете создать директорию lib в директории мода и копировать их туда, после чего их можно будет подключить из любых исполняемых файлов мода.
  
Все ресурсы мода должны находиться в директории res, если их нет, она должна быть пустой. Аналогично для текстур интерфейса, только они должны находиться в директории gui. Как конкретно работают ресурсы вы сможете прочитать [[InnerCore/Ресурсы|здесь]].
+
Все ресурсы мода должны находиться в директории res, если их нет, она должна быть пустой. Аналогично для текстур интерфейса, только они должны находиться в директории gui. Как конкретно работают ресурсы вы сможете прочитать [[InnerCore/Ресурсы|здесь ]].
  
 
В директории мода должен присутствовать файл launcher.js, который по-умолчанию должен содержать только команду Launch(); Более подробная работа с лаунчером мода будет описана в другой главе.
 
В директории мода должен присутствовать файл launcher.js, который по-умолчанию должен содержать только команду Launch(); Более подробная работа с лаунчером мода будет описана в другой главе.
  
 +
<div class="mw-parser-output">
 
== Исходный код мода ==
 
== Исходный код мода ==
  
Строка 58: Строка 57:
 
Пример содержимого .includes:
 
Пример содержимого .includes:
 
<pre>// Предположим, что .includes находится в директории dev/ в моде
 
<pre>// Предположим, что .includes находится в директории dev/ в моде
 
 
// Этот файл должен находиться на пути dev/header.js
 
// Этот файл должен находиться на пути dev/header.js
 
header.js
 
header.js
 
 
// Эти файлы соответсвенно должны находиться в dev/source/
 
// Эти файлы соответсвенно должны находиться в dev/source/
 
source/blocks.js
 
source/blocks.js
source/items.js</pre>
+
source/items.js
 
+
//Все эти файлы будут собраны в файл main.js и запущены, как основной код мода.</pre>
Все эти файлы будут собраны в файл main.js и запущены, как основной код мода.
+
</div>
  
 +
<div class="mw-parser-output">
 
== Заключение ==
 
== Заключение ==
  
Как говорилось в начале данная структура подходит для большинства модов и если вам не нужно ничего особенного, то оптимально использовать именно ее.
+
Как говорилось в начале данная структура подходит для большинства модов и если вам не нужно ничего особенного, то оптимально использовать именно её.
 +
</div>

Текущая версия на 23:27, 2 апреля 2021

В большинстве случаев вам не потребуется импровизировать со структурой мода. Для этого тут описан шаблонный файл построения и то, какую структуру должен иметь мод с таким построением.

Здесь приведено содержимое файла build.config:

{ 
    "defaultConfig":{ 
        "buildType":"develop", 
        "api":"CoreEngine", 
        "libraryDir":"lib/" 
    }, 
    
    "resources":[ 
        { 
            "path":"res/", 
            "resourceType":"resource" 
        }, 
        { 
            "path":"gui/", 
            "resourceType":"gui" 
        } 
    ], 
    
    "buildDirs":[ 
        { 
            "targetSource":"main.js", 
            "dir":"dev/" 
        } 
    ], 
    
    "compile":[ 
        { 
            "path":"main.js", 
            "sourceType":"mod" 
        }, 
        { 
            "path":"launcher.js", 
            "sourceType":"launcher" 
        } 
    ] 
}

Структура мода[править]

Начнем с API, он един для всего мода - это Core Engine. Основная часть дальнейшей документации будет как раз по нему, т.к. это самый распространенный и удобный вид API в большинстве случаев.

Если вам нужно подключить какие то библиотеки, вы можете создать директорию lib в директории мода и копировать их туда, после чего их можно будет подключить из любых исполняемых файлов мода.

Все ресурсы мода должны находиться в директории res, если их нет, она должна быть пустой. Аналогично для текстур интерфейса, только они должны находиться в директории gui. Как конкретно работают ресурсы вы сможете прочитать здесь .

В директории мода должен присутствовать файл launcher.js, который по-умолчанию должен содержать только команду Launch(); Более подробная работа с лаунчером мода будет описана в другой главе.

Исходный код мода[править]

Так же в моде обязана присутствовать директория построения dev, в которой должен быть файл построения .includes, в нем прописаны все локальные пути файлов, которые участвуют в построении в нужном порядке, так же он может содержать комментарии (// или #) и пустые строки

Пример содержимого .includes:

// Предположим, что .includes находится в директории dev/ в моде
// Этот файл должен находиться на пути dev/header.js
header.js
// Эти файлы соответсвенно должны находиться в dev/source/
source/blocks.js
source/items.js
//Все эти файлы будут собраны в файл main.js и запущены, как основной код мода.

Заключение[править]

Как говорилось в начале данная структура подходит для большинства модов и если вам не нужно ничего особенного, то оптимально использовать именно её.