From 38b1caa1034cd867e5684c2941a8bbb2c8bcf3c8 Mon Sep 17 00:00:00 2001 From: MihailRis Date: Tue, 12 Mar 2024 14:23:00 +0300 Subject: [PATCH] =?UTF-8?q?Created=201.=20=D0=A0=D0=B5=D0=BA=D0=BE=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D0=B4=D0=B0=D1=86=D0=B8=D0=B8=20=D0=BF=D0=BE=20?= =?UTF-8?q?=D0=B8=D1=81=D0=BF=D0=BE=D0=BB=D1=8C=D0=B7=D0=BE=D0=B2=D0=B0?= =?UTF-8?q?=D0=BD=D0=B8=D1=8E=20=D0=B4=D0=B2=D0=B8=D0=B6=D0=BA=D0=B0=20(ma?= =?UTF-8?q?rkdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 1.-Рекомендации-по-использованию-движка.md | 28 ++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 1.-Рекомендации-по-использованию-движка.md diff --git a/1.-Рекомендации-по-использованию-движка.md b/1.-Рекомендации-по-использованию-движка.md new file mode 100644 index 0000000..337807d --- /dev/null +++ b/1.-Рекомендации-по-использованию-движка.md @@ -0,0 +1,28 @@ +# Наименование контента + +## ID контент-паков + +Идентификатор контент-пака должен следовать следующим требованиям: +- название может состоять только из букв латиницы, цифр и символа подчёркивания `_` +- название не может начинаться с цифры +- длина названия должна находиться в пределах от 2 до 24 включительно + +## Блоки и предметы + +- id блоков и предметов следуют тем же требованиям, что и ID контент-пака. +- окончание `.item` добавляется только для замены сгенерированного для блока предмета. Пример: `base:stone.item` - предмет сгенерированный для блока камня. +- поле **caption**, предназначенное для отображения названия в инвентаре, не указывается с заглавной буквы, без необходимости. Движок автоматически повышает регистр при отображении в интерфейсе. + +# Хранение файлов + +## Данные контент-паков + +Настройки, состояние, которое нужно сохранять в мире, должны находиться в `world:data/id_пака/`. Путь следует получать через специальную функцию: +```lua +local path = pack.data_file(PACK_ID, "имя_файла") +file.write(path, данные) +-- запишет данные в файл world:data/PACK_ID/имя_файла +``` +Здесь PACK_ID является доступной константой, т.е не нужно вписывать имя пака самостоятельно. + +Папка `world:data/PACK_ID` будет создана при вызове `pack.data_file`. \ No newline at end of file