2024-10-29 08:57:40 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en" data-bs-theme="dark">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
|
|
|
<title>Client-side Config - Documentation for TurnBasedMinecraftMod</title>
|
|
|
|
|
<link href="../css/bootstrap.min.css" rel="stylesheet">
|
|
|
|
|
<link href="../css/fontawesome.min.css" rel="stylesheet">
|
|
|
|
|
<link href="../css/brands.min.css" rel="stylesheet">
|
|
|
|
|
<link href="../css/solid.min.css" rel="stylesheet">
|
|
|
|
|
<link href="../css/v4-font-face.min.css" rel="stylesheet">
|
|
|
|
|
<link href="../css/base.css" rel="stylesheet">
|
|
|
|
|
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" disabled>
|
|
|
|
|
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" >
|
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
|
|
|
|
<script>hljs.highlightAll();</script>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<a class="navbar-brand" href="..">Documentation for TurnBasedMinecraftMod</a>
|
|
|
|
|
<!-- Expander button -->
|
|
|
|
|
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
|
|
|
|
|
<span class="navbar-toggler-icon"></span>
|
|
|
|
|
</button>
|
|
|
|
|
|
|
|
|
|
<!-- Expanded navigation -->
|
|
|
|
|
<div id="navbar-collapse" class="navbar-collapse collapse">
|
|
|
|
|
<!-- Main navigation -->
|
|
|
|
|
<ul class="nav navbar-nav">
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a href=".." class="nav-link">TurnBasedMinecraftMod</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a href="./" class="nav-link active" aria-current="page">Client-side Config</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a href="../server_config/" class="nav-link">Server-side Config</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<ul class="nav navbar-nav ms-md-auto">
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
|
|
|
|
|
<i class="fa fa-search"></i> Search
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a rel="prev" href=".." class="nav-link">
|
|
|
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a rel="next" href="../server_config/" class="nav-link">
|
|
|
|
|
Next <i class="fa fa-arrow-right"></i>
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item dropdown">
|
|
|
|
|
<button id="theme-menu" aria-expanded="false" data-bs-toggle="dropdown" data-bs-display="static" aria-label="Toggle theme" class="nav-link dropdown-toggle">
|
|
|
|
|
<i class="fa-solid fa-circle-half-stroke fa-fw"></i>
|
|
|
|
|
<span class="d-lg-none ms-2">Toggle theme</span>
|
|
|
|
|
</button>
|
|
|
|
|
<ul class="dropdown-menu dropdown-menu-end">
|
|
|
|
|
<li>
|
|
|
|
|
<button class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
|
|
|
|
|
<i class="fa-solid fa-sun fa-fw"></i>
|
|
|
|
|
<span class="ms-2">Light</span>
|
|
|
|
|
<i class="fa-solid fa-check ms-auto d-none"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<button class="dropdown-item d-flex align-items-center" data-bs-theme-value="dark" aria-pressed="true">
|
|
|
|
|
<i class="fa-solid fa-moon fa-fw"></i>
|
|
|
|
|
<span class="ms-2">Dark</span>
|
|
|
|
|
<i class="fa-solid fa-check ms-auto"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<button class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="false">
|
|
|
|
|
<i class="fa-solid fa-circle-half-stroke fa-fw"></i>
|
|
|
|
|
<span class="ms-2">Auto</span>
|
|
|
|
|
<i class="fa-solid fa-check ms-auto d-none"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<script src="../js/darkmode.js"></script>
|
|
|
|
|
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="row">
|
|
|
|
|
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
|
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
|
|
|
|
|
<span class="fa fa-angle-down"></span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
|
|
|
|
|
<ul class="nav flex-column">
|
|
|
|
|
|
|
|
|
|
<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">
|
2024-10-29 10:21:00 +00:00
|
|
|
<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>
|
2024-10-29 08:57:40 +00:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div></div>
|
|
|
|
|
<div class="col-md-9" role="main">
|
|
|
|
|
|
|
|
|
|
<h1 id="client-side-config">Client-side Config</h1>
|
|
|
|
|
<p>The client config can be opened in two ways.</p>
|
|
|
|
|
<p>One way is via the mod-list (only works in NeoForge, not Forge).</p>
|
|
|
|
|
<p><img alt="Mod list config button" src="../tbm-client-edit-modlist.jpg" /></p>
|
|
|
|
|
<p>The other way is via the <code>/tbm-client-edit</code> command.</p>
|
|
|
|
|
<p><img alt="tbm-client-edit command" src="../tbm-client-edit-cmd.png" /></p>
|
|
|
|
|
<p>Currently, the client config allows for configuration for client-side music
|
|
|
|
|
playback.</p>
|
|
|
|
|
<p><img alt="client config" src="../tbm-client-edit-config.jpg" /></p>
|
|
|
|
|
<p>The "categories" settings are comma-separated words that define what "category"
|
|
|
|
|
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
|
2024-10-29 09:54:21 +00:00
|
|
|
is one player, one zombie, and two sheep in battle, then the game will play
|
2024-10-29 10:21:00 +00:00
|
|
|
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>
|
2024-10-29 10:41:37 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="admonition note">
|
|
|
|
|
<p class="admonition-title">Note</p>
|
|
|
|
|
<p>The following command can convert to .ogg Vorbis using ffmpeg:<br />
|
|
|
|
|
<code>ffmpeg -i <music_file> -map a:0 -c:a libvorbis output.ogg</code></p>
|
2024-10-29 10:21:00 +00:00
|
|
|
</div></div>
|
2024-10-29 08:57:40 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<footer class="col-md-12">
|
|
|
|
|
<hr>
|
|
|
|
|
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
|
|
|
|
|
</footer>
|
|
|
|
|
<script src="../js/bootstrap.bundle.min.js"></script>
|
|
|
|
|
<script>
|
|
|
|
|
var base_url = "..",
|
|
|
|
|
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
|
|
|
|
|
</script>
|
|
|
|
|
<script src="../js/base.js"></script>
|
|
|
|
|
<script src="../search/main.js"></script>
|
|
|
|
|
|
|
|
|
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
|
|
|
|
<div class="modal-dialog modal-lg">
|
|
|
|
|
<div class="modal-content">
|
|
|
|
|
<div class="modal-header">
|
|
|
|
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
|
|
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="modal-body">
|
|
|
|
|
<p>From here you can search these documents. Enter your search terms below.</p>
|
|
|
|
|
<form>
|
|
|
|
|
<div class="form-group">
|
|
|
|
|
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
|
|
|
|
</div>
|
|
|
|
|
</form>
|
|
|
|
|
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="modal-footer">
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
|
|
|
|
<div class="modal-dialog">
|
|
|
|
|
<div class="modal-content">
|
|
|
|
|
<div class="modal-header">
|
|
|
|
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
|
|
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="modal-body">
|
|
|
|
|
<table class="table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th style="width: 20%;">Keys</th>
|
|
|
|
|
<th>Action</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="help shortcut"><kbd>?</kbd></td>
|
|
|
|
|
<td>Open this help</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="next shortcut"><kbd>n</kbd></td>
|
|
|
|
|
<td>Next page</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
|
|
|
|
<td>Previous page</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="search shortcut"><kbd>s</kbd></td>
|
|
|
|
|
<td>Search</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="modal-footer">
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
