docs: update docs bootstrap

Silver-Ore-Team · May 23, 2024 · f113942 · f113942
1 parent 4178924
commit f113942
Show file tree

Hide file tree

Showing 90 changed files with 40,880 additions and 7 deletions.
diff --git a/docs/docs/reference/classes/C_MUSICTHEME.md b/docs/docs/reference/classes/C_MUSICTHEME.md
@@ -0,0 +1 @@
+# C_MUSICTHEME
diff --git a/docs/docs/reference/externals/index.md b/docs/docs/reference/externals/index.md
@@ -0,0 +1,32 @@
+# Externals
+
+<div class="zbassmusic-externals" markdown>
+
+## <a href="#bassmusic_play">BassMusic_Play</a>
+
+Triggers an event to start a new music theme.
+
+```dae
+func void BassMusic_Play(var string id)
+```
+
+**Parameters**
+
+* `#!dae var string id`<br>
+  Symbol name of the music theme ([C_MUSICTHEME](../classes/C_MUSICTHEME.md)) to play
+
+## BassMusic_SetFullScriptControl
+
+...
+
+```dae
+func void BassMusic_SetFullScriptControl(int enabled) {}
+```
+
+**Parameters**
+
+* `#!dae var int enabled`<br>
+  Boolean value if full script control should be enabled.
+
+
+</div>
diff --git a/docs/docs/reference/globals/index.md b/docs/docs/reference/globals/index.md
@@ -0,0 +1,5 @@
+# Globals
+
+<div id="BassMusic_ActiveThemeFilename"></div>
+
+## `var string BassMusic_ActiveThemeFilename`
diff --git a/docs/docs/reference/options/index.md b/docs/docs/reference/options/index.md
@@ -0,0 +1,6 @@
+# Options (.ini)
+
+## [BassMusic]
+
+<div id="LoggerLevelUnion"></div>
+### LoggerLevelUnion
diff --git a/docs/docs/roadmap/index.md b/docs/docs/roadmap/index.md
@@ -4,7 +4,7 @@
 
 ### Core functions
 !!! success "Music Engine (v0.1.0)"
-    Music engine capable of replacing original DM system in the scope of playing audio and switching songs based on game events.
+    Music engine capable of replacing the original DM system in the scope of playing audio and switching songs based on game events.
 
 !!! success "Daedalus API for controlling playback (v0.1.0)"
     External functions to take control over music scheduling in Daedalus scripts. API is stable and shouldn't introduce any breaking changes.

diff --git a/docs/docs/stylesheets/extra.css b/docs/docs/stylesheets/extra.css
@@ -26,4 +26,31 @@
 
 .zbassmusic-contributos {
     margin-top: 1rem;
+}
+
+.md-typeset code {
+    font-size: 0.8rem;
+}
+
+.zbassmusic-externals h2 {
+    font-weight: bold;
+    border-bottom: 1px solid #666;
+}
+
+.zbassmusic-externals h2 a {
+    color: rgba(226, 228, 233, 0.82);
+
+}
+
+.zbassmusic-externals ul code {
+    line-height: 2;
+}
+
+.zbassmusic-externals > p:has(> strong) {
+    margin-top: 1.5Srem;
+    margin-bottom: 0;
+}
+
+.zbassmusic-externals > ul {
+    margin-top: 0.5rem;
 }
diff --git a/docs/docs/user-guide/define-music.md b/docs/docs/user-guide/define-music.md
diff --git a/docs/docs/user-guide/index.md b/docs/docs/user-guide/index.md
@@ -1 +1,12 @@
-# User Guide
+# User Guide
+
+User Guide is the zBassMusic documentation dedicated to people who would like to include the plugin in their mod and use it as a music system. 
+The articles are written in guide style to help you understand the mechanics behind the plugin. For pure reference of available options, you
+can refer to the [Reference](../reference/index.md) page.
+
+The available docs are:
+
+* [Getting Started](getting-started/index.md) - basics of zBassMusic, plugin loading, music definition, simple crossfade effect
+* [Transition Scheduler](transition-scheduler/index.md) - configuration of advance transitions between songs
+* [Scripting (Daedalus)](scripting/index.md) - using zBassMusic in the scripts, creating a custom scheduler 
+* [Debugging](debugging/index.md) - helpful tips for debugging plugin problems or working with a debugger
diff --git a/docs/docs/user-guide/transition-scheduler/on-beat.md b/docs/docs/user-guide/transition-scheduler/on-beat.md
@@ -1 +1 @@
-# On Beat Transition
+# OnBeat Transition
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -20,10 +20,20 @@ nav:
         - user-guide/scripting/custom-scheduler.md
       - Debugging:
         - user-guide/debugging/index.md
-  - Configuration: 
-      - configuration/index.md
   - Reference: 
       - reference/index.md
+      - Classes:
+        - reference/classes/C_MUSICTHEME.md
+      - Globals:
+        - reference/globals/index.md
+        - BassMusic_ActiveThemeFilename: reference/globals/#bassmusic_activethemefilename
+      - Externals:
+        - reference/externals/index.md
+        - BassMusic_Play: reference/externals/#bassmusic_play
+      - Options (.ini):
+        - reference/options/index.md
+        - '[BassMusic]':
+          - LoggerLevelUnion: reference/options/#loggerlevelunion
   - Developer Guide: 
       - developer-guide/index.md
       - Environment:
@@ -60,7 +70,7 @@ theme:
     - content.code.select
     - content.code.annotate 
     - navigation.indexes 
-    - toc.integrate 
+    # - toc.integrate 
     - navigation.top
   icon:
     annotation: material/record-circle

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 mkdocs
 mkdocs-material
+git+https://github.com/kamilkrzyskow/gothic-lexer.git
diff --git a/docs/site/404.html b/docs/site/404.html
diff --git a/docs/site/assets/images/favicon.png b/docs/site/assets/images/favicon.png
diff --git a/docs/site/assets/javascripts/bundle.081f42fc.min.js b/docs/site/assets/javascripts/bundle.081f42fc.min.js
diff --git a/docs/site/assets/javascripts/bundle.081f42fc.min.js.map b/docs/site/assets/javascripts/bundle.081f42fc.min.js.map
diff --git a/docs/site/assets/javascripts/lunr/min/lunr.ar.min.js b/docs/site/assets/javascripts/lunr/min/lunr.ar.min.js
diff --git a/docs/site/assets/javascripts/lunr/min/lunr.da.min.js b/docs/site/assets/javascripts/lunr/min/lunr.da.min.js
diff --git a/docs/site/assets/javascripts/lunr/min/lunr.de.min.js b/docs/site/assets/javascripts/lunr/min/lunr.de.min.js