Skip to content

Commit

Permalink
docs: renamed and moved clion-vcpkg to building_a_bot
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaskowicz1 committed Mar 28, 2024
1 parent abf944e commit 618a6bd
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 63 deletions.
1 change: 0 additions & 1 deletion docpages/03_installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ There are many ways to install D++, either from a package manager, or from sourc
* \subpage install-vcpkg
* \subpage install-arch-aur
* \subpage install-windows-vs-zip
* \subpage install-windows-clion-vcpkg
* \subpage install-xmake
* \subpage install-brew
* \subpage install-from-source
1 change: 1 addition & 0 deletions docpages/04_building_a_bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Click on a link below for a guide specifically for your system:
* \subpage creating-a-bot-application
* \subpage build-a-discord-bot-windows-visual-studio
* \subpage build-a-discord-bot-windows-wsl
* \subpage install-windows-clion-vcpkg
* \subpage build-a-discord-bot-linux-clion
* \subpage buildcmake
* \subpage buildmeson
Expand Down
62 changes: 0 additions & 62 deletions docpages/install/install-windows-clion-vcpkg.md

This file was deleted.

42 changes: 42 additions & 0 deletions docpages/make_a_bot/clion_windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
\page install-windows-clion-vcpkg Building a Discord Bot using CLion & VCPKG (Windows)

\warning This page is for **Windows only**. If you want to use CLion on Linux, look to use \ref build-a-discord-bot-linux-clion "this page". Like always with windows, we highly recommends you use the [pre-made Visual Studio template](https://github.com/brainboxdotcc/windows-bot-template/). This tutorial also assumes you have installed D++ via VCPKG already. If you haven't, look at \ref install-vcpkg "this page".

### Changing Toolchains

\note If you have already configured your toolchain to use anything **but** MinGW64, then you can skip to the next section. Otherwise, it is **critical** that you follow along with this section. It should also be noted that you **need** Visual Studio for this.

Head on over to `File > Settings` (Ctrl+Alt+S), then navigate to `Build, Execution, Deployment > Toolchains`.

If there is a Visual Studio toolchain there, drag it to the top of the list. This will make the Visual Studio toolchain the default toolchain.

\image html clionvstoolchain.png

If you don't have the Visual Studio toolchain, you can hit the plus symbol above the list of toolchains and add a toolchain. This is also how you can add WSL as a toolchain!

\image html clionvstoolchain2.png

From there, you need to drag it to the top (if it didn't already add at the top) to ensure it's the default toolchain.

### Using VCPKG with CLion

To use vcpkg in CLion, add the following line to your CMake options in the settings (Located under `Settings > Build, Execution, Deployment > CMake`)
```cmd
-DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_root_folder/scripts/buildsystems/vcpkg.cmake
```
For example, if your root folder is `C:/vcpkg/` then the CMake option will be:
```cmd
-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
```

### Making a test application.

Open your `main.cpp` file and then copy and paste the following \ref firstbot "example program" in. Then, set your bot token (see \ref creating-a-bot-application). Here's how your `main.cpp` file should look:

\include{cpp} firstbot.cpp

If everything went well, you should now have a functioning bot! If not, feel free to ask us on the D++ [discord server](https://discord.gg/dpp).

### Troubleshooting

If you see a message like `Detecting C compiler ABI info - failed` or something along the lines of `"cl.exe" is not able to compile a simple test program`, then try to reinstall `Windows Build Tools` along with the `Windows SDK` from the Visual Studio Installer.

0 comments on commit 618a6bd

Please sign in to comment.