]> git.seodisparate.com - TurnBasedMinecraftMod/commitdiff
Deployed 35e24f0 with MkDocs version: 1.6.1
authorStephen Seo <seo.disparate@gmail.com>
Tue, 29 Oct 2024 10:21:00 +0000 (10:21 +0000)
committerStephen Seo <seo.disparate@gmail.com>
Tue, 29 Oct 2024 10:21:00 +0000 (10:21 +0000)
client_config/index.html
index.html
search/search_index.json
server_config/index.html

index 0fa0f45c075316fb6726bd46c59c33acf74fc069..5bed18693c35590b6672b39977c896127653a307 100644 (file)
             
             <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">
+            <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>
             </li>
         </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
 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%).</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>
 
index 4bffd72421f9a59f58a6348380620981734d8858..a9f07a23bba79cd3040b65ccc393cdb6993a9bfc 100644 (file)
 
 <!--
 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
 -->
index d457893118b048f16bd64eb724c1bf4c6c7eba76..7210a75f323e3bec5b83b95341305bfe62075144 100644 (file)
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"TurnBasedMinecraftMod Main repository link. Alternate repository link. Pages Client-side config Server-side config","title":"TurnBasedMinecraftMod"},{"location":"#turnbasedminecraftmod","text":"Main repository link. Alternate repository link.","title":"TurnBasedMinecraftMod"},{"location":"#pages","text":"Client-side config Server-side config","title":"Pages"},{"location":"client_config/","text":"Client-side Config The client config can be opened in two ways. One way is via the mod-list (only works in NeoForge, not Forge). The other way is via the /tbm-client-edit command. Currently, the client config allows for configuration for client-side music playback. The \"categories\" settings are comma-separated words that define what \"category\" triggers the \"battle\" music or the \"silly\" music. \"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 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%).","title":"Client-side Config"},{"location":"client_config/#client-side-config","text":"The client config can be opened in two ways. One way is via the mod-list (only works in NeoForge, not Forge). The other way is via the /tbm-client-edit command. Currently, the client config allows for configuration for client-side music playback. The \"categories\" settings are comma-separated words that define what \"category\" triggers the \"battle\" music or the \"silly\" music. \"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 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%).","title":"Client-side Config"},{"location":"server_config/","text":"Server-side Config Invoke /tbm-server-edit to print out server settings to the \"chat\" area. 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. When clicking on the dark-green texts, a description and list is shown. You can hover over the text to show what actions may occur when clicked. On click, the action taken will be shown. It is also possible to set config settings via a command, but it is recommended to use the \"click-on-chat\" interface for general server config settings. Per-Mob Settings To demonstrate setting \"per-mob\" settings, it will be shown how to do so with sheep. Invoke /tbm-edit . Some helpful text will show. At this point, TBMM (TurnBasedMinecraftMod) will be keeping track of who you will attack next, so that you can edit their settings. Currently this only applies to mobs like sheep, zombies, skeletons, bees, etc. This is done so that you can physically select the mob you want to \"edit\". In this example, the \"AE\" (attack effect) setting will be changed to \"levitation\", which will cause the sheep to make the player levitate 50% of the time. Also, \"DecisionAttack\" will be set to 100%, so that the sheep will choose to attack instead of fleeing battle. 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). Now, sheep will attack and cause \"levitation\" 50% of the time. Custom Name Settings Additional entries can be added to the server-side config that applies to mobs named with a specific name (like with a name-tag). Name a mob, then invoke /tbm-edit custom . Hit the named mob to start the editing process. 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. Other Things to Know 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 .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.","title":"Server-side Config"},{"location":"server_config/#server-side-config","text":"Invoke /tbm-server-edit to print out server settings to the \"chat\" area. 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. When clicking on the dark-green texts, a description and list is shown. You can hover over the text to show what actions may occur when clicked. On click, the action taken will be shown. It is also possible to set config settings via a command, but it is recommended to use the \"click-on-chat\" interface for general server config settings.","title":"Server-side Config"},{"location":"server_config/#per-mob-settings","text":"To demonstrate setting \"per-mob\" settings, it will be shown how to do so with sheep. Invoke /tbm-edit . Some helpful text will show. At this point, TBMM (TurnBasedMinecraftMod) will be keeping track of who you will attack next, so that you can edit their settings. Currently this only applies to mobs like sheep, zombies, skeletons, bees, etc. This is done so that you can physically select the mob you want to \"edit\". In this example, the \"AE\" (attack effect) setting will be changed to \"levitation\", which will cause the sheep to make the player levitate 50% of the time. Also, \"DecisionAttack\" will be set to 100%, so that the sheep will choose to attack instead of fleeing battle. 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). Now, sheep will attack and cause \"levitation\" 50% of the time.","title":"Per-Mob Settings"},{"location":"server_config/#custom-name-settings","text":"Additional entries can be added to the server-side config that applies to mobs named with a specific name (like with a name-tag). Name a mob, then invoke /tbm-edit custom . Hit the named mob to start the editing process. 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.","title":"Custom Name Settings"},{"location":"server_config/#other-things-to-know","text":"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 .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.","title":"Other Things to Know"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"TurnBasedMinecraftMod Main repository link. Alternate repository link. Pages Client-side config Server-side config","title":"TurnBasedMinecraftMod"},{"location":"#turnbasedminecraftmod","text":"Main repository link. Alternate repository link.","title":"TurnBasedMinecraftMod"},{"location":"#pages","text":"Client-side config Server-side config","title":"Pages"},{"location":"client_config/","text":"Client-side Config The client config can be opened in two ways. One way is via the mod-list (only works in NeoForge, not Forge). The other way is via the /tbm-client-edit command. Currently, the client config allows for configuration for client-side music playback. The \"categories\" settings are comma-separated words that define what \"category\" triggers the \"battle\" music or the \"silly\" music. \"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 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.","title":"Client-side Config"},{"location":"client_config/#client-side-config","text":"The client config can be opened in two ways. One way is via the mod-list (only works in NeoForge, not Forge). The other way is via the /tbm-client-edit command. Currently, the client config allows for configuration for client-side music playback. The \"categories\" settings are comma-separated words that define what \"category\" triggers the \"battle\" music or the \"silly\" music. \"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 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%).","title":"Client-side Config"},{"location":"client_config/#battlesilly-music","text":"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.","title":"Battle/Silly Music"},{"location":"server_config/","text":"Server-side Config Invoke /tbm-server-edit to print out server settings to the \"chat\" area. 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. Note You can hover/click these texts by pressing the \"t\" key to open the chatbox, and using the mouse. When clicking on the dark-green texts, a description and list is shown. You can hover over the text to show what actions may occur when clicked. On click, the action taken will be shown. It is also possible to set config settings via a command, but it is recommended to use the \"click-on-chat\" interface for general server config settings. Per-Mob Settings To demonstrate setting \"per-mob\" settings, it will be shown how to do so with sheep. Invoke /tbm-edit . Some helpful text will show. At this point, TBMM (TurnBasedMinecraftMod) will be keeping track of who you will attack next, so that you can edit their settings. Currently this only applies to mobs like sheep, zombies, skeletons, bees, etc. This is done so that you can physically select the mob you want to \"edit\". In this example, the \"AE\" (attack effect) setting will be changed to \"levitation\", which will cause the sheep to make the player levitate 50% of the time. Also, \"DecisionAttack\" will be set to 100%, so that the sheep will choose to attack instead of fleeing battle. 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). Now, sheep will attack and cause \"levitation\" 50% of the time. Custom Name Settings Additional entries can be added to the server-side config that applies to mobs named with a specific name (like with a name-tag). Name a mob, then invoke /tbm-edit custom . Hit the named mob to start the editing process. Make your changes and click on \"Finished Editing\", and any mob with that exact name will have these battle settings applied. Note These settings are also in the server-side config. Other Things to Know 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 .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","title":"Server-side Config"},{"location":"server_config/#server-side-config","text":"Invoke /tbm-server-edit to print out server settings to the \"chat\" area. 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. Note You can hover/click these texts by pressing the \"t\" key to open the chatbox, and using the mouse. When clicking on the dark-green texts, a description and list is shown. You can hover over the text to show what actions may occur when clicked. On click, the action taken will be shown. It is also possible to set config settings via a command, but it is recommended to use the \"click-on-chat\" interface for general server config settings.","title":"Server-side Config"},{"location":"server_config/#per-mob-settings","text":"To demonstrate setting \"per-mob\" settings, it will be shown how to do so with sheep. Invoke /tbm-edit . Some helpful text will show. At this point, TBMM (TurnBasedMinecraftMod) will be keeping track of who you will attack next, so that you can edit their settings. Currently this only applies to mobs like sheep, zombies, skeletons, bees, etc. This is done so that you can physically select the mob you want to \"edit\". In this example, the \"AE\" (attack effect) setting will be changed to \"levitation\", which will cause the sheep to make the player levitate 50% of the time. Also, \"DecisionAttack\" will be set to 100%, so that the sheep will choose to attack instead of fleeing battle. 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). Now, sheep will attack and cause \"levitation\" 50% of the time.","title":"Per-Mob Settings"},{"location":"server_config/#custom-name-settings","text":"Additional entries can be added to the server-side config that applies to mobs named with a specific name (like with a name-tag). Name a mob, then invoke /tbm-edit custom . Hit the named mob to start the editing process. Make your changes and click on \"Finished Editing\", and any mob with that exact name will have these battle settings applied. Note These settings are also in the server-side config.","title":"Custom Name Settings"},{"location":"server_config/#other-things-to-know","text":"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 .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.","title":"Other Things to Know"},{"location":"server_config/#frequently-asked-questions","text":"FAQ","title":"Frequently Asked Questions"}]}
\ No newline at end of file
index dfadd5f93714282424ed81d090df27c9ca788efc..34f7fcb5f7c05d428952aeb4dab5eb755e92c98b 100644 (file)
             <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>
+            </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>
               </ul>
             </li>
 <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
 display more settings when clicked on.</p>
-<p>You can hover/click these texts by pressing the "t" key to open the chatbox, and
-using the mouse.</p>
+<div class="admonition note">
+<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 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
@@ -167,8 +174,11 @@ time.</p>
 <p>Also, "DecisionAttack" will be set to 100%, so that the sheep will choose to
 attack instead of fleeing battle.</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
 config.</p>
+</div>
 <p>Note that for sheep to enter battle, they must be removed from the "ignore
 battle categories" setting (remove the "passive" category).</p>
 <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><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
-name will have these battle settings applied. Note that these settings are also
-in the server-side config.</p>
+name will have these battle settings applied.</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>
 <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
 <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
-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>