From 68aef29affc2faa72df9e78beb7cabd45836fbd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Mastalerz?= Date: Thu, 15 Aug 2024 11:00:12 +0200 Subject: [PATCH] Doc modification + info about slashes in filename if using VDFS --- docs/docs/user-guide/concepts/index.md | 8 ++------ docs/docs/user-guide/getting-started/index.md | 2 +- docs/docs/user-guide/theme-definition/basstheme.md | 3 +++ 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/docs/user-guide/concepts/index.md b/docs/docs/user-guide/concepts/index.md index c00eb11..f234237 100644 --- a/docs/docs/user-guide/concepts/index.md +++ b/docs/docs/user-guide/concepts/index.md @@ -31,11 +31,7 @@ The area where a song plays. Music zone are created using Spacer and a song may Virtual file system used by Gothic to load assets. zBassMusic supports it fully, and we may reference some directory as: -### Physical +* Physical - Located on your computer hard drive in the Gothic installation directory. -Located on your computer hard drive in the Gothic installation directory - -### Virtual - -A *.vdf or *.mod file loaded by Gothic, they contain the same directory structure as physical, +* Virtual - A *.vdf or *.mod file loaded by Gothic, they contain the same directory structure as physical, but all files are inside the file (like a ZIP archive). \ No newline at end of file diff --git a/docs/docs/user-guide/getting-started/index.md b/docs/docs/user-guide/getting-started/index.md index c528ef6..ab5afb7 100644 --- a/docs/docs/user-guide/getting-started/index.md +++ b/docs/docs/user-guide/getting-started/index.md @@ -37,7 +37,7 @@ Alternatively, below you should see the newest release: -There are different kinds of files for different use cases. +There are different kinds of files for different use cases: * `zBassMusic-{version}.zip`
ZIP archive with zBassMusic.dll and its dependencies. Use for loading the plugin directly from the disk. diff --git a/docs/docs/user-guide/theme-definition/basstheme.md b/docs/docs/user-guide/theme-definition/basstheme.md index 0161edc..36027f0 100644 --- a/docs/docs/user-guide/theme-definition/basstheme.md +++ b/docs/docs/user-guide/theme-definition/basstheme.md @@ -75,3 +75,6 @@ The audio `theme` field must be the same as theme's `name` to assign it for this The audio instance must use `DEFAULT` as a `type`, in order to play. In the future, we may introduce features that use multiple files per theme, hence this separation. +The `filename` field contains the name of the file that should be played in the custom theme. +Note that when using Union, only the filename should be provided, regardless of whether it is located in subdirectories +of the Music folder. \ No newline at end of file