commit 7511d0ff700f69e3f88a4696cfd3ce1df0779122 Author: iisaev Date: Wed Oct 28 12:55:04 2026 +0100 Document Music Pack in Russian and English diff --git a/docs/assets/playlists.png b/docs/assets/playlists.png new file mode 100644 index 0000000..c75c859 Binary files /dev/null and b/docs/assets/playlists.png differ diff --git a/docs/assets/playlists.svg b/docs/assets/playlists.svg new file mode 100644 index 0000000..17cb77a --- /dev/null +++ b/docs/assets/playlists.svg @@ -0,0 +1 @@ +MUSIC PACK22 TRACKS / 3 CONTEXTSEXPLORATION08AmbientAbyssal VoidAirborne MelodyCOMBAT12 + 1CombatCrimson EchoesEmpty Save RoomMAIN MENU01AmbientSerpent’s LamentMainMenu \ No newline at end of file diff --git a/docs/en.md b/docs/en.md new file mode 100644 index 0000000..38c8836 --- /dev/null +++ b/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. diff --git a/docs/ru.md b/docs/ru.md new file mode 100644 index 0000000..4e4fa17 --- /dev/null +++ b/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` установлены и включены. +- Проверьте громкость музыки в настройках игры. +- Если проблема только в одной сцене, проверьте её собственный плейлист и точные имена треков. +- Более поздний зависимый мод может заменить музыкальную подборку для той же сцены и типа музыки.