27 lines
No EOL
17 KiB
HTML
27 lines
No EOL
17 KiB
HTML
<!doctype html>
|
||
<html class="docs-version-current" lang="en" dir="ltr">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<meta name="generator" content="Docusaurus v2.0.0-beta.15">
|
||
<title data-react-helmet="true">Overview | Llama Bot Documentation</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:url" content="https://docs.llama.developomp.com/docs/usage/overview"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Overview | Llama Bot Documentation"><meta data-react-helmet="true" name="description" content="If you are a non-technical discord user and want to learn how to use the Llama bot, you've come to the right place."><meta data-react-helmet="true" property="og:description" content="If you are a non-technical discord user and want to learn how to use the Llama bot, you've come to the right place."><link data-react-helmet="true" rel="icon" href="/img/logo.png"><link data-react-helmet="true" rel="canonical" href="https://docs.llama.developomp.com/docs/usage/overview"><link data-react-helmet="true" rel="alternate" href="https://docs.llama.developomp.com/docs/usage/overview" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://docs.llama.developomp.com/docs/usage/overview" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.c1c17b9a.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.5f110aa0.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.b812c6db.js" as="script">
|
||
</head>
|
||
<body>
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region"><a href="#" class="skipToContent_ZgBM">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/docs/overview"><div class="navbar__logo"><img src="/img/logo.png" alt="Llama Bot Logo" class="themedImage_W2Cr themedImage--light_TfLj"><img src="/img/logo.png" alt="Llama Bot Logo" class="themedImage_W2Cr themedImage--dark_oUvU"></div><b class="navbar__title">Llama Bot Docs</b></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/llama-bot/llama-bot-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="toggle_Pssr toggle_TdHA toggleDisabled_jDku"><div class="toggleTrack_SSoT" role="button" tabindex="-1"><div class="toggleTrackCheck_XobZ"><span class="toggleIcon_eZtF">🌜</span></div><div class="toggleTrackX_YkSC"><span class="toggleIcon_eZtF">🌞</span></div><div class="toggleTrackThumb_uRm4"></div></div><input type="checkbox" class="toggleScreenReader_JnkT" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper docs-doc-page"><div class="docPage_P2Lg"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_RiI4" type="button"></button><aside class="theme-doc-sidebar-container docSidebarContainer_rKC_"><div class="sidebar_CW9Y"><nav class="menu thin-scrollbar menu_SkdO"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/overview">Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active hasHref_VCh3" aria-current="page" href="/docs/usage/overview">Usage</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/usage/overview">Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/usage/commands">Commands</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist hasHref_VCh3" href="/docs/bot/overview">Bot</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist hasHref_VCh3" href="/docs/web-interface/overview">Web Interface</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist hasHref_VCh3" href="/docs/docs/overview">Docs</a></div></li></ul></nav></div></aside><main class="docMainContainer_TCnq"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_DM6M"><div class="docItemContainer_vinB"><article><div class="tocCollapsible_jdIR theme-doc-toc-mobile tocMobile_TmEX"><button type="button" class="clean-btn tocCollapsibleButton_Fzxq">On this page</button></div><div class="theme-doc-markdown markdown"><h1>Overview</h1><p>If you are a non-technical discord user and want to learn how to use the Llama bot, you've come to the right place.
|
||
In this page, you'll learn the basics of discord bots, what the Llama bot can do, and how to use it.</p><h2 class="anchor anchorWithStickyNavbar_mojV" id="background">Background<a class="hash-link" href="#background" title="Direct link to heading"></a></h2><h3 class="anchor anchorWithStickyNavbar_mojV" id="what-even-is-a-discord-bot">What even is a discord bot?<a class="hash-link" href="#what-even-is-a-discord-bot" title="Direct link to heading"></a></h3><p>In essence, a Discord bot is a account controlled by a program.
|
||
It is used in almost ever server for many different reasons such as automating moderation, music streaming, and even dad jokes.</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="great-now-how-do-i-use-a-bot">Great! Now, how do I use a bot?<a class="hash-link" href="#great-now-how-do-i-use-a-bot" title="Direct link to heading"></a></h3><p>Although some bots — including the Llama bot — offers a web interface, most bots are controlled by commands.
|
||
Commands are messages that is prefixed with special letter(s) that tells what a bot should do.</p><p>Here's an example of a command:</p><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-help</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><p>Here, the hyphen (<code>-</code>) is the prefix and <code>help</code> is the command.
|
||
When messages are formatted like this, bots can identify whether a message is a command or not, and if the command is meant for them or some other bot.
|
||
This is helpful when there are multiple bots in one server.
|
||
Commonly used prefixes are: <code>?</code>, <code>!</code>, <code>></code>, <code>.</code>, <code>..</code>, etc.</p><p>Although Discord released <a href="https://discord.com/blog/slash-commands-are-here" target="_blank" rel="noopener noreferrer">slash commands</a> in 2021, it is not used by most bot developers.</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="commands-are-not-enough">Commands are not enough!<a class="hash-link" href="#commands-are-not-enough" title="Direct link to heading"></a></h3><p>Although commands are awesome, sometimes it is not enough to tell what exactly you want the bot to do.
|
||
This is why you need arguments.</p><p>Here's an example of a command with arguments:</p><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-ban @NaughtyUser @BadUser @GPUScalper69</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><p>Arguments are extra text information that are passed with the command.
|
||
Arguments could be a user, a text channel, regular text, numbers, or even emojis.
|
||
They are usually separated by spaces.
|
||
If you provide more arguments than what's required, they will simply be ignored.</p><h2 class="anchor anchorWithStickyNavbar_mojV" id="how-to-read-the-documentation">How to read the documentation<a class="hash-link" href="#how-to-read-the-documentation" title="Direct link to heading"></a></h2><p>WIP</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="required-arguments">Required arguments<a class="hash-link" href="#required-arguments" title="Direct link to heading"></a></h3><p>WIP</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="optional-arguments">Optional arguments<a class="hash-link" href="#optional-arguments" title="Direct link to heading"></a></h3><p>WIP</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="examples">Examples<a class="hash-link" href="#examples" title="Direct link to heading"></a></h3><h4 class="anchor anchorWithStickyNavbar_mojV" id="a-command-with-one-required-argument">A command with one required argument<a class="hash-link" href="#a-command-with-one-required-argument" title="Direct link to heading"></a></h4><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-command <arg1></span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><h4 class="anchor anchorWithStickyNavbar_mojV" id="a-command-with-a-required-argument-and-a-optional-one">A command with a required argument and a optional one<a class="hash-link" href="#a-command-with-a-required-argument-and-a-optional-one" title="Direct link to heading"></a></h4><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-command <arg1> [arg2]</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><h4 class="anchor anchorWithStickyNavbar_mojV" id="a-command-with-arbitrary-amount-of-optional-arguments">A command with arbitrary amount of optional arguments<a class="hash-link" href="#a-command-with-arbitrary-amount-of-optional-arguments" title="Direct link to heading"></a></h4><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-command [args]*</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><h4 class="anchor anchorWithStickyNavbar_mojV" id="a-command-that-takes-neither-or-both-arguments">A command that takes neither or both arguments<a class="hash-link" href="#a-command-that-takes-neither-or-both-arguments" title="Direct link to heading"></a></h4><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-command [<arg1> <arg2>]</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div><h4 class="anchor anchorWithStickyNavbar_mojV" id="a-command-that-only-takes-either-a-or-b">A command that only takes either "a" or "b"<a class="hash-link" href="#a-command-that-only-takes-either-a-or-b" title="Direct link to heading"></a></h4><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#393A34"><span class="token plain">-command <"a"|"b"></span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_wuS7 clean-btn">Copy</button></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/llama-bot/llama-bot-docs/edit/master/docs/2-usage/1-overview.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_dcUD" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_foO9"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/overview"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Overview</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/usage/commands"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Commands</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_cNA8 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#background" class="table-of-contents__link toc-highlight">Background</a><ul><li><a href="#what-even-is-a-discord-bot" class="table-of-contents__link toc-highlight">What even is a discord bot?</a></li><li><a href="#great-now-how-do-i-use-a-bot" class="table-of-contents__link toc-highlight">Great! Now, how do I use a bot?</a></li><li><a href="#commands-are-not-enough" class="table-of-contents__link toc-highlight">Commands are not enough!</a></li></ul></li><li><a href="#how-to-read-the-documentation" class="table-of-contents__link toc-highlight">How to read the documentation</a><ul><li><a href="#required-arguments" class="table-of-contents__link toc-highlight">Required arguments</a></li><li><a href="#optional-arguments" class="table-of-contents__link toc-highlight">Optional arguments</a></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Created by <b>developomp</b>. Built with <a href="https://github.com/facebook/docusaurus">Docusaurus</a>.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.5f110aa0.js"></script>
|
||
<script src="/assets/js/main.b812c6db.js"></script>
|
||
</body>
|
||
</html> |