Merge pull request Gothic-Modding-Community#96 from Silver-Ore-Team/dev

[Union] `zBassMussic` plugin article
muczc1wek · Oct 20, 2023 · 287e4bf · 287e4bf
2 parents d7fd93f + f565b25
commit 287e4bf
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/zengin/music.md b/docs/zengin/music.md
@@ -18,3 +18,7 @@ The music directory contains these file types:
     - Patterns - fragments of tracks, that can be later merged, looped and superimposed on each other
 
 - `.sgt` - File with properly connected patterns - the final track
+
+## Alternative Music System
+
+The [zBassMusic](./union/plugins/zbassmusic.md) plugin replaces Zengin's default music library with the much newer BASS library. This allows, among other things, to play music in such formats as `.mp3` or `.ogg`, and to pack songs into `.vdf` and `.mod` archives.
diff --git a/docs/zengin/music.pl.md b/docs/zengin/music.pl.md
@@ -21,3 +21,7 @@ Katalog `Music` zawiera następujące typy plików:
     - Wzory (Patterns) - fragmenty utworów, które można później łączyć, zapętlać i nakładać na siebie.
 
 - `.sgt` - Plik z odpowiednio połączonymi wzorami (patternami) - końcowy utwór
+
+## Alternatywny System Muzyczny
+
+Plugin [zBassMusic](./union/plugins/zbassmusic.md) zastępuje domyślną bibliotekę muzyczną Zengina, dużo nowszą biblioteką BASS. Umożliwia to między innymi odtwarzanie muzyki w takich formatach jak `.mp3` lub `.ogg`, oraz pakownie utworów do archiwów `.vdf` i `.mod`.
diff --git a/docs/zengin/union/plugins/zbassmusic.md b/docs/zengin/union/plugins/zbassmusic.md
@@ -0,0 +1,19 @@
+# zBassMusic
+zBassMusic is a modern music system for Gothic I and Gothic II NotR based on [BASS Audio Library](https://www.un4seen.com/) made by [Silver Ore Team](https://github.com/Silver-Ore-Team). It replaces the old DirectMusic system to let the modders create music for Gothic as regular audio files instead of DirectMusic format.
+
+!!! Info
+    For the plugin documentation, visit the [github site](https://github.com/Silver-Ore-Team/zBassMusic) of a project. The documentation is build into the code.
+
+| Contacts ||
+|:---------| :--- |
+| Authors  | [:material-badge-account-horizontal: Silver Ore Team](https://github.com/Silver-Ore-Team) - [tehe](https://github.com/piotrmacha) |
+| GitHub   | [:material-github: zBassMusic](https://github.com/Silver-Ore-Team/zBassMusic)|
+| Discord  | [:simple-discord: Gothic Modding Community server](https://discord.gg/mCpS5b5SUY) |
+
+## Features
+
+- Music playback with modern audio formats like WAV, MP3, OGG
+- Out-of-the-box support for existing C_MUSICTHEME instances
+- Scriptable interface to take full control of music scheduling
+- Loading music files from VDFS volumes (excluding .sgt)
+- Backwards compatibility with DirectMusic .sgt files