Deployed 35e24f0 with MkDocs version: 1.6.1

This commit is contained in:
Stephen Seo 2024-10-29 10:21:00 +00:00
parent 3c96586e77
commit 858debb3dc
4 changed files with 48 additions and 8 deletions

View file

@ -111,6 +111,10 @@
<li class="nav-item" data-bs-level="1"><a href="#client-side-config" class="nav-link">Client-side Config</a> <li class="nav-item" data-bs-level="1"><a href="#client-side-config" class="nav-link">Client-side Config</a>
<ul class="nav flex-column"> <ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#battlesilly-music" class="nav-link">Battle/Silly Music</a>
<ul class="nav flex-column">
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -132,7 +136,28 @@ triggers the "battle" music or the "silly" music.</p>
<p>"Silly Music Threshold" determines the percentage of silly-category-mobs in <p>"Silly Music Threshold" determines the percentage of silly-category-mobs in
battle required to play silly music. This means if the setting is 49%, and there 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 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%).</p></div> silly music (since 50% of the combatants are sheep and is greater than 49%).</p>
<h2 id="battlesilly-music">Battle/Silly Music</h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The TurnBasedMinecraftMod (TBMM) configuration folders need to be
generated. Run the mod once to generate them, then close Minecraft.</p>
</div>
<p>There are two folders in the <code>.minecraft/config/TurnBasedMinecraft/Music/</code>
directory: <code>battle</code> and <code>silly</code>.</p>
<p>Place your music files in those folders, and the appropriate music will play
depending on if the battle is with <code>silly</code> mobs or not.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A random song will be picked in the <code>battle</code> folder on <code>battle</code> music, and
in the <code>silly</code> music folder on <code>silly</code> music.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>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.</p>
</div></div>
</div> </div>
</div> </div>

View file

@ -209,5 +209,5 @@
<!-- <!--
MkDocs version : 1.6.1 MkDocs version : 1.6.1
Build Date UTC : 2024-10-29 09:54:21.741213+00:00 Build Date UTC : 2024-10-29 10:21:00.010581+00:00
--> -->

File diff suppressed because one or more lines are too long

View file

@ -122,6 +122,10 @@
<li class="nav-item" data-bs-level="2"><a href="#other-things-to-know" class="nav-link">Other Things to Know</a> <li class="nav-item" data-bs-level="2"><a href="#other-things-to-know" class="nav-link">Other Things to Know</a>
<ul class="nav flex-column"> <ul class="nav flex-column">
</ul> </ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#frequently-asked-questions" class="nav-link">Frequently Asked Questions</a>
<ul class="nav flex-column">
</ul>
</li> </li>
</ul> </ul>
</li> </li>
@ -136,8 +140,11 @@
<p>In this text area, yellow texts are setting names, green texts are setting <p>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 values that can be set when clicked on, and dark-green texts are settings that
display more settings when clicked on.</p> display more settings when clicked on.</p>
<p>You can hover/click these texts by pressing the "t" key to open the chatbox, and <div class="admonition note">
using the mouse.</p> <p class="admonition-title">Note</p>
<p>You can hover/click these texts by pressing the "t" key to open the chatbox,
and using the mouse.</p>
</div>
<p><img alt="tbm-server-edit info when hovered" src="../tbm-server-edit-hover.png" /></p> <p><img alt="tbm-server-edit info when hovered" src="../tbm-server-edit-hover.png" /></p>
<p><img alt="tbm-server-edit output when haste-speed is set" src="../tbm-server-edit-set-haste.png" /></p> <p><img alt="tbm-server-edit output when haste-speed is set" src="../tbm-server-edit-set-haste.png" /></p>
<p>When clicking on the dark-green texts, a description and list is shown. You can <p>When clicking on the dark-green texts, a description and list is shown. You can
@ -167,8 +174,11 @@ time.</p>
<p>Also, "DecisionAttack" will be set to 100%, so that the sheep will choose to <p>Also, "DecisionAttack" will be set to 100%, so that the sheep will choose to
attack instead of fleeing battle.</p> attack instead of fleeing battle.</p>
<p><img alt="mob setting decision attack 100%" src="../tbm-edit-decision-attack.png" /></p> <p><img alt="mob setting decision attack 100%" src="../tbm-edit-decision-attack.png" /></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Make sure to click on "Finished Editing" to save changes to the server-side <p>Make sure to click on "Finished Editing" to save changes to the server-side
config.</p> config.</p>
</div>
<p>Note that for sheep to enter battle, they must be removed from the "ignore <p>Note that for sheep to enter battle, they must be removed from the "ignore
battle categories" setting (remove the "passive" category).</p> battle categories" setting (remove the "passive" category).</p>
<p><img alt="server edit remove passive from ignore <p><img alt="server edit remove passive from ignore
@ -183,14 +193,19 @@ named with a specific name (like with a name-tag). Name a mob, then invoke
<p>Hit the named mob to start the editing process.</p> <p>Hit the named mob to start the editing process.</p>
<p><img alt="tbm-edit custom editing" src="../tbm-edit-custom-editing.jpg" /></p> <p><img alt="tbm-edit custom editing" src="../tbm-edit-custom-editing.jpg" /></p>
<p>Make your changes and click on "Finished Editing", and any mob with that exact <p>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 name will have these battle settings applied.</p>
in the server-side config.</p> <div class="admonition note">
<p class="admonition-title">Note</p>
<p>These settings are also in the server-side config.</p>
</div>
<h2 id="other-things-to-know">Other Things to Know</h2> <h2 id="other-things-to-know">Other Things to Know</h2>
<p>Sometimes a mod update will "reset" the settings in the server-config to <p>Sometimes a mod update will "reset" the settings in the server-config to
defaults. This is due to new mob entries in the settings. Check the defaults. This is due to new mob entries in the settings. Check the
<code>.minecraft/config</code> folder (or <code>config</code> folder on the server) to see that the <code>.minecraft/config</code> folder (or <code>config</code> folder on the server) to see that the
old settings file was renamed and the new settings file is in its place. You may 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.</p></div> have to compare the files to keep the settings you want.</p>
<h2 id="frequently-asked-questions">Frequently Asked Questions</h2>
<p><a href="https://github.com/Stephen-Seo/TurnBasedMinecraftMod/blob/neoforge/FAQ.md">FAQ</a></p></div>
</div> </div>
</div> </div>