59 linhas
Sem EOL
36 KiB
HTML
59 linhas
Sem EOL
36 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Getting started | Awakened Docs</title>
|
||
<meta name="description" content="The documentation for Awakened Redstone's projects">
|
||
<meta name="generator" content="VitePress v1.6.3">
|
||
<link rel="preload stylesheet" href="/assets/style.DU2BPeVP.css" as="style">
|
||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/assets/app.fAN7ko-K.js"></script>
|
||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/assets/chunks/theme.Ep9al9kZ.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.DTpsuxmX.js">
|
||
<link rel="modulepreload" href="/assets/chunks/Component.IGYokwXj.js">
|
||
<link rel="modulepreload" href="/assets/minecraft_autowhitelist_install.md.7iZTywCI.lean.js">
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0b0ada53></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0b0ada53>Skip to content</a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle has-sidebar" data-v-6aa21345 data-v-1168a8e4><a class="title" href="/" data-v-1168a8e4><!--[--><!--]--><!----><span data-v-1168a8e4>Awakened Docs</span><!--[--><!--]--></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aa21345><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6aa21345 data-v-06110241><span id="main-nav-aria-label" class="visually-hidden" data-v-06110241> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/minecraft/autowhitelist" tabindex="0" data-v-06110241 data-v-e56f3d57><!--[--><span data-v-e56f3d57>AutoWhitelist</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/minecraft/default-components" tabindex="0" data-v-06110241 data-v-e56f3d57><!--[--><span data-v-e56f3d57>Default Components</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-06110241 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-cf11d7a2><span class="text" data-v-cf11d7a2><!----><span data-v-cf11d7a2>1.2.2</span><span class="vpi-chevron-down text-icon" data-v-cf11d7a2></span></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-35975db6><a class="VPLink link" href="/minecraft/autowhitelist/1.2.0/install" data-v-35975db6><!--[--><span data-v-35975db6>1.2.0</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-35975db6><a class="VPLink link" href="/minecraft/autowhitelist/install" data-v-35975db6><!--[--><span data-v-35975db6>1.2.2</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6aa21345 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aa21345 data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Awakened-Redstone/awakened-docs-2" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-cf11d7a2><span class="vpi-more-horizontal icon" data-v-cf11d7a2></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><!----><!--[--><!--[--><!----><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div></div></div><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Awakened-Redstone/awakened-docs-2" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-8a42e2b4><button data-v-8a42e2b4>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-319d5ca6><div class="curtain" data-v-319d5ca6></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-319d5ca6><span class="visually-hidden" id="sidebar-aria-label" data-v-319d5ca6> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 has-active" data-v-c40bc020 data-v-b3fd67f8><!----><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/index" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/install" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Getting started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/entries" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Entry actions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/geyser" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Geyser support</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Configurations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b3fd67f8><span class="vpi-chevron-right caret-icon" data-v-b3fd67f8></span></div></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/configs/activity" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Bot Status</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/configs/whitelist-cache" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Whitelist cache</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/configs/lock" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Entry Lock</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/configs/generator" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Config generator</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Advanced</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b3fd67f8><span class="vpi-chevron-right caret-icon" data-v-b3fd67f8></span></div></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/minecraft/autowhitelist/advanced/custom-messages" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Custom messages</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _minecraft_autowhitelist_install" data-v-39a288b8><div><h1 id="installing" tabindex="-1">Installing <a class="header-anchor" href="#installing" aria-label="Permalink to "Installing""></a></h1><div class="tip markdown-alert"><p class="markdown-alert-title"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-lightbulb"><path d="M15 14c.2-1 .7-1.7 1.5-2.5 1-.9 1.5-2.2 1.5-3.5A6 6 0 0 0 6 8c0 1 .2 2.2 1.5 3.5.7.7 1.3 1.5 1.5 2.5"></path><path d="M9 18h6"></path><path d="M10 22h4"></path></svg>TIP</p><p>Basic JSON or JSON5 knowledge is highly recommended.</p></div><h2 id="installing-the-mod" tabindex="-1">Installing the mod <a class="header-anchor" href="#installing-the-mod" aria-label="Permalink to "Installing the mod""></a></h2><p>Make sure you download the correct version for your server's Minecraft version.</p><ol><li>Download the mod from <a href="https://modrinth.com/mod/autowhitelist#download" target="_blank" rel="noopener noreferrer"><!--[-->Modrinth<!--]--></a></li><li>Download the required dependencies <a href="https://modrinth.com/mod/fabric-api#download" target="_blank" rel="noopener noreferrer"><!--[-->FabricAPI<!--]--></a> and <a href="https://modrinth.com/mod/fabric-language-kotlin#download" target="_blank" rel="noopener noreferrer"><!--[-->Fabric Language Kotlin<!--]--></a></li><li>Put the downloaded files in your <code>mods</code> folder</li><li>Start the server, this will generate the config file at <code>config/autowhitelist.json5</code></li></ol><h3 id="setting-up-the-discord-bot" tabindex="-1">Setting up the Discord bot <a class="header-anchor" href="#setting-up-the-discord-bot" aria-label="Permalink to "Setting up the Discord bot""></a></h3><p>The mod requires a Discord bot, you can create a new one or choose an existing one in the <a href="https://discord.com/developers/applications" target="_blank" rel="noreferrer">Discord developer portal</a><br> Make sure it has the <code>Server members intent</code> enabled</p><!--[--><button class="open-button transition-colors" data-v-97c5fa46><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-text" viewBox="0 0 24 24" data-v-97c5fa46><path d="M4 19.5v-15A2.5 2.5 0 0 1 6.5 2H19a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1H6.5a1 1 0 0 1 0-5H20M8 11h8M8 7h6"></path></svg> How to create an app</button><!----><!--]--><h2 id="configuring-the-mod" tabindex="-1">Configuring the mod <a class="header-anchor" href="#configuring-the-mod" aria-label="Permalink to "Configuring the mod""></a></h2><h3 id="bot-token" tabindex="-1">Bot token <a class="header-anchor" href="#bot-token" aria-label="Permalink to "Bot token""></a></h3><p>Copy the bot token from the developer console and add it to the mod config</p><!--[--><button class="open-button transition-colors" data-v-97c5fa46><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-text" viewBox="0 0 24 24" data-v-97c5fa46><path d="M4 19.5v-15A2.5 2.5 0 0 1 6.5 2H19a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1H6.5a1 1 0 0 1 0-5H20M8 11h8M8 7h6"></path></svg> How to get the bot token</button><!----><!--]--><div class="language-json5 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json5</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "lock_time"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"1d"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Your bot token. Never share it, anyone with it has full control of the bot</span></span>
|
||
<span class="line highlighted"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "token"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"NEVER SHARE YOUR BOT TOKEN"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "discord_server_id"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // When enabled, all interactions and slash commands will be ephemeral, meaning only the user can see the response.</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "ephemeral_replies"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span></code></pre></div><h3 id="server-id" tabindex="-1">Server ID <a class="header-anchor" href="#server-id" aria-label="Permalink to "Server ID""></a></h3><p>Copy the Discord server/guild id of the server where you added the bot to</p><!--[--><button class="open-button transition-colors" data-v-97c5fa46><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-text" viewBox="0 0 24 24" data-v-97c5fa46><path d="M4 19.5v-15A2.5 2.5 0 0 1 6.5 2H19a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1H6.5a1 1 0 0 1 0-5H20M8 11h8M8 7h6"></path></svg> How to get the server id</button><!----><!--]--><div class="language-json5 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json5</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "lock_time"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"1d"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Your bot token. Never share it, anyone with it has full control of the bot</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "token"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"NEVER SHARE YOUR BOT TOKEN"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line highlighted"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "discord_server_id"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // When enabled, all interactions and slash commands will be ephemeral, meaning only the user can see the response.</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "ephemeral_replies"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span></code></pre></div><h3 id="adding-the-bot-to-your-server" tabindex="-1">Adding the bot to your server <a class="header-anchor" href="#adding-the-bot-to-your-server" aria-label="Permalink to "Adding the bot to your server""></a></h3><p>Create the url to add the bot to a server and use it to add it to the server you plan to use it on</p><!--[--><button class="open-button transition-colors" data-v-97c5fa46><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="lucide lucide-book-text" viewBox="0 0 24 24" data-v-97c5fa46><path d="M4 19.5v-15A2.5 2.5 0 0 1 6.5 2H19a1 1 0 0 1 1 1v18a1 1 0 0 1-1 1H6.5a1 1 0 0 1 0-5H20M8 11h8M8 7h6"></path></svg> How to add the bot</button><!----><!--]--><h3 id="configuring-the-entries" tabindex="-1">Configuring the entries <a class="header-anchor" href="#configuring-the-entries" aria-label="Permalink to "Configuring the entries""></a></h3><div class="tip markdown-alert"><p class="markdown-alert-title"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-lightbulb"><path d="M15 14c.2-1 .7-1.7 1.5-2.5 1-.9 1.5-2.2 1.5-3.5A6 6 0 0 0 6 8c0 1 .2 2.2 1.5 3.5.7.7 1.3 1.5 1.5 2.5"></path><path d="M9 18h6"></path><path d="M10 22h4"></path></svg>TIP</p><p><a href="./configs/generator">You can use the entry generator for an easier setup</a></p></div><p>On the config file, <code>entries</code> will be empty by default, there you will configure what the server will do when whitelisting the players.</p><p>All of them takes a list of <code>roles</code> that will be used to whitelist the players, and a <code>type</code> that will be used to determine what the server will do when whitelisting the players.</p><p><code>roles</code> takes either the role ID or the role name, prefixed by an <code>@</code>, you can use both ways on the same entry</p><p>Any extra keys (if any) go inside the <code>execute</code> object</p><p>The format is</p><div class="language-json5 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json5</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The Discord roles that will be used to whitelist the players</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "roles"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Discord role id"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"@Or the role name"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The method that will be used to whitelist the players</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "type"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"namespace:path"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Any extra option goes in here, it defines what will be done when the entry runs, for adding/removing to the whitelist</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "execute"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {}</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>When a player is moved between entries, for example, due to a role change, the mod will execute the code for removal of the old entry and right after it executes the code for adding into the new entry</p><p>For more details on entries view the <a href="./entries">entries documentation page</a></p><details class="details custom-block"><summary>Example</summary><p>Let's take this example config:</p><div class="language-json5 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json5</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "roles"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"@Role 1"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "type"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"autowhitelist:execute_command"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "execute"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "on_add"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"say {player} joined the cool team"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "on_remove"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"say {player} is no longer cool"</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">},</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "roles"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"@Role 2"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "type"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"autowhitelist:execute_command"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "execute"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "on_add"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"say {player} is now awesome"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "on_remove"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"say {player} left the awesome team"</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Once I register while having <code>@Role 1</code> the server will announce:</p><div class="language-log vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">log</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">23:31:22</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">] [AutoWhitelist] AwakenedRedstone joined the cool team</span></span></code></pre></div><p>Now, I got a new role, <code>@Role 2</code><br> The server will follow with:</p><div class="language-log vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">log</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">23:33:53</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">] [AutoWhitelist] AwakenedRedstone is no longer cool</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">23:33:53</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">] [AutoWhitelist] AwakenedRedstone is now awesome</span></span></code></pre></div></details></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/minecraft/autowhitelist/index" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>Introduction</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/minecraft/autowhitelist/entries" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Entry actions</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"index.md\":\"BgICLwz4\",\"minecraft_autowhitelist_1.2.0_advanced_custom-messages.md\":\"Dy0BrZSe\",\"minecraft_autowhitelist_1.2.0_advanced_index.md\":\"DL3DLAm4\",\"minecraft_autowhitelist_1.2.0_configs_activity.md\":\"54bAsUd_\",\"minecraft_autowhitelist_1.2.0_configs_generator.md\":\"CfBnpWXa\",\"minecraft_autowhitelist_1.2.0_configs_index.md\":\"BHWeuUg6\",\"minecraft_autowhitelist_1.2.0_configs_lock.md\":\"DZiAVtjy\",\"minecraft_autowhitelist_1.2.0_configs_whitelist-cache.md\":\"DYdRENr3\",\"minecraft_autowhitelist_1.2.0_entries.md\":\"BpwguDkJ\",\"minecraft_autowhitelist_1.2.0_geyser.md\":\"Bmj84W74\",\"minecraft_autowhitelist_1.2.0_index.md\":\"CdrSdQ9J\",\"minecraft_autowhitelist_1.2.0_install.md\":\"DeIqqKFh\",\"minecraft_autowhitelist_advanced_custom-messages.md\":\"BuRBEWt3\",\"minecraft_autowhitelist_advanced_index.md\":\"Da09Z5S3\",\"minecraft_autowhitelist_configs_activity.md\":\"Bk26dWmr\",\"minecraft_autowhitelist_configs_generator.md\":\"DIiYWuKR\",\"minecraft_autowhitelist_configs_index.md\":\"apdhFhf3\",\"minecraft_autowhitelist_configs_lock.md\":\"CUUX95ws\",\"minecraft_autowhitelist_configs_whitelist-cache.md\":\"2LUXz27a\",\"minecraft_autowhitelist_entries.md\":\"CQdcWGD0\",\"minecraft_autowhitelist_geyser.md\":\"BA5nU8lI\",\"minecraft_autowhitelist_index.md\":\"CfHRmMqA\",\"minecraft_autowhitelist_install.md\":\"7iZTywCI\",\"minecraft_default-components_index.md\":\"C_MQr_BT\",\"minecraft_default-components_target.md\":\"Bx1rkhzI\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Awakened Docs\",\"description\":\"The documentation for Awakened Redstone's projects\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"docsNav\":{\"/\":[{\"text\":\"AutoWhitelist\",\"link\":\"minecraft/autowhitelist\"},{\"text\":\"Default Components\",\"link\":\"minecraft/default-components\"}],\"/minecraft/autowhitelist\":[{\"text\":\"AutoWhitelist\",\"link\":\"minecraft/autowhitelist\"},{\"text\":\"Default Components\",\"link\":\"minecraft/default-components\"},{\"latest\":\"1.2.2\",\"1.2.0\":\"1.2.0\",\"1.2.2\":\"1.2.2\"}]},\"sidebar\":{\"/minecraft/autowhitelist\":{\"base\":\"/minecraft/autowhitelist\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/index.md\",\"index\":1},{\"text\":\"Getting started\",\"link\":\"/install.md\",\"index\":2},{\"text\":\"Entry actions\",\"link\":\"/entries.md\",\"index\":3},{\"text\":\"Geyser support\",\"link\":\"/geyser.md\",\"index\":5},{\"text\":\"Configurations\",\"items\":[{\"text\":\"Bot Status\",\"link\":\"/configs/activity.md\",\"index\":1},{\"text\":\"Whitelist cache\",\"link\":\"/configs/whitelist-cache.md\",\"index\":2},{\"text\":\"Entry Lock\",\"link\":\"/configs/lock.md\",\"index\":3},{\"text\":\"Config generator\",\"link\":\"/configs/generator.md\",\"index\":4}],\"collapsed\":true,\"index\":6},{\"text\":\"Advanced\",\"items\":[{\"text\":\"Custom messages\",\"link\":\"/advanced/custom-messages.md\",\"index\":1}],\"collapsed\":true,\"index\":7}]},\"/minecraft/autowhitelist/1.2.0\":{\"base\":\"/minecraft/autowhitelist/1.2.0\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/index.md\",\"index\":1},{\"text\":\"Getting started\",\"link\":\"/install.md\",\"index\":2},{\"text\":\"Entry actions\",\"link\":\"/entries.md\",\"index\":3},{\"text\":\"Geyser support\",\"link\":\"/geyser.md\",\"index\":5},{\"text\":\"Configurations\",\"items\":[{\"text\":\"Bot Status\",\"link\":\"/configs/activity.md\",\"index\":1},{\"text\":\"Whitelist cache\",\"link\":\"/configs/whitelist-cache.md\",\"index\":2},{\"text\":\"Entry Lock\",\"link\":\"/configs/lock.md\",\"index\":3},{\"text\":\"Config generator\",\"link\":\"/configs/generator.md\",\"index\":4}],\"collapsed\":true,\"index\":6},{\"text\":\"Advanced\",\"items\":[{\"text\":\"Custom messages\",\"link\":\"/advanced/custom-messages.md\",\"index\":1}],\"collapsed\":true,\"index\":7}]},\"/minecraft/default-components\":{\"base\":\"/minecraft/default-components\",\"items\":[{\"text\":\"Getting started\",\"link\":\"/index.md\",\"index\":1},{\"text\":\"Targeting\",\"link\":\"/target.md\",\"index\":2}]}},\"search\":{\"options\":{},\"provider\":\"local\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Awakened-Redstone/awakened-docs-2\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
|
||
|
||
</body>
|
||
</html> |