Теги: note
Статус: active
Слов: 1 510
RULES.md
Названия мира
МИР БАТОНИэто официальное навания выдуманной вселенной. Вся информация, персонажи и места выдуманы и не являются правдой
Названия папок и файлов
- Корневые системные папки repo:
lowercase(мир/,карточки/,истории/,подсказки/,архив/). - Канонические markdown-файлы мира:
UPPERCASEдля карточек, историй и служебных заметок мира. - Новые канонические названия файлов, папок, заголовков и ссылок должны быть на русском языке без смеси с английским.
- Английский допустим только в технических исключениях: существующие корневые папки, расширения файлов, YAML-ключи, внешние технологии и legacy-пути.
- Существующие технические папки не переименовывать без отдельной миграции ссылок.
- Новые канонические подпапки называть по-русски.
- Внутри канонических папок не создавать смешанные дубли с другим регистром без необходимости.
- Список тегов находится в файле
подсказки/справка/TAGS.md. - Расширение файлов всегда
.<lowercase>.
Локации файлов
- истории/черновики/ вся информация в этой папке нуждается в обработке и не является каноном
Единый источник истины
- Единственный источник актуального состояния мира —
мир/SOURCE_OF_TRUTH.md. - Остальные файлы не являются источником текущего статуса.
- Иерархия канона:
мир/SOURCE_OF_TRUTH.md— единственный источник актуального состояния (кто жив/пропал/активен, открытые угрозы, текущие статусы персонажей, сил, артефактов, локаций, открытые вопросы).мир/TIMELINE.md— порядок событий и арок. Не источник текущего статуса.карточки/— справочник сущностей. Текущий статус сверять сSOURCE_OF_TRUTH.md.истории/основные/— каноничные события. Показывают состояние мира на момент события, не текущий статус.истории/боковые/— канон вне основной линии.истории/черновики/— не канон без проверки и переноса.BOOTSTRAP.md,подсказки/SKILL.md,подсказки/справка/,мир/доклады/— навигация, workflow, справки, аналитика. Не источники текущего состояния мира.- Если старые истории, карточки или
мир/TIMELINE.mdрасходятся смир/SOURCE_OF_TRUTH.mdпо текущему статусу, актуальным считаетсямир/SOURCE_OF_TRUTH.md. - Истории остаются каноническими событиями своего времени, но не всегда отражают текущий статус мира.
Запрет на одушевление предметов
Строго запрещено одушевлять неодушевлённые предметы в авторском тексте.
Нельзя писать, что предмет:
- имеет характер;
- имеет мнение;
- соглашается;
- обижается;
- ждёт момента;
- просит;
- понимает;
- чувствует;
- принимает решение;
- ведёт себя как самостоятельный персонаж.
Предметы должны оставаться предметами.
Если Товарищ Райко приписывает предмету идеологию, волю, позицию, революционную функцию или статус участника кухни, это допустимо только как его реплика или действие. Авторский текст не должен подтверждать его бред.
Пан Коцкий должен возвращать такие сцены к бытовой реальности сухой точной репликой.
Фокус сцены всегда должен оставаться на главных героях:
- Товарищ Райко;
- Пан Коцкий;
- их конфликт логик;
- их действия;
- их реакции.
Предмет не может перетягивать роль персонажа на себя.
Правило против дублей карточек
- Не создавать новую карточку персонажа, если карточка уже есть в
карточки/персонажи/. - Не создавать новую карточку артефакта, если карточка уже есть в
карточки/артефакты/. - Не создавать новую карточку локации, если карточка уже есть в
карточки/локации/. - Не создавать новую карточку транспорта, если карточка уже есть в
карточки/транспорт/. - Для кратких актуальных статусов использовать
мир/SOURCE_OF_TRUTH.md, а не новые дублирующие wiki-страницы.
Что можно и нельзя в карточках персонажей
Карточка персонажа — это его характеристики, личность, связи, способности. Не лог его появлений в историях.
В карточку можно: - характер, манеру речи, типичное поведение - ключевые черты личности (что движет персонажем) - способности и ограничения - связи с другими персонажами (с кратким описанием отношений) - открытые крючки (незакрытые вопросы, связанные с персонажем) - текущий статус (сверяемый с SOURCE_OF_TRUTH.md)
В карточку нельзя: - список всех историй, где персонаж появился - пересказ сюжета каждой истории с его участием - хронологический лог событий (для этого есть TIMELINE.md) - дублирование информации из историй
Исключение: «Ключевые события» — это поворотные моменты для самого персонажа (изменение статуса, новая роль, получение способности, важное личное решение), а не список его появлений. Если событие не изменило персонажа — ему не место в карточке.
Примеры:
- Семёнок → карточки/персонажи/КОТ_СЕМЕНОК.md, не создавать СЕМЕНОК.md.
- Галина → карточки/персонажи/ГАЛИНА.md, не создавать вторую ГАЛИНА.md в другой папке.
- Андрюха → карточки/персонажи/АНДРЮХА.md.
- Берюза-3000 → карточки/артефакты/БЕРЮЗА-3000.md.
Unicode и названия
- Избегать дублей файлов, которые визуально одинаковые, но отличаются Unicode-формой букв
й/ё. - Перед созданием новой карточки обязательно проверить существование похожего файла в целевой папке.
Форматирование файлов (style guide)
1. Frontmatter (YAML)
Обязательные поля — в строгом порядке:
---
created: ГГГГ-ММ-ДД
updated: ГГГГ-ММ-ДД
tags:
- батоня
- категория # одно из: персонаж, история, карточка, локация и т.д.
- ... # по смыслу, каждое с новой строки с дефисом
status: active # или: draft, archived, wip
---
Правила YAML:
- Теги всегда списком с дефисами (- тег), не inline-массивом (tags: [тег1, тег2]).
- Кавычки у значений — только если значение содержит спецсимволы (:, #, [, {, ").
- Порядок полей: created, updated, tags, status, затем специфичные поля (см. ниже).
- Между --- и содержимым — пустая строка не нужна (YAML парсит нормально). После закрывающего --- — пустая строка.
Дополнительные поля для карточек:
title: Персонаж — Роль # или "Название — Описание"
type: character # character | artefact | location | transport
species: Человек | Кот | ... # только для персонажей
role: Краткая роль # только для персонажей
canon: true # для историй
canon_type: main_story | side_story
cycle: Название-арки # необязательно
location: Где происходит # для историй
Дополнительные поля для историй:
canon: true
canon_type: main_story | side_story
cycle: Название-арки
series: N # номер серии, если часть цикла
location: Где происходит
2. Заголовки (Heading hierarchy)
Строгая иерархия заголовков:
| Тип файла | H1 (#) |
Содержание |
|---|---|---|
| Карточка персонажа | # ИМЯ |
Полное имя персонажа (как в карточке) |
| Карточка артефакта | # НАЗВАНИЕ |
Название артефакта |
| Карточка локации | # НАЗВАНИЕ |
Название локации |
| История основная | # Название истории |
По смыслу, без кавычек |
| Виньетка боковая | # ВИНЬЕТКА: НАЗВАНИЕ |
С префиксом ВИНЬЕТКА: |
| Сборник | # СБОРНИК: НАЗВАНИЕ |
С префиксом СБОРНИК: |
| Мир/служебный | # НАЗВАНИЕ |
По смыслу |
Правила:
- H1 (#) — ровно один на файл. Первая строка после frontmatter.
- H2 (##) — основные разделы: ## Базовая информация, ## Личность, ## Сюжет.
- H3 (###) — подразделы внутри H2: ### Физические характеристики, ### Ключевые события.
- H4 (####) — детали внутри H3. Использовать редко.
- H5/H6 — не использовать без крайней необходимости.
- В историях H2 — сцены или временные блоки.
- В карточках секции идут через H2 → H3, без пропуска уровней.
- Между заголовком и текстом — пустая строка.
- После текста перед следующим заголовком — пустая строка.
3. Формат историй
- Диалоги: каждая реплика с новой строки, с тире и пробелом (
— Реплика, — сказал кто-то.). - Между репликами разных говорящих — пустая строка.
- Атрибуция диалога:
— Текст, — сказал Персонаж.(запятая перед тире). - Реплики персонажа с характерной речью (казахский говор Боди, «ик!» Леопольда, «та-та-та-та» Полковника) выделять последовательно.
- Мысли персонажа — без кавычек, просто повествование от третьего лица.
- Абзацы: короткие (2-5 предложений). Длинные монологи разбивать на абзацы.
- Разрыв сцены:
---на отдельной строке. - Эпиграф: после H1, перед текстом, в формате
> Текст эпиграфа(один блок, не более 3 строк).
4. Формат карточек
Стандартная структура карточки (обязательные секции):
# ИМЯ
## Базовая информация
- **Поле:** Значение
- **Поле:** Значение
## Личность
- **Характер:** ...
- **Мотивация:** ...
- **Ценности:** ...
## Биография
**Ранняя жизнь:**
Текст...
**Ключевые события:**
- Событие 1
- Событие 2
## Связи
- **Персонаж** — Тип связи: описание
## Способности
- **Способность:** описание
### Важные цитаты
> Цитата
### Примечания
- **Заметка:** ...
Обязательные секции: Базовая информация, Личность, Связи. Остальные — по необходимости.
5. Теги (tags)
Теги-категории (всегда первые):
- батоня — корневой тег вселенной, опционально
- Для карточек: персонаж, артефакт, локация, транспорт
- Для историй: история, основная / боковая, виньетка, сборник
Теги персонажей: Имя персонажа как в карточке, через дефис: Дядя-Леопольд, Кот-Семёнок, Пан-Коцкий, Мужик-не-жаркий.
Теги-контекст: абсурд, песня, медицина, борщ, джакузи — любые по смыслу, короткие, с маленькой буквы или через дефис.
Теги пишутся списком:
tags:
- батоня
- история
- боковая
- виньетка
- Леопольд
- Мужик-не-жаркий
- песня
- абсурд
6. Оформление цитат внутри текста
- Эпиграф (в начале истории):
> Текст - Цитата персонажа внутри текста:
— Реплика, — сказал Персонаж. - Мысль (несобственно-прямая речь): обычный текст от автора, без кавычек.
- Названия артефактов/документов/операций: в кавычках «» или
вики-ссылкав markdown. - Песни/стихи внутри текста: курсив
*текст*внутри кавычек диалога.
7. Именование файлов
UPPERCASE, разделитель_(подчёркивание).- Только кириллица, латиница и цифры.
- Без пробелов, без дефисов в имени (дефисы только внутри слов типа «Сарай-Альфа»).
- Без знаков препинания, кроме подчёркивания.
- Расширение:
.md(строчные). - Пример:
ВИНЬЕТКА_МУЖИК_НЕ_ЖАРКИЙ.md
8. Общие правила оформления
- Кодировка: UTF-8 без BOM.
- Переводы строк: LF (Unix). Не CRLF.
- Максимальная длина строки в markdown: не ограничена (но абзацы разбивать логически).
- Между секциями — пустая строка.
- Перед H1/H2/H3 — пустая строка (кроме H1 сразу после frontmatter).
- Маркированные списки: только
-(дефис с пробелом). - Вложенные списки: отступ 2 пробела.
- В карточках: жирное поле (
**Поле:**) с последующим двоеточием и пробелом. - Без HTML в markdown-файлах (кроме специальных случаев в site/ сборщике).
- Международные названия (Warhammer 40k, Big Shaq и т.п.) — только если являются частью сюжета/отсылки, не в названиях файлов и не в тегах.