voxelcoreprojects/voxelcore
1
0
Fork 0
mirror of https://github.com/MihailRis/voxelcore.git synced 2026-10-08 20:41:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Destroyed 1. Рекомендации по использованию движка (markdown)

MihailRis 2024-03-15 12:38:43 +03:00
parent 6f20f077fe
commit e606e05b6a
1 changed files with 0 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

28
1.-Рекомендации-по-использованию-движка.md

@ -1,28 +0,0 @@
# Наименование контента
## 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`.