From 35e24f08beb0f6dbf1b625ad12af59b95d5c3df9 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Tue, 29 Oct 2024 19:14:33 +0900 Subject: [PATCH] Update docs --- tbmm-docs/docs/client_config.md | 21 +++++++++++++++++++++ tbmm-docs/docs/server_config.md | 20 ++++++++++++++------ tbmm-docs/mkdocs.yml | 2 ++ 3 files changed, 37 insertions(+), 6 deletions(-) diff --git a/tbmm-docs/docs/client_config.md b/tbmm-docs/docs/client_config.md index 9f2491e..4af7c20 100644 --- a/tbmm-docs/docs/client_config.md +++ b/tbmm-docs/docs/client_config.md @@ -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. diff --git a/tbmm-docs/docs/server_config.md b/tbmm-docs/docs/server_config.md index 652bbc2..e236b44 100644 --- a/tbmm-docs/docs/server_config.md +++ b/tbmm-docs/docs/server_config.md @@ -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) diff --git a/tbmm-docs/mkdocs.yml b/tbmm-docs/mkdocs.yml index e77359a..f3164f7 100644 --- a/tbmm-docs/mkdocs.yml +++ b/tbmm-docs/mkdocs.yml @@ -3,3 +3,5 @@ theme: name: mkdocs color_mode: dark user_color_mode_toggle: true +markdown_extensions: + - admonition