]> git.seodisparate.com - TurnBasedMinecraftMod/commitdiff
Update docs
authorStephen Seo <seo.disparate@gmail.com>
Tue, 29 Oct 2024 10:14:33 +0000 (19:14 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Tue, 29 Oct 2024 10:17:34 +0000 (19:17 +0900)
tbmm-docs/docs/client_config.md
tbmm-docs/docs/server_config.md
tbmm-docs/mkdocs.yml

index 9f2491e81da4e49f051e513cc44f9f8cfd72800d..4af7c203d8a8cc6388a3956ff511a01d4f12504c 100644 (file)
@@ -22,3 +22,24 @@ triggers the "battle" music or the "silly" music.
 battle required to play silly music. This means if the setting is 49%, and there
 is one player, one zombie, and two sheep in battle, then the game will play
 silly music (since 50% of the combatants are sheep and is greater than 49%).
+
+## Battle/Silly Music
+
+!!! note
+    The TurnBasedMinecraftMod (TBMM) configuration folders need to be
+    generated. Run the mod once to generate them, then close Minecraft.
+
+There are two folders in the `.minecraft/config/TurnBasedMinecraft/Music/`
+directory: `battle` and `silly`.
+
+Place your music files in those folders, and the appropriate music will play
+depending on if the battle is with `silly` mobs or not.
+
+!!! note
+    A random song will be picked in the `battle` folder on `battle` music, and
+    in the `silly` music folder on `silly` music.
+
+!!! warning
+    It is recommended to use .ogg Vorbis files for music. There is support for
+    .mp3 files, but currently .ogg Vorbis files are more stable in this mod.
+    Note that .ogg Opus files are NOT supported, but .ogg Vorbis files are.
index 652bbc23370e349cb7c8bb39b05e1813b239f30f..e236b44c1c4e6b5bdc8c56b9ae828aa094364913 100644 (file)
@@ -8,8 +8,9 @@ In this text area, yellow texts are setting names, green texts are setting
 values that can be set when clicked on, and dark-green texts are settings that
 display more settings when clicked on.
 
-You can hover/click these texts by pressing the "t" key to open the chatbox, and
-using the mouse.
+!!! note
+    You can hover/click these texts by pressing the "t" key to open the chatbox,
+    and using the mouse.
 
 ![tbm-server-edit info when hovered](tbm-server-edit-hover.png)
 
@@ -58,8 +59,9 @@ attack instead of fleeing battle.
 
 ![mob setting decision attack 100%](tbm-edit-decision-attack.png)
 
-Make sure to click on "Finished Editing" to save changes to the server-side
-config.
+!!! note
+    Make sure to click on "Finished Editing" to save changes to the server-side
+    config.
 
 Note that for sheep to enter battle, they must be removed from the "ignore
 battle categories" setting (remove the "passive" category).
@@ -84,8 +86,10 @@ Hit the named mob to start the editing process.
 ![tbm-edit custom editing](tbm-edit-custom-editing.jpg)
 
 Make your changes and click on "Finished Editing", and any mob with that exact
-name will have these battle settings applied. Note that these settings are also
-in the server-side config.
+name will have these battle settings applied.
+
+!!! note
+    These settings are also in the server-side config.
 
 ## Other Things to Know
 
@@ -94,3 +98,7 @@ defaults. This is due to new mob entries in the settings. Check the
 `.minecraft/config` folder (or `config` folder on the server) to see that the
 old settings file was renamed and the new settings file is in its place. You may
 have to compare the files to keep the settings you want.
+
+## Frequently Asked Questions
+
+[FAQ](https://github.com/Stephen-Seo/TurnBasedMinecraftMod/blob/neoforge/FAQ.md)
index e77359a79afa1a521eb1c22a4fb5b1893b2bb32d..f3164f75f77c717dda9f21304b40beedc90ad5ef 100644 (file)
@@ -3,3 +3,5 @@ theme:
     name: mkdocs
     color_mode: dark
     user_color_mode_toggle: true
+markdown_extensions:
+  - admonition