-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
27 lines (27 loc) · 22.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>dbdteamjs</title><meta name="description" content="Documentation for dbdteamjs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">dbdteamjs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>dbdteamjs</h2></div><div class="tsd-panel tsd-typography"><a id="md:dbdteamjs" class="tsd-anchor"></a><h1><a href="#md:dbdteamjs">@dbdteam.js</a></h1><p>✨ Introducing a compact JavaScript library (<a href="https://nodejs.org/en">NodeJS</a> module) designed to streamline the development of Discord bots using the <a href="https://discord.com/developers/docs/intro">Discord API</a>. While it's in its initial stages, your feedback is invaluable. Should you encounter any bugs, please do not hesitate to notify us. Join our <a href="https://www.dbdteam.xyz/discord">official Discord server</a> (alternative <a href="https://discord.gg/FTtVXfj">link here</a>), where you can open a forum in the "support-projects" channel. Our team is committed to providing immediate assistance, ensuring your concerns are promptly addressed (or at least acknowledged). Visit <a href="https://jsdocs.dbdteam.xyz/">our documentation here</a> (actually depracated).</p>
<a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">NPM:</a></h3><p><img src="https://img.shields.io/npm/v/dbdteamjs" alt=""> <img src="https://img.shields.io/npm/dt/dbdteamjs" alt=""></p>
<a id="md:github" class="tsd-anchor"></a><h3><a href="#md:github">GitHub:</a></h3><p><img src="https://img.shields.io/github/stars/DBDTeam/dbdteamjs" alt=""> <img src="https://img.shields.io/github/forks/DBDTeam/dbdteamjs" alt=""></p>
<a id="md:installation" class="tsd-anchor"></a><h1><a href="#md:installation">Installation</a></h1><p>🚀 To integrate this compact package seamlessly into your project, adhere to the following installation procedures tailored for NPM, Yarn, and PNPM package managers under.</p>
<p><strong>NPM</strong></p>
<pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">i</span><span class="hl-1"> </span><span class="hl-0">dbdteamjs</span><span class="hl-1"> </span>
</code><button>Copy</button></pre>
<p>or (this is better)</p>
<pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">i</span><span class="hl-1"> </span><span class="hl-2">github</span><span class="hl-1">:</span><span class="hl-0">DBDTeam</span><span class="hl-1">/</span><span class="hl-0">dbdteamjs</span><span class="hl-1">#</span><span class="hl-3">0.0</span><span class="hl-1">.</span><span class="hl-3">6</span>
</code><button>Copy</button></pre>
<p><strong>YARN</strong></p>
<pre><code><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-0">add</span><span class="hl-1"> @</span><span class="hl-0">dbdteamjs</span>
</code><button>Copy</button></pre>
<p><strong>PNPM</strong> </p>
<pre><code><span class="hl-0">pnpm</span><span class="hl-1"> </span><span class="hl-0">i</span><span class="hl-1"> </span><span class="hl-0">dbdteamjs</span>
</code><button>Copy</button></pre>
<a id="md:starting-to-create-the-bot" class="tsd-anchor"></a><h1><a href="#md:starting-to-create-the-bot">Starting to create the bot</a></h1><p>🎒 Firstly, it is suggested that you please have knowledge of how to create Discord Applications in <a href="https://discord.com/developers/applications">Discord Developers Applications</a>, once you have your application created, follow the following steps (this will be simple, so you should know about Discord Intents too):</p>
<ol>
<li>Get your app token.</li>
<li>Invite your bot to a server.</li>
</ol>
<p>Once you have that done, it's time to start creating the robot using the package. See under.</p>
<a id="md:example-using-messagecontent-intent" class="tsd-anchor"></a><h1><a href="#md:example-using-messagecontent-intent">Example using MessageContent Intent</a></h1><pre><code class="language-javascript"><span class="hl-4">const</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">Client</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">Intents</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">IntentsBitFields</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">PresenceStatus</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">PresenceTypes</span><span class="hl-1"></span><br/><span class="hl-1">} = require("dbdteamjs");</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">$Intents</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">IntentsBitFields</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-0">Guilds</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-0">GuildMembers</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-0">GuildMessages</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-0">MessageContent</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Client</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">token:</span><br/><span class="hl-1"> </span><span class="hl-7">"Here your bot token"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">intents:</span><span class="hl-1"> </span><span class="hl-0">$Intents</span><span class="hl-1">.</span><span class="hl-0">intents</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">gateway:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">mobilePlatform:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-7">"ready"</span><span class="hl-1">, ({ </span><span class="hl-0">username</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-7">`I have successfully logged on to </span><span class="hl-4">${</span><span class="hl-0">username</span><span class="hl-4">}</span><span class="hl-7">`</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-0">presence</span><span class="hl-1">.</span><span class="hl-6">update</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">activities:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">`Hello world!`</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-0">PresenceTypes</span><span class="hl-1">.</span><span class="hl-0">Competing</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-0">since:</span><span class="hl-1"> </span><span class="hl-3">0</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">status:</span><span class="hl-1"> </span><span class="hl-0">PresenceStatus</span><span class="hl-1">.</span><span class="hl-5">DND</span><span class="hl-1">,</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-7">"messageCreate"</span><span class="hl-1">, </span><span class="hl-4">async</span><span class="hl-1">(</span><span class="hl-0">msg</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1">(</span><span class="hl-0">msg</span><span class="hl-1">.</span><span class="hl-0">content</span><span class="hl-1">?.</span><span class="hl-6">toLowerCase</span><span class="hl-1">() === </span><span class="hl-7">"!hi"</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">msg</span><span class="hl-1">.</span><span class="hl-6">reply</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">content:</span><span class="hl-1"> </span><span class="hl-7">`Hi!`</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">connect</span><span class="hl-1">() </span><span class="hl-9">// Will establish the connection between the robot and the WS.</span>
</code><button>Copy</button></pre>
<a id="md:example-using-interactions" class="tsd-anchor"></a><h1><a href="#md:example-using-interactions">Example using Interactions</a></h1><pre><code class="language-javascript"><span class="hl-8">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">Client</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">IntegrationTypes</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">IntentsBitFields</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">InteractionContexts</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">PresenceStatus</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">PresenceTypes</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-8">from</span><span class="hl-1"> </span><span class="hl-7">"dbdteamjs"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">Intents</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">IntentsBitFields</span><span class="hl-1">()</span><br/><br/><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-6">add</span><span class="hl-1">(</span><span class="hl-7">"Guilds"</span><span class="hl-1">)</span><br/><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-6">add</span><span class="hl-1">(</span><span class="hl-7">"GuildMembers"</span><span class="hl-1">)</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Client</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">token:</span><span class="hl-1"> </span><span class="hl-7">`Here your bot token`</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">intents:</span><span class="hl-1"> </span><span class="hl-0">Intents</span><span class="hl-1">.</span><span class="hl-0">intents</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">gateway:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">mobilePlatform:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1"> </span><span class="hl-9">// Only this if you want the robot to have the online icon on a mobile device.</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-7">"ready"</span><span class="hl-1">, () </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-7">`I have successfully logged on to </span><span class="hl-4">${</span><span class="hl-0">client</span><span class="hl-10">.</span><span class="hl-0">user</span><span class="hl-10">.</span><span class="hl-0">username</span><span class="hl-4">}</span><span class="hl-7">`</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-0">presence</span><span class="hl-1">.</span><span class="hl-6">update</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">activities:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">`Hello world!`</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-0">PresenceTypes</span><span class="hl-1">.</span><span class="hl-0">Competing</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ], </span><br/><span class="hl-1"> </span><span class="hl-0">since:</span><span class="hl-1"> </span><span class="hl-3">0</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">status:</span><span class="hl-1"> </span><span class="hl-0">PresenceStatus</span><span class="hl-1">.</span><span class="hl-5">DND</span><span class="hl-1"> </span><span class="hl-9">// This means Do not Disturb</span><br/><span class="hl-1"> })</span><br/><br/><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-0">application</span><span class="hl-1">.</span><span class="hl-0">commands</span><span class="hl-1">.</span><span class="hl-6">set</span><span class="hl-1">(</span><br/><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">"ping"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-7">"Pong!"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">options:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-0">InteractionTypes</span><span class="hl-1">.</span><span class="hl-0">Slash</span><br/><span class="hl-1"> }, </span><span class="hl-9">//You can add more application commands adding it in the array.</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1"> )</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-7">"interactionCreate"</span><span class="hl-1">, </span><span class="hl-4">async</span><span class="hl-1">(</span><span class="hl-0">interaction</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1">(</span><span class="hl-0">interaction</span><span class="hl-1">.</span><span class="hl-0">isSlash</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1">(</span><span class="hl-0">interaction</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-7">"ping"</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-0">interaction</span><span class="hl-1">.</span><span class="hl-6">makeReply</span><span class="hl-1">({ </span><span class="hl-0">content:</span><span class="hl-1"> </span><span class="hl-7">`Pong!</span><span class="hl-11">\n</span><span class="hl-7">Latency: </span><span class="hl-4">${</span><span class="hl-0">client</span><span class="hl-10">.</span><span class="hl-0">ping</span><span class="hl-4">}</span><span class="hl-7">`</span><span class="hl-1"> })</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">connect</span><span class="hl-1">() </span><span class="hl-9">// Will establish the connection between the robot and the WS.</span>
</code><button>Copy</button></pre>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:dbdteamjs"><span>@dbdteam.js</span></a><ul><li><ul><li><a href="#md:npm"><span>NPM:</span></a></li><li><a href="#md:github"><span>Git<wbr/>Hub:</span></a></li></ul></li></ul><a href="#md:installation"><span>Installation</span></a><a href="#md:starting-to-create-the-bot"><span>Starting to create the bot</span></a><a href="#md:example-using-messagecontent-intent"><span>Example using <wbr/>Message<wbr/>Content <wbr/>Intent</span></a><a href="#md:example-using-interactions"><span>Example using <wbr/>Interactions</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>dbdteamjs</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>