diff --git a/docs/es.md b/docs/es.md new file mode 100644 index 0000000..f4e9f66 --- /dev/null +++ b/docs/es.md @@ -0,0 +1,87 @@ +# Music Pack — una banda sonora para tu juego + +**22 pistas de música** para exploración, combate y el menú principal. Reutiliza la banda sonora en los juegos de cthangover sin copiar el audio en cada mod de historia. + +![Tres contextos musicales: exploración, combate y menú principal](assets/playlists.png) + +## Lo que oye el jugador + +- **Exploración:** 8 pistas para escenas sin playlist propia, incluidos los mapas RPG. +- **Combate:** 12 pistas en la playlist `Battle`. La playlist de reserva `default` también incluye `Empty Save Room`: 13 en total. +- **Menú principal:** `Serpent's Lament`. + +> Music Pack aporta audio y playlists. No añade ubicaciones, misiones ni mecánicas de juego. + +## ¿Hay que configurar algo? + +Si tu juego ya usa Music Pack, no necesitas instalar ni seleccionar pistas individuales. La reproducción la lleva el sistema `audio_base`. + +El paquete lo usan el menú principal, Cthangover, la plantilla de novela y los juegos RPG del proyecto. No necesita el contenido de la historia del juego principal para cargar. + +## Cómo usarlo en tu juego + +1. Instala `music_pack` y su dependencia, `audio_base`. +2. Añade `music_pack>=1` a la lista `depends` existente en el `manifest.json` de tu mod de contenido. +3. Usa las playlists incluidas, o añade un archivo JSON bajo el directorio `music/playlists/` de tu mod para una selección propia. + +Ejemplo de dependencia: + +```jsonc +// Añade la dependencia a tu lista existente: +"depends": ["music_pack>=1"] +``` + +Ubicación de ejemplo para una playlist propia: + +```filestree +my_game/ +├── manifest.json +└── music/ + └── playlists/ + └── my_scene.json # Música para tu escena +``` + +Ejemplo de playlist para una escena llamada `my_scene`: + +```json +{ + "Scene": "my_scene", + "Musics": [ + { + "MusicType": "Ambient", + "MusicNames": ["Airborne Melody", "Twilight Interlude"] + } + ] +} +``` + +Usa los nombres de pista **sin la extensión `.ogg`**, respetando mayúsculas y espacios. Sustituye `my_scene` por el nombre de tu escena. + +## Playlists incluidas + +- `default` — exploración (`Ambient`) y música de combate de reserva (`Combat`). +- `Battle` — música de combate para ambos sistemas de batalla. +- `MainMenu` — el tema del menú principal. + +La playlist `town_entry` sigue en el mod de historia `cthangover_game` y no forma parte de este paquete. + +## Las 22 pistas + +### Exploración + +Abyssal Void · Airborne Melody · Binary Prelude · Cinders of Dawn · Melancholic Journey · Nebula Pulse Echoes · Quantum Archive · Twilight Interlude. + +### Combate y reserva de combate + +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. + +### Menú principal + +Serpent's Lament. + +## Si algo no suena + +- Comprueba que `music_pack` y `audio_base` estén instalados y activados. +- Revisa el volumen de la música en los ajustes del juego. +- Si solo una escena está afectada, revisa su playlist propia y los nombres exactos de las pistas. +- Un mod dependiente cargado después puede sustituir la selección musical para la misma escena y el mismo tipo de música. diff --git a/docs/ja.md b/docs/ja.md new file mode 100644 index 0000000..58f6332 --- /dev/null +++ b/docs/ja.md @@ -0,0 +1,87 @@ +# Music Pack — あなたのゲームのためのサウンドトラック + +探索・戦闘・メインメニューのための**22曲**。音声を物語 MOD ごとにコピーせずに、cthangover の複数のゲームでサウンドトラックを共用できます。 + +![3つの音楽の場面:探索、戦闘、メインメニュー](assets/playlists.png) + +## プレイヤーに聞こえるもの + +- **探索:** 専用プレイリストを持たないシーン(RPG マップを含む)のための8曲。 +- **戦闘:** プレイリスト `Battle` の12曲。予備の戦闘プレイリスト `default` には `Empty Save Room` も含まれ、計13曲になります。 +- **メインメニュー:** `Serpent's Lament`。 + +> Music Pack が提供するのは音声とプレイリストです。ロケーション・クエスト・ゲームプレイの仕組みは追加しません。 + +## 何か設定は必要か + +ゲームがすでに Music Pack を使っていれば、曲を個別にインストールしたり選んだりする必要はありません。再生は `audio_base` システムが担います。 + +このパックは、メインメニュー、Cthangover、ノベルテンプレート、プロジェクトの RPG ゲームが使っています。メインゲームの物語コンテンツを必要としません。 + +## 自分のゲームで使う + +1. `music_pack` とその依存関係 `audio_base` をインストールします。 +2. 自分のコンテンツ MOD の `manifest.json` にある既存の `depends` リストに `music_pack>=1` を追加します。 +3. 付属のプレイリストを使うか、独自の選曲なら自分の MOD の `music/playlists/` ディレクトリに JSON ファイルを追加します。 + +依存関係の例: + +```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` は物語 MOD `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` がインストールされ、有効になっているか確認してください。 +- ゲーム設定の音楽音量を確認してください。 +- 特定のシーンだけの問題なら、そのシーン専用のプレイリストと曲名の正確なつづりを確認してください。 +- 後から読み込まれた依存 MOD は、同じシーンと同じ音楽の種類について選曲を差し替えられます。 diff --git a/docs/ko.md b/docs/ko.md new file mode 100644 index 0000000..4a910fa --- /dev/null +++ b/docs/ko.md @@ -0,0 +1,87 @@ +# Music Pack — 게임을 위한 사운드트랙 + +탐험, 전투, 메인 메뉴를 위한 **22곡**. 오디오를 스토리 모드마다 복사하지 않고도 cthangover의 여러 게임이 사운드트랙을 함께 씁니다. + +![세 가지 음악 상황: 탐험, 전투, 메인 메뉴](assets/playlists.png) + +## 플레이어가 듣는 것 + +- **탐험:** 자체 재생 목록이 없는 장면을 위한 8곡. RPG 맵도 포함됩니다. +- **전투:** `Battle` 재생 목록의 12곡. 예비 전투 목록 `default`에는 `Empty Save Room`도 있어 총 13곡입니다. +- **메인 메뉴:** `Serpent's Lament`. + +> Music Pack은 오디오와 재생 목록을 제공합니다. 장소, 퀘스트, 게임 메커니즘은 추가하지 않습니다. + +## 설정이 필요한가 + +게임이 이미 Music Pack을 쓰고 있다면 곡을 따로 설치하거나 고를 필요가 없습니다. 재생은 `audio_base` 시스템이 맡습니다. + +이 팩은 메인 메뉴, Cthangover, 노벨 템플릿, 프로젝트의 RPG 게임이 사용합니다. 메인 게임의 스토리 콘텐츠 없이도 로드됩니다. + +## 내 게임에서 쓰기 + +1. `music_pack`과 그 의존성인 `audio_base`를 설치합니다. +2. 콘텐츠 모드의 `manifest.json`에 있는 기존 `depends` 목록에 `music_pack>=1`을 추가합니다. +3. 제공되는 재생 목록을 쓰거나, 직접 고른 곡을 쓰려면 자신의 모드의 `music/playlists/` 디렉터리에 JSON 파일을 추가합니다. + +의존성 예: + +```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`가 설치되어 있고 켜져 있는지 확인하세요. +- 게임 설정에서 음악 볼륨을 확인하세요. +- 한 장면만 문제라면 그 장면의 자체 재생 목록과 곡 이름의 정확한 철자를 확인하세요. +- 나중에 로드된 의존 모드는 같은 장면과 같은 음악 유형에 대해 곡 선택을 바꿀 수 있습니다. diff --git a/docs/vi.md b/docs/vi.md new file mode 100644 index 0000000..9808a9c --- /dev/null +++ b/docs/vi.md @@ -0,0 +1,87 @@ +# Music Pack — nhạc nền cho game của bạn + +**22 bản nhạc** cho khám phá, chiến đấu và menu chính. Dùng chung bản nhạc nền giữa các game cthangover mà không cần chép âm thanh vào từng mod cốt truyện. + +![Ba bối cảnh âm nhạc: khám phá, chiến đấu và menu chính](assets/playlists.png) + +## Người chơi nghe thấy gì + +- **Khám phá:** 8 bản nhạc cho các cảnh không có danh sách phát riêng, kể cả bản đồ RPG. +- **Chiến đấu:** 12 bản nhạc trong danh sách phát `Battle`. Danh sách dự phòng `default` cũng có `Empty Save Room`, tổng cộng 13 bản. +- **Menu chính:** `Serpent's Lament`. + +> Music Pack cung cấp âm thanh và danh sách phát. Nó không thêm địa điểm, nhiệm vụ hay cơ chế chơi. + +## Có cần cấu hình gì không + +Nếu game của bạn đã dùng Music Pack, bạn không cần cài hay chọn từng bản nhạc. Việc phát do hệ thống `audio_base` đảm nhiệm. + +Gói này được menu chính, Cthangover, mẫu tiểu thuyết và các game RPG của dự án dùng. Nó không cần nội dung cốt truyện của game chính mới chạy được. + +## Dùng trong game của bạn + +1. Cài `music_pack` và phần phụ thuộc của nó, `audio_base`. +2. Thêm `music_pack>=1` vào danh sách `depends` sẵn có trong `manifest.json` của mod nội dung. +3. Dùng các danh sách phát có sẵn, hoặc thêm một tệp JSON trong thư mục `music/playlists/` của mod nếu muốn tự chọn nhạc. + +Ví dụ về phụ thuộc: + +```jsonc +// Thêm phụ thuộc vào danh sách có sẵn: +"depends": ["music_pack>=1"] +``` + +Vị trí ví dụ cho một danh sách phát riêng: + +```filestree +my_game/ +├── manifest.json +└── music/ + └── playlists/ + └── my_scene.json # Nhạc cho cảnh của bạn +``` + +Ví dụ danh sách phát cho cảnh tên `my_scene`: + +```json +{ + "Scene": "my_scene", + "Musics": [ + { + "MusicType": "Ambient", + "MusicNames": ["Airborne Melody", "Twilight Interlude"] + } + ] +} +``` + +Tên bản nhạc viết **không có đuôi `.ogg`**, giữ nguyên chữ hoa chữ thường và khoảng trắng. Thay `my_scene` bằng tên cảnh của bạn. + +## Các danh sách phát có sẵn + +- `default` — nhạc khám phá (`Ambient`) và nhạc chiến đấu dự phòng (`Combat`). +- `Battle` — nhạc chiến đấu cho cả hai hệ thống chiến đấu. +- `MainMenu` — giai điệu menu chính. + +Danh sách phát `town_entry` vẫn nằm trong mod cốt truyện `cthangover_game` và không thuộc gói này. + +## Cả 22 bản nhạc + +### Khám phá + +Abyssal Void · Airborne Melody · Binary Prelude · Cinders of Dawn · Melancholic Journey · Nebula Pulse Echoes · Quantum Archive · Twilight Interlude. + +### Chiến đấu và danh sách dự phòng + +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. + +### Menu chính + +Serpent's Lament. + +## Khi nhạc không phát + +- Kiểm tra `music_pack` và `audio_base` đã được cài và bật. +- Kiểm tra âm lượng nhạc trong phần cài đặt của game. +- Nếu chỉ một cảnh bị ảnh hưởng, kiểm tra danh sách phát riêng của cảnh đó và tên chính xác của từng bản nhạc. +- Một mod phụ thuộc nạp sau có thể thay việc chọn nhạc cho cùng cảnh và cùng loại nhạc. diff --git a/docs/zh.md b/docs/zh.md new file mode 100644 index 0000000..0feae8b --- /dev/null +++ b/docs/zh.md @@ -0,0 +1,87 @@ +# Music Pack — 为你的游戏配乐 + +**22 首曲目**,覆盖探索、战斗和主菜单。在 cthangover 的各个游戏之间共用这套配乐,无需把音频复制进每个剧情模组。 + +![三种音乐情境:探索、战斗和主菜单](assets/playlists.png) + +## 玩家会听到什么 + +- **探索:** 8 首曲目,供没有专属播放列表的场景使用,包括 RPG 地图。 +- **战斗:** `Battle` 播放列表中的 12 首曲目。备用战斗列表 `default` 还包含 `Empty Save Room`,合计 13 首。 +- **主菜单:** `Serpent's Lament`。 + +> Music Pack 提供音频和播放列表,不添加地点、任务或玩法机制。 + +## 需要配置什么吗 + +如果你的游戏已经在用 Music Pack,就无需单独安装或挑选曲目。播放由 `audio_base` 系统负责。 + +主菜单、Cthangover、小说模板和项目的 RPG 游戏都在使用这个素材包。加载它不需要主游戏的剧情内容。 + +## 在自己的游戏中使用 + +1. 安装 `music_pack` 及其依赖 `audio_base`。 +2. 在内容模组 `manifest.json` 已有的 `depends` 列表中加入 `music_pack>=1`。 +3. 直接使用自带的播放列表,或者想自定义选曲时,在你模组的 `music/playlists/` 目录下添加一个 JSON 文件。 + +依赖示例: + +```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` 是否已安装并启用。 +- 检查游戏设置中的音乐音量。 +- 如果只有某个场景有问题,检查它自己的播放列表和确切的曲目名。 +- 后加载的依赖模组可以覆盖同一场景、同一音乐类型的选曲。 diff --git a/locale/en.properties b/locale/en.properties index 4b011dd..c730869 100644 --- a/locale/en.properties +++ b/locale/en.properties @@ -1,2 +1,2 @@ mod_music_pack_name = Music Pack -mod_music_pack_desc = Shared music for any game: 22 tracks with exploration, combat and main menu playlists. +mod_music_pack_desc = Shared music for any game: 22 tracks with exploration, combat and main menu playlists; a game can override playlists while keeping the track names. diff --git a/locale/es.properties b/locale/es.properties index fcb2a2f..9fbd561 100644 --- a/locale/es.properties +++ b/locale/es.properties @@ -1,2 +1,2 @@ mod_music_pack_name = Paquete de música -mod_music_pack_desc = Música compartida para cualquier juego: 22 pistas con listas de exploración, combate y menú principal. +mod_music_pack_desc = Música compartida para cualquier juego: 22 pistas con listas de exploración, combate y menú principal; un juego puede sustituir las playlists conservando los nombres de las pistas. diff --git a/locale/ja.properties b/locale/ja.properties index 6dadc48..3e1f45a 100644 --- a/locale/ja.properties +++ b/locale/ja.properties @@ -1,2 +1,2 @@ mod_music_pack_name = 音楽パック -mod_music_pack_desc = どのゲームでも使える共通の音楽:22 曲と探索・戦闘・メインメニューのプレイリスト。 +mod_music_pack_desc = どのゲームでも使える共通の音楽:探索・戦闘・メインメニューのプレイリスト付き 22 曲。ゲーム側は曲名を保ったままプレイリストを差し替えられます。 diff --git a/locale/ko.properties b/locale/ko.properties index c3bc281..0fdd60e 100644 --- a/locale/ko.properties +++ b/locale/ko.properties @@ -1,2 +1,2 @@ mod_music_pack_name = 음악 팩 -mod_music_pack_desc = 모든 게임에서 사용할 수 있는 공용 음악: 22곡과 탐험, 전투, 메인 메뉴 재생 목록. +mod_music_pack_desc = 모든 게임이 함께 쓰는 공용 음악: 탐험, 전투, 메인 메뉴 재생 목록을 갖춘 22곡. 게임은 곡 이름을 유지한 채 재생 목록을 바꿀 수 있습니다. diff --git a/locale/vi.properties b/locale/vi.properties index 57b12bf..79702ba 100644 --- a/locale/vi.properties +++ b/locale/vi.properties @@ -1,2 +1,2 @@ mod_music_pack_name = Gói nhạc -mod_music_pack_desc = Nhạc dùng chung cho mọi game: 22 bản nhạc với danh sách phát khám phá, chiến đấu và menu chính. +mod_music_pack_desc = Nhạc dùng chung cho mọi game: 22 bản nhạc với danh sách phát khám phá, chiến đấu và menu chính; game có thể thay danh sách phát mà vẫn giữ nguyên tên bản nhạc. diff --git a/locale/zh.properties b/locale/zh.properties index 72ad331..b3150d1 100644 --- a/locale/zh.properties +++ b/locale/zh.properties @@ -1,2 +1,2 @@ mod_music_pack_name = 音乐包 -mod_music_pack_desc = 适用于任何游戏的共享音乐:22 首曲目,以及探索、战斗和主菜单播放列表。 +mod_music_pack_desc = 适用于任何游戏的共享音乐:22 首曲目,附探索、战斗和主菜单播放列表;游戏可以覆盖播放列表,同时保留曲目名。 diff --git a/manifest.json b/manifest.json index ac3b92d..a553a86 100644 --- a/manifest.json +++ b/manifest.json @@ -3,7 +3,7 @@ "name": "Music Pack", "version": "1.0.0", "author": "ct", - "description": "Reusable soundtrack for any game: 22 Ogg Vorbis tracks with default exploration, combat and main menu playlists. Games can override playlists while keeping the shared track names.", + "description": "Shared music for any game: 22 tracks with exploration, combat and main menu playlists; a game can override playlists while keeping the track names.", "category": "audio", "depends": ["audio_base>=1"] }