TurnBasedMinecraftMod/server_config/index.html

306 lines
16 KiB
HTML

<!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>Server-Side Config - Docs 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="..">Docs 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="../client_config/" class="nav-link">Client-Side Config</a>
</li>
<li class="nav-item">
<a href="./" class="nav-link active" aria-current="page">Server-Side Config</a>
</li>
<li class="nav-item">
<a href="../FAQ/" class="nav-link">Frequently Asked Questions</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="../client_config/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../FAQ/" 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="#server-side-config" class="nav-link">Server-side Config</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#per-mob-settings" class="nav-link">Per-Mob Settings</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#custom-name-settings" class="nav-link">Custom Name Settings</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#per-player-settings" class="nav-link">Per-Player Settings</a>
<ul class="nav flex-column">
</ul>
</li>
<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>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="server-side-config">Server-side Config</h1>
<p>Invoke <code>/tbm-server-edit</code> to print out server settings to the "chat" area.</p>
<p><img alt="tbm-server-edit output" src="../tbm-server-edit-full.png" /></p>
<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>
<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
hover over the text to show what actions may occur when clicked.</p>
<p><img alt="tbm-server-edit ignore-damage-sources
output" src="../tbm-server-edit-damage-sources.png" /></p>
<p>On click, the action taken will be shown.</p>
<p><img alt="tbm-server-edit ignore-damage-sources
modified" src="../tbm-server-edit-damage-sources-set.png" /></p>
<p>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.</p>
<h2 id="per-mob-settings">Per-Mob Settings</h2>
<p>To demonstrate setting "per-mob" settings, it will be shown how to do so with
sheep.</p>
<p><img alt="sheep" src="../tbm-edit-sheep.jpg" /></p>
<p>Invoke <code>/tbm-edit</code>. Some helpful text will show.</p>
<p><img alt="/tbm-edit output" src="../tbm-edit-output.jpg" /></p>
<p>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".</p>
<p><img alt="mob settings" src="../tbm-edit-settings.jpg" /></p>
<p>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.</p>
<p><img alt="mob setting attack effect levitation" src="../tbm-edit-levitation.png" /></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). Alternatively, one
can set sheep to a category other than "passive", like "animal" or "monster". A
category that isn't listed in the "ignore battle categories" setting will start
turn-based-battle.</p>
<p><img alt="server edit remove passive from ignore
categories" src="../tbm-edit-server-edit-ignore-battle-types.png" /></p>
<p>Now, sheep will attack and cause "levitation" 50% of the time.</p>
<p><img alt="after battle with levitation effect" src="../tbm-edit-post-battle.jpg" /></p>
<h2 id="custom-name-settings">Custom Name Settings</h2>
<p>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
<code>/tbm-edit custom</code>.</p>
<p><img alt="tbm-edit custom command" src="../tbm-edit-custom.png" /></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>Make your changes and click on "Finished Editing", and any mob with that exact
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="per-player-settings">Per-Player Settings</h2>
<p>As of TurnBasedMinecraftMod 1.26.4, one can add Player-specific config via a
command <code>/tbm-edit player &lt;PLAYER_NAME&gt;</code>.</p>
<p><img alt="tbm-edit player command" src="../tbm-edit-player-cmd.png" /></p>
<p>You can make changes as usual, though some options for regular mobs do not
apply to the per-Player config.</p>
<p><img alt="tbm-edit player editing" src="../tbm-edit-player-display.png" /></p>
<p>Don't forget to click on "Finished Editing" when done. Once saved, the
server/single-player-game should use these settings for the specified Player in
battle.</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><s>Sometimes a mod update will "reset" the settings in the server-config to
defaults. This is due to new mob entries in the settings.</s><br />
<em>As of version 1.26.5 of the mod, this should happen less frequently!</em><br />
Changes were added in 1.26.5 such that entries that exist in the default config
but not in the current config will be appended to the current config.</p>
<p>Older versions of this mod still retain the previous behavior: 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. Though this
probably shouldn't happen anymore in newer versions of this mod.</p></div>
</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>