vtt-module-template/README.md

84 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Файл шаблона для новых репозиториев
Для дальнейшей работы необходимо:
* добавить субмодуль со скриптами: git submodule add https://gitea.kdiva.ru/modules/helper-scripts.git
* заполнить поля в `module.json.template`
```json
"id": "",
"name": "",
"title": "",
"description": "",
...
"packs": []
```
`packs` может включать в себя следующие элементы:
```json
{
"name": "actors",
"label": "new adventure template",
"path": "/packs/actors.db",
"entity": "Actor",
"type": "Actor",
"system": "dnd5e"
},
{
"name": "adventure",
"label": "new adventure template",
"path": "/packs/adventure.db",
"entity": "Adventure",
"type": "Adventure",
"system": "dnd5e"
},
{
"name": "cards",
"label": "new adventure template",
"path": "/packs/cards.db",
"entity": "Cards",
"type": "Cards"
},
{
"name": "items",
"label": "new adventure template",
"path": "/packs/items.db",
"entity": "Item",
"type": "Item",
"system": "dnd5e"
},
{
"name": "journals",
"label": "new adventure template",
"path": "/packs/journals.db",
"entity": "JournalEntry",
"type": "JournalEntry"
},
{
"name": "macros",
"label": "new adventure template",
"path": "/packs/macros.db",
"entity": "Macro",
"type": "Macro"
},
{
"name": "maps",
"label": "new adventure template",
"path": "/packs/maps.db",
"entity": "Scene",
"type": "Scene"
},
{
"name": "playlists",
"label": "new adventure template",
"path": "/packs/playlists.db",
"entity": "Playlist",
"type": "Playlist"
},
{
"name": "rolltables",
"label": "new adventure template",
"path": "/packs/rolltables.db",
"entity": "RollTable",
"type": "RollTable"
}
```