Document Music Pack in Russian and English

docs/assets/playlists.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="430" viewBox="0 0 1200 430"><rect width="1200" height="430" rx="22" fill="#151923"/><text x="36" y="52" fill="#edf0f7" font-family="Noto Sans,sans-serif" font-size="26" font-weight="bold">MUSIC PACK</text><text x="1164" y="50" fill="#a2adbd" font-family="Noto Sans,sans-serif" font-size="16" text-anchor="end">22 TRACKS / 3 CONTEXTS</text><rect x="36" y="82" width="364" height="312" rx="14" fill="#202634"/><rect x="36" y="82" width="364" height="4" fill="#54d5bc"/><g font-family="Noto Sans,sans-serif"><text x="60" y="123" fill="#54d5bc" font-size="15" font-weight="bold">EXPLORATION</text><text x="60" y="191" fill="#edf0f7" font-size="48" font-weight="bold">08</text><text x="60" y="221" fill="#a2adbd" font-size="15">Ambient</text><text x="60" y="340" fill="#d3dbe8" font-size="15">Abyssal Void</text><text x="60" y="365" fill="#8896ac" font-size="14">Airborne Melody</text></g><rect x="60" y="275" width="5" height="8" rx="2" fill="#54d5bc" opacity=".8"/><rect x="70" y="253.4395605116725" width="5" height="51.12087897665498" rx="2" fill="#54d5bc" opacity=".8"/><rect x="80" y="265.86364267826906" width="5" height="26.272714643461857" rx="2" fill="#54d5bc" opacity=".8"/><rect x="90" y="267.66024455584727" width="5" height="22.67951088830548" rx="2" fill="#54d5bc" opacity=".8"/><rect x="100" y="273.0774975494071" width="5" height="11.845004901185778" rx="2" fill="#54d5bc" opacity=".8"/><rect x="110" y="273.57716070526385" width="5" height="10.845678589472353" rx="2" fill="#54d5bc" opacity=".8"/><rect x="120" y="260.511880467296" width="5" height="36.97623906540799" rx="2" fill="#54d5bc" opacity=".8"/><rect x="130" y="268.4774432619182" width="5" height="21.04511347616362" rx="2" fill="#54d5bc" opacity=".8"/><rect x="140" y="255.45884533778445" width="5" height="47.082309324431094" rx="2" fill="#54d5bc" opacity=".8"/><rect x="150" y="257.03601555220627" width="5" height="43.92796889558744" rx="2" fill="#54d5bc" opacity=".8"/><rect x="160" y="266.44775174584777" width="5" height="25.104496508304432" rx="2" fill="#54d5bc" opacity=".8"/><rect x="170" y="260.81156290645447" width="5" height="36.37687418709106" rx="2" fill="#54d5bc" opacity=".8"/><rect x="180" y="274.30425681319156" width="5" height="9.39148637361691" rx="2" fill="#54d5bc" opacity=".8"/><rect x="190" y="272.8268289897265" width="5" height="12.346342020547043" rx="2" fill="#54d5bc" opacity=".8"/><rect x="200" y="268.45684513595563" width="5" height="21.08630972808875" rx="2" fill="#54d5bc" opacity=".8"/><rect x="210" y="264.2013381185981" width="5" height="29.597323762803832" rx="2" fill="#54d5bc" opacity=".8"/><rect x="220" y="254.162962430974" width="5" height="49.67407513805198" rx="2" fill="#54d5bc" opacity=".8"/><rect x="230" y="272.3927822506395" width="5" height="13.214435498720928" rx="2" fill="#54d5bc" opacity=".8"/><rect x="240" y="252.97580091138443" width="5" height="52.04839817723115" rx="2" fill="#54d5bc" opacity=".8"/><rect x="250" y="267.6139835678976" width="5" height="22.772032864204753" rx="2" fill="#54d5bc" opacity=".8"/><rect x="260" y="266.97396870614966" width="5" height="24.052062587700696" rx="2" fill="#54d5bc" opacity=".8"/><rect x="270" y="273.3344310906206" width="5" height="11.331137818758803" rx="2" fill="#54d5bc" opacity=".8"/><rect x="280" y="272.8336128641182" width="5" height="12.33277427176363" rx="2" fill="#54d5bc" opacity=".8"/><rect x="290" y="260.3828345732753" width="5" height="37.234330853449336" rx="2" fill="#54d5bc" opacity=".8"/><rect x="300" y="270.6022915462838" width="5" height="16.79541690743236" rx="2" fill="#54d5bc" opacity=".8"/><rect x="310" y="254.11028453682206" width="5" height="49.77943092635584" rx="2" fill="#54d5bc" opacity=".8"/><rect x="320" y="258.82234351947534" width="5" height="40.35531296104934" rx="2" fill="#54d5bc" opacity=".8"/><rect x="330" y="264.53677279528966" width="5" height="28.926454409420636" rx="2" fill="#54d5bc" opacity=".8"/><rect x="340" y="261.27523553438834" width="5" height="35.44952893122337" rx="2" fill="#54d5bc" opacity=".8"/><rect x="350" y="274.9944053908836" width="5" height="8.011189218232706" rx="2" fill="#54d5bc" opacity=".8"/><rect x="360" y="272.5889071573342" width="5" height="12.822185685331657" rx="2" fill="#54d5bc" opacity=".8"/><rect x="418" y="82" width="364" height="312" rx="14" fill="#202634"/><rect x="418" y="82" width="364" height="4" fill="#ee9c73"/><g font-family="Noto Sans,sans-serif"><text x="442" y="123" fill="#ee9c73" font-size="15" font-weight="bold">COMBAT</text><text x="442" y="191" fill="#edf0f7" font-size="48" font-weight="bold">12 + 1</text><text x="442" y="221" fill="#a2adbd" font-size="15">Combat</text><text x="442" y="340" fill="#d3dbe8" font-size="15">Crimson Echoes</text><text x="442" y="365" fill="#8896ac" font-size="14">Empty Save Room</text></g><rect x="442" y="254.8046963646105" width="5" height="48.39060727077903" rx="2" fill="#ee9c73" opacity=".8"/><rect x="452" y="258.3Line truncated

docs/en.md

@@ -0,0 +1,87 @@
+# Music Pack — a soundtrack for your game
+
+**22 music tracks** for exploration, combat and the main menu. Reuse the soundtrack across cthangover games without copying the audio into every story mod.
+
+![Three music contexts: exploration, combat and the main menu](assets/playlists.png)
+
+## What players hear
+
+- **Exploration:** 8 tracks for scenes without their own playlist, including RPG maps.
+- **Combat:** 12 tracks in the `Battle` playlist. The fallback `default` combat playlist also includes `Empty Save Room`, for a total of 13.
+- **Main menu:** `Serpent's Lament`.
+
+> Music Pack provides audio and playlists. It does not add locations, quests or gameplay mechanics.
+
+## Do I need to configure anything?
+
+If your game already uses Music Pack, you do not need to install or select individual tracks. The `audio_base` system handles playback.
+
+The pack is used by the main menu, Cthangover, the novel template and the project's RPG games. It does not require the main game's story content to load.
+
+## Using it in your own game
+
+1. Install `music_pack` and its dependency, `audio_base`.
+2. Add `music_pack>=1` to the existing `depends` list in your content mod's `manifest.json`.
+3. Use the supplied playlists, or add a JSON file under your mod's `music/playlists/` directory for a custom selection.
+
+Dependency example:
+
+```jsonc
+// Add the dependency to your existing list:
+"depends": ["music_pack>=1"]
+```
+
+Example location for a custom playlist:
+
+```filestree
+my_game/
+├── manifest.json
+└── music/
+    └── playlists/
+        └── my_scene.json  # Music for your scene
+```
+
+Example playlist for a scene named `my_scene`:
+
+```json
+{
+  "Scene": "my_scene",
+  "Musics": [
+    {
+      "MusicType": "Ambient",
+      "MusicNames": ["Airborne Melody", "Twilight Interlude"]
+    }
+  ]
+}
+```
+
+Use track names **without the `.ogg` extension**, preserving capitalization and spaces. Replace `my_scene` with your scene's name.
+
+## Included playlists
+
+- `default` — exploration (`Ambient`) and fallback combat music (`Combat`).
+- `Battle` — combat music for both battle systems.
+- `MainMenu` — the main menu theme.
+
+The `town_entry` playlist remains in the story mod `cthangover_game` and is not part of this pack.
+
+## All 22 tracks
+
+### Exploration
+
+Abyssal Void · Airborne Melody · Binary Prelude · Cinders of Dawn · Melancholic Journey · Nebula Pulse Echoes · Quantum Archive · Twilight Interlude.
+
+### Combat and fallback combat
+
+Aura of Decay · Circuit Dreams II · Crimson Echoes · Crimson Horizon · Empty Save Room · Glass Symphony · Hex Doom Cart · Iron Resonance · Iron Resonance II · Luminous Twilight · Rusty Frequencies · Skull Resonance · Venom's Embrace.
+
+### Main menu
+
+Serpent's Lament.
+
+## Troubleshooting
+
+- Check that `music_pack` and `audio_base` are installed and enabled.
+- Check music volume in the game settings.
+- If only one scene is affected, check its custom playlist and exact track names.
+- A later dependent mod can replace the music selection for the same scene and music type.

docs/ru.md

@@ -0,0 +1,87 @@
+# Music Pack — музыка для вашей игры
+
+**22 музыкальные композиции** для исследования мира, сражений и главного меню. Набор можно использовать в разных играх на cthangover, не копируя музыку в каждый сюжетный мод.
+
+![Три музыкальных контекста: исследование, бой и главное меню](assets/playlists.png)
+
+## Что услышит игрок
+
+- **Исследование мира:** 8 композиций для сцен без собственного плейлиста, в том числе RPG-карт.
+- **Сражения:** 12 композиций в плейлисте `Battle`. В запасном боевом списке `default` также есть `Empty Save Room` — всего 13.
+- **Главное меню:** `Serpent's Lament`.
+
+> Music Pack содержит музыку и плейлисты. Новых локаций, заданий и игровых механик он не добавляет.
+
+## Нужно ли что-то настраивать
+
+Если ваша игра уже использует Music Pack, устанавливать отдельные треки или выбирать их вручную не требуется. Музыку воспроизводит система `audio_base`.
+
+Набор используется главным меню, Cthangover, шаблоном новеллы и RPG-играми проекта. Он не требует загрузки сюжета основной игры.
+
+## Подключение к своей игре
+
+1. Установите `music_pack` и его зависимость `audio_base`.
+2. В `manifest.json` своего контентного мода добавьте зависимость `music_pack>=1` к уже существующему списку `depends`.
+3. Для сцен без особых требований используйте готовые плейлисты. Для собственной подборки добавьте JSON-файл в `music/playlists/` вашего мода.
+
+Пример зависимости:
+
+```jsonc
+// Добавьте зависимость к существующему списку:
+"depends": ["music_pack>=1"]
+```
+
+Пример размещения собственного плейлиста:
+
+```filestree
+my_game/
+├── manifest.json
+└── music/
+    └── playlists/
+        └── my_scene.json  # Музыка вашей сцены
+```
+
+Пример собственного плейлиста для сцены `my_scene`:
+
+```json
+{
+  "Scene": "my_scene",
+  "Musics": [
+    {
+      "MusicType": "Ambient",
+      "MusicNames": ["Airborne Melody", "Twilight Interlude"]
+    }
+  ]
+}
+```
+
+Имена композиций указываются **без расширения `.ogg`**, с точным регистром и пробелами. Вместо `my_scene` укажите имя своей сцены.
+
+## Какие плейлисты входят
+
+- `default` — музыка исследования (`Ambient`) и запасная музыка боя (`Combat`).
+- `Battle` — боевая музыка для обеих боевых систем.
+- `MainMenu` — тема главного меню.
+
+Плейлист `town_entry` принадлежит сюжетному моду `cthangover_game` и в этот набор не входит.
+
+## Все 22 композиции
+
+### Исследование
+
+Abyssal Void · Airborne Melody · Binary Prelude · Cinders of Dawn · Melancholic Journey · Nebula Pulse Echoes · Quantum Archive · Twilight Interlude.
+
+### Бой и запасной боевой список
+
+Aura of Decay · Circuit Dreams II · Crimson Echoes · Crimson Horizon · Empty Save Room · Glass Symphony · Hex Doom Cart · Iron Resonance · Iron Resonance II · Luminous Twilight · Rusty Frequencies · Skull Resonance · Venom's Embrace.
+
+### Главное меню
+
+Serpent's Lament.
+
+## Если музыка не играет
+
+- Проверьте, что `music_pack` и `audio_base` установлены и включены.
+- Проверьте громкость музыки в настройках игры.
+- Если проблема только в одной сцене, проверьте её собственный плейлист и точные имена треков.
+- Более поздний зависимый мод может заменить музыкальную подборку для той же сцены и типа музыки.