Skip to content

Commit

Permalink
automatic commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Deployment Bot committed Aug 20, 2023
1 parent d472f99 commit fae4f51
Show file tree
Hide file tree
Showing 207 changed files with 4,255 additions and 2,710 deletions.
4 changes: 2 additions & 2 deletions application-command-autocomplete.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<div class="line">}</div>
<div class="ttc" id="aclassdpp_1_1cluster_html"><div class="ttname"><a href="classdpp_1_1cluster.html">dpp::cluster</a></div><div class="ttdoc">The cluster class represents a group of shards and a command queue for sending and receiving commands...</div><div class="ttdef"><b>Definition:</b> cluster.h:84</div></div>
<div class="ttc" id="aclassdpp_1_1interaction_html_aabbb8d58d708128098516ed443d5c140"><div class="ttname"><a href="classdpp_1_1interaction.html#aabbb8d58d708128098516ed443d5c140">dpp::interaction::get_command_name</a></div><div class="ttdeci">std::string get_command_name() const</div><div class="ttdoc">Get the command name for a command interaction.</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:992</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:999</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html_a3959f3f3b2709c56e03610e6f774e449"><div class="ttname"><a href="classdpp_1_1slashcommand.html#a3959f3f3b2709c56e03610e6f774e449">dpp::slashcommand::add_option</a></div><div class="ttdeci">slashcommand &amp; add_option(const command_option &amp;o)</div><div class="ttdoc">Add an option (parameter)</div></div>
<div class="ttc" id="anamespacedpp_1_1utility_html_a8c2cc04bb80ffd287b376d5977899277"><div class="ttname"><a href="namespacedpp_1_1utility.html#a8c2cc04bb80ffd287b376d5977899277">dpp::utility::cout_logger</a></div><div class="ttdeci">std::function&lt; void(const dpp::log_t &amp;)&gt; DPP_EXPORT cout_logger()</div><div class="ttdoc">Get a default logger that outputs to std::cout. e.g.</div></div>
<div class="ttc" id="anamespacedpp_html_abc401d86119c6443bf72d736857c1a58acd751201efe224973dfe952d8658a384"><div class="ttname"><a href="namespacedpp.html#abc401d86119c6443bf72d736857c1a58acd751201efe224973dfe952d8658a384">dpp::co_string</a></div><div class="ttdeci">@ co_string</div><div class="ttdef"><b>Definition:</b> appcommand.h:55</div></div>
Expand All @@ -188,7 +188,7 @@
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_03_example_programs.html">Example Programs</a></li><li class="navelem"><a class="el" href="interactions-and-components.html">Interactions And Components</a></li>
<li class="navelem"><a class="el" href="md_docpages_05_example_programs.html">Example Programs</a></li><li class="navelem"><a class="el" href="interactions-and-components.html">Interactions And Components</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
4 changes: 2 additions & 2 deletions attach-file.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
<div class="line">}</div>
<div class="ttc" id="aclassdpp_1_1cluster_html"><div class="ttname"><a href="classdpp_1_1cluster.html">dpp::cluster</a></div><div class="ttdoc">The cluster class represents a group of shards and a command queue for sending and receiving commands...</div><div class="ttdef"><b>Definition:</b> cluster.h:84</div></div>
<div class="ttc" id="aclassdpp_1_1interaction_html_aabbb8d58d708128098516ed443d5c140"><div class="ttname"><a href="classdpp_1_1interaction.html#aabbb8d58d708128098516ed443d5c140">dpp::interaction::get_command_name</a></div><div class="ttdeci">std::string get_command_name() const</div><div class="ttdoc">Get the command name for a command interaction.</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:992</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:999</div></div>
<div class="ttc" id="anamespacedpp_1_1utility_html_a8c2cc04bb80ffd287b376d5977899277"><div class="ttname"><a href="namespacedpp_1_1utility.html#a8c2cc04bb80ffd287b376d5977899277">dpp::utility::cout_logger</a></div><div class="ttdeci">std::function&lt; void(const dpp::log_t &amp;)&gt; DPP_EXPORT cout_logger()</div><div class="ttdoc">Get a default logger that outputs to std::cout. e.g.</div></div>
<div class="ttc" id="anamespacedpp_html_af447e04d0490cd4a9de085e4a758faa4a155f7db65696b4c09b5fcc41787e4726"><div class="ttname"><a href="namespacedpp.html#af447e04d0490cd4a9de085e4a758faa4a155f7db65696b4c09b5fcc41787e4726">dpp::st_wait</a></div><div class="ttdeci">@ st_wait</div><div class="ttdoc">Wait forever on a condition variable. The cluster will spawn threads for each shard and start() will ...</div><div class="ttdef"><b>Definition:</b> cluster.h:67</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:585</div></div>
Expand Down Expand Up @@ -239,7 +239,7 @@
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_03_example_programs.html">Example Programs</a></li><li class="navelem"><a class="el" href="the-basics.html">The Basics</a></li>
<li class="navelem"><a class="el" href="md_docpages_05_example_programs.html">Example Programs</a></li><li class="navelem"><a class="el" href="the-basics.html">The Basics</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
12 changes: 6 additions & 6 deletions automating-with-jenkins.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,14 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>This page does NOT go into explaining how to install Jenkins, nor how to initally setup Jenkins. This is a tutorial for the CMake version with Linux (more specifically Ubuntu 22.04 LTS). If you don't know how to use CMake or you don't use CMake for your bot (and would like to) then please visit <a href="/buildcmake.html">Building a Discord Bot using CMake/Unix</a>. If you wish to automate this tutorial from GitHub pushes then you can simply download the GitHub plugin for Jenkins, set that up and this tutorial will still work as this tutorial will only build what it can see!</dd></dl>
<h3><a class="anchor" id="autotoc_md35"></a>
<h3><a class="anchor" id="autotoc_md37"></a>
Getting started</h3>
<p >First of all, you'll want to create your project. For this, we'll use a Freestyle project as we're just going to be called some bash commands to tell CMake to build. We'll be calling this "DiscordBot" but you can name is whatever you want (I would advise against non-ascii characters).</p>
<div class="image">
<img src="jenkinsproject.png" alt=""/>
</div>
<p >From here, just hit <code>Ok</code> and you've created your Jenkins project, Well done! From here you can add a description, change the security policy (if your jenkins is public) and whatnot.</p>
<h3><a class="anchor" id="autotoc_md36"></a>
<h3><a class="anchor" id="autotoc_md38"></a>
Automating the building process.</h3>
<p >Scrolling down, you'll find <code>Build Steps</code> (You can also click <code>Build Steps</code> on the left). Here, you'll want to hit <code>Add build step</code> and hit <code>Execute shell</code>.</p>
<div class="image">
Expand All @@ -132,27 +132,27 @@ <h3><a class="anchor" id="autotoc_md36"></a>
<img src="shelljenkins.png" alt=""/>
</div>
<p >Now you can hit save!</p>
<h3><a class="anchor" id="autotoc_md37"></a>
<h3><a class="anchor" id="autotoc_md39"></a>
Seeing the builds work</h3>
<p >Making sure you have your project files in the workspace directory (you can see this by pressing <code>Workspace</code> on the left, the files will automatically be pulled from GitHub if you're using the GitHub plugin), you should be able to hit <code>Build Now</code> and see a new build in the History appear. If everything went well, you should have a green tick!</p>
<dl class="section note"><dt>Note</dt><dd>Building can take a whilst if you haven't setup your build directory before (doing <code>cmake ..</code>), especially on less-powerful machines, so don't be alarmed!</dd></dl>
<div class="image">
<img src="buildhistoryjenkins.png" alt=""/>
</div>
<h3><a class="anchor" id="autotoc_md38"></a>
<h3><a class="anchor" id="autotoc_md40"></a>
Running the build</h3>
<p >Running the builds is the same as any other time, but we'll still cover it! However, we won't cover running it in background and whatnot, that part is completely down to you.</p>
<p >First, you need to get into the jenkins user. If you're like me and don't have the Jenkins user password, you can login with your normal login (that has sudo perms) and do <code>sudo su - jenkins</code>. Once logged in, you'll be in <code>/var/lib/jenkins/</code>. From here, you'll want to do <code>cd workspace/DiscordBot</code> (make sure to replace "DiscordBot" with your bot's name. Remember, you can tab-complete this) and then <code>cd build</code>. Now, you can simply do <code>./DiscordBot</code>!</p>
<p >That's it! Enjoy your automated builds!</p>
<h3><a class="anchor" id="autotoc_md39"></a>
<h3><a class="anchor" id="autotoc_md41"></a>
Possible permission issues</h3>
<p >Sometimes, doing <code>./DiscordBot</code> can end up with an error, saying you don't have permission to execute. If that's the case, simply do <code>chmod +x DiscordBot</code> and now you can re-run <code>./DiscordBot</code>. </p>
</div></div><!-- contents --><script src="https://giscus.app/client.js" data-repo="brainboxdotcc/dpp-comments" data-repo-id="R_kgDOHOY4xg" data-category="General" data-category-id="DIC_kwDOHOY4xs4CRYtj" data-mapping="pathname" data-strict="1" data-reactions-enabled="1" data-emit-metadata="1" data-input-position="top" data-theme="preferred_color_scheme" data-lang="en" data-loading="lazy" crossorigin="anonymous" async></script>
</div><!-- PageDoc -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_04_advanced_reference.html">Advanced Reference</a></li>
<li class="navelem"><a class="el" href="md_docpages_06_advanced_reference.html">Advanced Reference</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
12 changes: 6 additions & 6 deletions build-a-discord-bot-linux-clion.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<div class="textblock"><p >This tutorial teaches you how to create a <em>working skeleton project you can build upon</em>, using the JetBrains-IDE <b><a href="https://www.jetbrains.com/clion/">CLion</a></b>.</p>
<dl class="section note"><dt>Note</dt><dd>This tutorial will use <b>Ubuntu</b>! You might use other Distros if you prefer, but keep in mind the setup process might be different!</dd></dl>
<p>Make sure you have CLion installed and works fine (run a <em>hello-world program</em>). You can <a href="https://www.jetbrains.com/de-de/clion/download/">download CLion here</a>.</p>
<h2><a class="anchor" id="autotoc_md129"></a>
<h2><a class="anchor" id="autotoc_md134"></a>
Setup a project</h2>
<p >Create a new project. Select C++17 as the Language standard, or C++20 if you want something more recent.</p>
<p >We'll use the following file structure as a <em>skeleton project you can build upon</em>: </p><pre class="fragment">- your_project/
Expand All @@ -118,7 +118,7 @@ <h2><a class="anchor" id="autotoc_md129"></a>
<div class="image">
<img src="build-clion-project-structure.png" alt=""/>
</div>
<h3><a class="anchor" id="autotoc_md130"></a>
<h3><a class="anchor" id="autotoc_md135"></a>
Configure CMake file</h3>
<p >Paste this CMake configuration in the <code>CMakeLists.txt</code> and adapt it according to your needs:</p>
<div class="fragment"><div class="line"># minimum CMake version required</div>
Expand Down Expand Up @@ -158,7 +158,7 @@ <h3><a class="anchor" id="autotoc_md130"></a>
<div class="image">
<img src="build-clion-reload-cmake-project.png" alt=""/>
</div>
<h3><a class="anchor" id="autotoc_md131"></a>
<h3><a class="anchor" id="autotoc_md136"></a>
Add an example program</h3>
<p >The next step is to write the bot. Copy and paste the following <a href="https://dpp.dev/firstbot.html">example program</a> in the <code>main.cpp</code> and set your bot token (see <a href="https://dpp.dev/creating-a-bot-application.html">Creating a Bot Token</a>):</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;dpp/dpp.h&gt;</span></div>
Expand Down Expand Up @@ -188,15 +188,15 @@ <h3><a class="anchor" id="autotoc_md131"></a>
<div class="line">}</div>
<div class="ttc" id="aclassdpp_1_1cluster_html"><div class="ttname"><a href="classdpp_1_1cluster.html">dpp::cluster</a></div><div class="ttdoc">The cluster class represents a group of shards and a command queue for sending and receiving commands...</div><div class="ttdef"><b>Definition:</b> cluster.h:84</div></div>
<div class="ttc" id="aclassdpp_1_1interaction_html_aabbb8d58d708128098516ed443d5c140"><div class="ttname"><a href="classdpp_1_1interaction.html#aabbb8d58d708128098516ed443d5c140">dpp::interaction::get_command_name</a></div><div class="ttdeci">std::string get_command_name() const</div><div class="ttdoc">Get the command name for a command interaction.</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:992</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:999</div></div>
<div class="ttc" id="anamespacedpp_1_1utility_html_a8c2cc04bb80ffd287b376d5977899277"><div class="ttname"><a href="namespacedpp_1_1utility.html#a8c2cc04bb80ffd287b376d5977899277">dpp::utility::cout_logger</a></div><div class="ttdeci">std::function&lt; void(const dpp::log_t &amp;)&gt; DPP_EXPORT cout_logger()</div><div class="ttdoc">Get a default logger that outputs to std::cout. e.g.</div></div>
<div class="ttc" id="anamespacedpp_html_af447e04d0490cd4a9de085e4a758faa4a155f7db65696b4c09b5fcc41787e4726"><div class="ttname"><a href="namespacedpp.html#af447e04d0490cd4a9de085e4a758faa4a155f7db65696b4c09b5fcc41787e4726">dpp::st_wait</a></div><div class="ttdeci">@ st_wait</div><div class="ttdoc">Wait forever on a condition variable. The cluster will spawn threads for each shard and start() will ...</div><div class="ttdef"><b>Definition:</b> cluster.h:67</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:585</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:877</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:607</div></div>
</div><!-- fragment --><p >Hit the green "Run" button in the top-right to run the bot.</p>
<p ><b>Congratulations, you've successfully set up a bot!</b></p>
<h2><a class="anchor" id="autotoc_md132"></a>
<h2><a class="anchor" id="autotoc_md137"></a>
Troubleshooting</h2>
<ul>
<li>Stuck? You can find us on the <a href="https://discord.gg/dpp">official discord server</a> - ask away! We don't bite! </li>
Expand All @@ -206,7 +206,7 @@ <h2><a class="anchor" id="autotoc_md132"></a>
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_02_building_a_bot.html">Creating a Discord Bot</a></li>
<li class="navelem"><a class="el" href="md_docpages_04_building_a_bot.html">Creating a Discord Bot</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
4 changes: 2 additions & 2 deletions build-a-discord-bot-windows-visual-studio.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
</div>
</li>
</ol>
<h2><a class="anchor" id="autotoc_md144"></a>
<h2><a class="anchor" id="autotoc_md149"></a>
Troubleshooting</h2>
<ul>
<li>If you get an error that a dll is missing (e.g. <code>dpp.dll</code> or <code>opus.dll</code>) when starting your bot, then simply copy all dlls from the <b>bin</b> directory of where you extracted the DPP zip file to, into the same directory where your bot's executable is. You only need to do this once. There should be several of these dll files: <code>dpp.dll</code>, <code>zlib.dll</code>, <code>openssl.dll</code> and <code>libcrypto.dll</code> (or similarly named SSL related files), <code>libsodium.dll</code> and <code>opus.dll</code>. Note the template project does this for you, so you should never encounter this issue.</li>
Expand All @@ -133,7 +133,7 @@ <h2><a class="anchor" id="autotoc_md144"></a>
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_02_building_a_bot.html">Creating a Discord Bot</a></li>
<li class="navelem"><a class="el" href="md_docpages_04_building_a_bot.html">Creating a Discord Bot</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
2 changes: 1 addition & 1 deletion build-a-discord-bot-windows-wsl.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="md_docpages_02_building_a_bot.html">Creating a Discord Bot</a></li>
<li class="navelem"><a class="el" href="md_docpages_04_building_a_bot.html">Creating a Discord Bot</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
Expand Down
Loading

0 comments on commit fae4f51

Please sign in to comment.