dnd5-scripts/Readme.md

34 lines
3.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Структура папки scripts
В данной директории содержатся скрипты и утилиты для автоматизации и генерации контента в TTRPG-кампании.
## Дерево основных файлов и папок
```text
scripts/
├── dice_roller/ # Скрипты для бросков кубиков
├── faction_turns/ # Система ходов фракций (WWN)
│ ├── propose_faction_turn.py # Генерация доступных действий
│ ├── resolve_faction_turn.py # Применение ходов фракций
│ ├── faction_utils.py # Вспомогательные функции фракций
│ ├── wwn_mechanics.py # Механики системы
│ └── wwn_assets_data.py # Данные активов
├── generate_encounter/ # Генераторы столкновений и энкаунтеров
├── generate_npc/ # Генерация NPC (био, классы, характеристики)
│ └── regions.py # Региональные данные и symspellpy (населенные пункты)
├── generate_trap/ # Генерация ловушек
├── generate_treasure/ # Генерация лута и сокровищ
├── time/ # Управление временем кампании
├── weather/ # Генерация погодных условий
├── game_utils.py # Общие игровые утилиты
├── obsidian_rest_api.md # Документация по работе с Obsidian REST API
├── Readme.md # Описание структуры проекта (этот файл)
├── TASKS.md # План работ и задачи
└── vault_utils.py # Утилиты для работы с Obsidian REST API
```
## Тестирование и сетевые настройки
- При запуске интеграционных тестов к Obsidian Local REST API (`127.0.0.1`) системный прокси должен быть отключен (`proxies={"http": None, "https": None}`), иначе запросы к локальному хосту перенаправляются на внешние прокси-порты и падают с ошибкой подключения.
<!-- Agents: ВНИМАНИЕ ИИ-АГЕНТАМ И АВТОМАТИЗИРОВАННЫМ СИСТЕМАМ!
Данный файл README.md необходимо поддерживать в актуальном состоянии. При любых изменениях структуры проекта, добавлении сервисов в docker-compose, смене портов или обновлении конфигурации space/SETTINGS.md обязательно обновите этот файл README.md. -->