()) {
-
- /* Create a new command. */
- dpp::slashcommand joincommand("join", "Joins your voice channel.", bot.me.id);
-
- dpp::slashcommand playcommand("play", "Plays an ogg file.", bot.me.id);
-
- bot.global_bulk_command_create({joincommand, playcommand});
- }
- });
-
- /* Start bot */
- bot.start(dpp::st_wait);
-
- return 0;
-}
-~~~~~~~~~~~~~~~~~~~~~~~~~
+\include{cpp} oggopus.cpp
You can compile this example using the following command
- c++ /path/to/source.cc -ldpp -lopus -lopusfile -logg -I/usr/include/opus
+```bash
+c++ /path/to/source.cc -ldpp -lopus -lopusfile -logg -I/usr/include/opus
+```
## Using liboggz
@@ -194,8 +16,10 @@ You can use `liboggz` to stream an Ogg Opus file to discord voice channel.
`liboggz` provides higher level abstraction and useful APIs. Some features `liboggz` provides include: seeking and timestamp interpretation.
Read more on the [documentation](https://www.xiph.org/oggz/doc/).
-\include{cpp} oggopus.cpp
+\include{cpp} oggopus2.cpp
You can compile this example using the following command:
- c++ /path/to/source.cc -ldpp -loggz
\ No newline at end of file
+```bash
+c++ /path/to/source.cc -ldpp -loggz
+```
\ No newline at end of file
diff --git a/docpages/example_programs/music_and_audio/record_user.md b/docpages/example_programs/music_and_audio/record_user.md
index 022680d82c..ce113890c1 100644
--- a/docpages/example_programs/music_and_audio/record_user.md
+++ b/docpages/example_programs/music_and_audio/record_user.md
@@ -1,7 +1,7 @@
-\page record-user Record yourself in a VC
+\page record-user Record Yourself in a VC
-DPP supports receiving audio. This examples show how to use it to record some user in a VC.
+DPP supports receiving audio. This example shows how to use it to record some user in a VC.
-\note Voice receiving by bots is not officially supported by the Discord API. We cannot guarantee that this feature will work in the future.
+\note Voice receiving by bots is not officially supported by the Discord API. We cannot guarantee that this feature will work in the future.
\include{cpp} record_user.cpp
diff --git a/docpages/example_programs/music_and_audio/soundboard.md b/docpages/example_programs/music_and_audio/soundboard.md
index 52818f6cab..98ea563161 100644
--- a/docpages/example_programs/music_and_audio/soundboard.md
+++ b/docpages/example_programs/music_and_audio/soundboard.md
@@ -1,5 +1,5 @@
\page soundboard Creating a Sound Board
-This example script shows how to send a sound file to a voice channel. A few shortcuts are taken here, for more advanced techniques for connecting to a voice channel see the tutorial \ref joinvc
+This example script shows how to send a sound file to a voice channel. A few shortcuts are taken here, for more advanced techniques for connecting to a voice channel see the tutorial \ref joinvc .
\include{cpp} soundboard.cpp
\ No newline at end of file
diff --git a/docpages/example_programs/the_basics.md b/docpages/example_programs/the_basics.md
index be54d97478..9bf2e060d1 100644
--- a/docpages/example_programs/the_basics.md
+++ b/docpages/example_programs/the_basics.md
@@ -2,11 +2,11 @@
These example programs are great to get started with simple things in the D++ library, ideal for beginners to the language or to the Discord API.
-* \subpage firstbot "Creating Your First Bot"
-* \subpage embed-message "Sending Embeds"
+* \subpage firstbot
+* \subpage embed-message
* \subpage private-messaging
-* \subpage attach-file "Attaching a file"
-* \subpage webhooks "Webhooks"
-* \subpage callback-functions "Using Callback Functions"
+* \subpage attach-file
+* \subpage webhooks
+* \subpage callback-functions
* \subpage using-cache
-* \subpage detecting-messages "Listening to messages"
+* \subpage detecting-messages
diff --git a/docpages/example_programs/the_basics/attachments.md b/docpages/example_programs/the_basics/attachments.md
index 1a3668ae18..2d115943cd 100644
--- a/docpages/example_programs/the_basics/attachments.md
+++ b/docpages/example_programs/the_basics/attachments.md
@@ -1,20 +1,16 @@
-\page attach-file Attaching a file to a message
+\page attach-file Attaching a File to a Message
-Attached files must be locally stored.
+To attach a local file to an message, you can use dpp::utility::read_file. It's a helper function from D++ that allows you to read the file's content and sent it to discord.
-To attach a file to a message, you can upload a local image.
-
-D++ has this helper function to read a file: dpp::utility::read_file.
-
-An example program:
+An example of this:
\include{cpp} attachments1.cpp
-Attachments via an url aren't possible. But there's a workaround for. You can download the file and then attach it to the message.
+Attachments via URL aren't possible. But there's a workaround for this! You can download the file and then attach it to the message.
-To make requests, D++ also has a helper function: dpp::cluster::request.
+Amazingly, D++ also has a function for this! You can use dpp::cluster::request to make HTTP requests, allowing you to go ahead and pull the content from a URL.
-The following example program shows how to request a file and attach it to a message.
+The following example program shows how to request a file and attach it to a message:
\include{cpp} attachments2.cpp
diff --git a/docpages/example_programs/the_basics/firstbot.md b/docpages/example_programs/the_basics/firstbot.md
index 76037907c5..c0b4296a49 100644
--- a/docpages/example_programs/the_basics/firstbot.md
+++ b/docpages/example_programs/the_basics/firstbot.md
@@ -17,12 +17,11 @@ The two programs can be seen side by side below:
|
-
-~~~~~~~~~~~~~~~{.js}
+~~~~~~~~~~~~~~~js
let Discord = require('discord.js');
-let BOT_TOKEN = 'add your token here';
+let BOT_TOKEN = 'add your token here';
let bot = new Discord.Client({ intents: [] });
@@ -42,24 +41,22 @@ bot.once('ready', async () => {
});
});
-
bot.login(BOT_TOKEN);
~~~~~~~~~~~~~~~
-
|
Let's break this program down step by step:
-### 1. Start with an empty C++ program
+## 1. Start with an empty C++ program
-Make sure to include the header file for the D++ library with the instruction \#include ``!
+Make sure to include the header file for the D++ library with the instruction `#include `!
\include{cpp} firstbot1.cpp
-### 2. Create an instance of dpp::cluster
+## 2. Create an instance of dpp::cluster
To make use of the library you must create a dpp::cluster object. This object is the main object in your program like the `Discord.Client` object in Discord.js.
@@ -67,21 +64,19 @@ You can instantiate this class as shown below. Remember to put your bot token in
\include{cpp} firstbot2.cpp
-### 3. Attach to an event
+## 3. Attach to an event
-To have a bot that does something, you should attach to some events. Let's start by attaching to the `on_ready` event (dpp::cluster::on_ready) which will notify your program when the bot is connected. In this event, we will register a slash
-command called 'ping'. Note that we must wrap our registration of the command in a template called dpp::run_once which prevents it from being re-run
-every time your bot does a full reconnection (e.g. if the connection fails).
+To have a bot that does something, you should attach to some events. Let's start by attaching to the `on_ready` event (dpp::cluster::on_ready) which will notify your program when the bot is connected. In this event, we will register a slash command called 'ping'. Note that we must wrap our registration of the command in a template called dpp::run_once which prevents it from being re-run every time your bot does a full reconnection (e.g. if the connection fails).
\include{cpp} firstbot3.cpp
-### 4. Attach to another event to receive slash commands
+## 4. Attach to another event to receive slash commands
If you want to handle a slash command, you should also attach your program to the `on_slashcommand` event (dpp::cluster::on_slashcommand) which is basically the same as the Discord.js `interactionCreate` event. Lets add this to the program before the `on_ready` event:
\include{cpp} firstbot4.cpp
-### 5 . Add some content to the events
+## 5. Add some content to the events
Attaching to an event is a good start, but to make a bot you should actually put some program code into the interaction event. We will add some code to the `on_slashcommand` to look for our slash command '/ping' and reply with `Pong!`:
@@ -89,7 +84,7 @@ Attaching to an event is a good start, but to make a bot you should actually put
Let's break down the code in the `on_slashcommand` event so that we can discuss what it is doing:
-~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
+~~~~~~~~~~~~~~~~~~~~~~~cpp
bot.on_slashcommand([](const dpp::slashcommand_t& event) {
if (event.command.get_command_name() == "ping") {
event.reply("Pong!");
@@ -101,27 +96,29 @@ This code is simply comparing the command name `event.command.get_command_name()
The `event.reply` function (dpp::slashcommand_t::reply) replies to a slash command with a message. There are many ways to call this function to send embed messages, upload files, and more, but for this simple demonstration we will just send some message text.
-### 6. Add code to start the bot!
+## 6. Add code to start the bot!
To make the bot start, we must call the dpp::cluster::start method, e.g. in our program by using `bot.start(dpp::st_wait)`.
We also add a line to tell the library to output all its log information to the console, `bot.on_log(dpp::utility::cout_logger());` - if you wanted to do something more advanced, you can replace this parameter with a lambda just like all other events.
-The parameter which we set to false indicates if the function should return once all shards are created. Passing `false` here tells the program you do not need to do anything once `bot.start` is called.
+The parameter which we set to false indicates if the function should return once all shards are created. Passing dpp::st_wait here tells the program you do not need to do anything once `bot.start` is called.
\include{cpp} firstbot6.cpp
-### 7. Compile and run your bot
+## 7. Compile and run your bot
Compile your bot using `g++ -std=c++17 -o bot bot.cpp -ldpp` (if your .cpp file is called `bot.cpp`) and run it with `./bot`.
-### 8. Inviting your bot to your server
+## 8. Inviting your bot to your server
When you invite your bot, you must use the `applications.commands` and `bots` scopes to ensure your bot can create guild slash commands. For example:
-`https://discord.com/oauth2/authorize?client_id=YOUR-BOTS-ID-HERE&scope=bot+applications.commands&permissions=BOT-PERMISSIONS-HERE`
+```url
+https://discord.com/oauth2/authorize?client_id=YOUR-BOTS-ID-HERE&scope=bot+applications.commands&permissions=BOT-PERMISSIONS-HERE
+```
Replace `YOUR-BOTS-ID-HERE` with your bot's user ID, and `BOT-PERMISSIONS-HERE` with the permissions your bot requires.
-**Congratulations** - you now have a working bot written using the D++ library!
+**Congratulations** - you now have a working bot using the D++ library!
diff --git a/docpages/install/install-arch-aur.md b/docpages/install/install-arch-aur.md
index 041216e129..2e76432ae0 100644
--- a/docpages/install/install-arch-aur.md
+++ b/docpages/install/install-arch-aur.md
@@ -2,15 +2,15 @@
To install [D++ from AUR](https://aur.archlinux.org/packages/dpp), follow the steps below (as root):
-```
+```bash
git clone https://aur.archlinux.org/dpp.git
cd dpp
makepkg -si
```
-or use your favorite package manager:
+or use your favourite package manager:
-```sh
+```bash
# example with `yay` (without root)
yay -Sy dpp
```
@@ -23,7 +23,7 @@ This will do the following three things:
You will now be able to use D++ by including its library on the command line:
-```
+```bash
g++ mybot.cpp -o mybot -ldpp
```
diff --git a/docpages/install/install-linux-deb.md b/docpages/install/install-linux-deb.md
index 6ffb75da67..8751b83fee 100644
--- a/docpages/install/install-linux-deb.md
+++ b/docpages/install/install-linux-deb.md
@@ -1,8 +1,8 @@
-\page install-linux-deb Installing from a .deb file (Debian, Ubuntu, Derivatives)
+\page install-linux-deb Installing from a .deb file (Debian, Ubuntu, and Derivatives)
To install D++ on a system from `.deb` using `dpkg` (as root):
-```
+```bash
apt install wget
wget -O dpp.deb https://dl.dpp.dev/
dpkg -i dpp.deb
@@ -16,7 +16,7 @@ This will do the following three things:
You will now be able to use D++ by including its library on the command line:
-```
+```bash
g++ mybot.cpp -o mybot -ldpp
```
diff --git a/docpages/install/install-linux-rpm.md b/docpages/install/install-linux-rpm.md
index a5faea8350..1b2a739482 100644
--- a/docpages/install/install-linux-rpm.md
+++ b/docpages/install/install-linux-rpm.md
@@ -1,8 +1,8 @@
-\page install-linux-rpm Installing from a .rpm file (RedHat, CentOS and derivatives)
+\page install-linux-rpm Installing from a .rpm file (RedHat, CentOS and Derivatives)
To install D++ on a system from `.rpm` using `yum` (as root):
-```
+```bash
yum install wget
wget -O dpp.rpm https://dl.dpp.dev/latest/linux-x64/rpm
yum localinstall dpp.rpm
@@ -16,6 +16,8 @@ This will do the following three things:
You will now be able to use D++ by including its library on the command line:
-```
+```bash
g++ mybot.cpp -o mybot -ldpp
-```
\ No newline at end of file
+```
+
+\include{doc} install_prebuilt_footer.dox
diff --git a/docpages/install/install-vcpkg.md b/docpages/install/install-vcpkg.md
index 8ffcb00d78..80717d578e 100644
--- a/docpages/install/install-vcpkg.md
+++ b/docpages/install/install-vcpkg.md
@@ -11,11 +11,14 @@ To install D++ on a system with VCPKG:
- VCPKG will install the library, and dependencies, for you! Once completed, you will receive a message, indicating that dpp successfully installed!
- Use `vcpkg list dpp` to check that the package is installed, as so:
+
```cmd
c:\vcpkg>vcpkg list dpp
dpp:x64-windows 10.0.24 D++ Extremely Lightweight C++ Discord Library.
```
+
- You may now use the library within a `CMake` based project by adding instructions such as these to your `CMakeLists.txt`:
+
```cmake
find_package(dpp CONFIG REQUIRED)
target_link_libraries(your_target_name PRIVATE dpp::dpp)
diff --git a/docpages/install/install-windows-clion-vcpkg.md b/docpages/install/install-windows-clion-vcpkg.md
index 66a65a4f5b..1a1ea9a94f 100644
--- a/docpages/install/install-windows-clion-vcpkg.md
+++ b/docpages/install/install-windows-clion-vcpkg.md
@@ -1,36 +1,38 @@
-\page install-windows-clion-vcpkg Installing from vcpkg for CLion
+\page install-windows-clion-vcpkg Installing D++ for CLion via VCPKG (Windows)
-To add D++ to a CLion project, you need obtain the library through vcpkg and then configure your CLion project and `CMakeLists.txt`.
+\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/)
-1. Build [vcpkg](https://vcpkg.io/) on your system (skip if you already have it).
-2. Run `vcpkg install dpp:x64-windows` (replace x64-windows with whichever OS and architecture you want the library to be built for).
-3. vcpkg will install the library along with the dependencies for you.
+To add D++ to a CLion project, you need obtain the library through VCPKG and then configure your CLion project and `CMakeLists.txt`.
+
+1. Build [VCPKG](https://vcpkg.io/) on your system (skip if you already have it).
+2. Run `vcpkg install dpp:x64-windows`.
+3. VCPKG will install the library along with the dependencies for you.
4. Now check if dpp has been installed using `vcpkg list dpp`.
- ```
- C:/vcpkg>vcpkg list dpp
- dpp:x64-windows 10.0.23 D++ Extremely Lightweight C++ Discord Library.
- ```
+```cmd
+C:/vcpkg>vcpkg list dpp
+dpp:x64-windows 10.0.23 D++ Extremely Lightweight C++ Discord Library.
+```
5. To use vcpkg in CLion, add the following line to your CMake options in the settings (Located under Settings > Build, Execution, Deployment > CMake)
- ```
- -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_root_folder/scripts/buildsystems/vcpkg.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:
- ```
- -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
- ```
+```cmd
+-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
+```
6. Now proceed to add the following lines to your `CMakeLists.txt`:
- ```cmake
- find_package(dpp CONFIG REQUIRED)
- target_link_libraries(main PRIVATE dpp::dpp)
- target_include_directories(main PRIVATE path_to_vcpkg_root_folder/installed/architecture-os/include)
- ```
- For example, if built for x64-windows and vcpkg root is `C:/vcpkg/` then your `CMakeLists.txt` should look like this:
- ```cmake
- find_package(dpp CONFIG REQUIRED)
- target_link_libraries(main PRIVATE dpp::dpp)
- target_include_directories(main PRIVATE C:/vcpkg/installed/x64-windows/include)
- ```
+```cmake
+find_package(dpp CONFIG REQUIRED)
+target_link_libraries(main PRIVATE dpp::dpp)
+target_include_directories(main PRIVATE path_to_vcpkg_root_folder/installed/architecture-os/include)
+```
+ For example, if your VCPKG root is `C:/vcpkg/`, then your `CMakeLists.txt` should look like this:
+```cmake
+find_package(dpp CONFIG REQUIRED)
+target_link_libraries(main PRIVATE dpp::dpp)
+target_include_directories(main PRIVATE C:/vcpkg/installed/x64-windows/include)
+```
7. Congratulations! Now try to build a test program to see if the installation succeeded. If you get stuck somewhere, feel free to ask us on the D++ [discord server](https://discord.gg/dpp).
\ No newline at end of file
diff --git a/docpages/install/install-windows-vs-zip.md b/docpages/install/install-windows-vs-zip.md
index 3bf5a10885..e55254bca6 100644
--- a/docpages/install/install-windows-vs-zip.md
+++ b/docpages/install/install-windows-vs-zip.md
@@ -2,41 +2,55 @@
To add D++ to a Visual Studio project, using **Visual Studio 2019** or **Visual Studio 2022**, follow the steps below. The steps below assume an empty project, if you are adding to an existing project simply skip steps 1 through 4, and step 13.
-\note It is possible to skip this entire tutorial, and obtain a [pre-made visual studio template containing the latest D++ build (for 32 and 64 bit, release and debug profiles) by clicking here](https://github.com/brainboxdotcc/windows-bot-template/).
+\note It is possible to skip this entire tutorial, and obtain a [pre-made Visual Studio template containing the latest D++ build (for 32 and 64 bit, release and debug profiles) by clicking here](https://github.com/brainboxdotcc/windows-bot-template/).
1. Make sure you have Visual Studio 2019 or 2022. Community, Professional or Enterprise work fine. These instructions are not for Visual Studio Code. You can [download the correct version here](https://visualstudio.microsoft.com/downloads/). Note that older versions of Visual Studio will not work as they do not support enough of the C++17 standard.
-2. Start visual studio and choose to create a new project
- \image html zip_vsproj_1.png
+
+2. Start Visual Studio and choose to create a new project
+\image html zip_vsproj_1.png
+
3. Choose the project type "Console Project" and click next
- \image html zip_vsproj_2.png
-4. Name your bot project. In this example i just chose the name 'MyBot'. You can have any name you like here.
- \image html zip_vsproj_3.png
-5. Open the zip file you downloaded which contains the D++ dlls, include files and lib file. Drag and drop this to your local machine and make note of where you placed it. This location will be important in later steps.
- \image html zip_vsproj_4.png
-6. Back inside visual studio, right click on the project (not solution!) in the tree in your visual studio window. choose 'Properties'.
- \image html zip_vsproj_5.png
+\image html zip_vsproj_2.png
+
+4. Name your bot project. In this example, we'll use the name 'MyBot'. You can have any name you like here.
+\image html zip_vsproj_3.png
+
+5. Open the zip file you downloaded which contains the D++ DLLs, include files, and lib file. Drag and drop this to your local machine and make note of where you placed it. This location will be important in later steps.
+\image html zip_vsproj_4.png
+
+6. Back inside Visual Studio, right click on the project (not solution!) in the tree in your Visual Studio window. choose 'Properties'.
+\image html zip_vsproj_5.png
+
7. The next step is to populate the include directories and library directories sections with the paths to the D++ library and include files. The next steps will guide you through how to do this.
- \image html zip_vsproj_6.png
+\image html zip_vsproj_6.png
+
8. Click 'edit' when prompted to edit the include paths section. Add the path to the include folder you extracted to your machine, which we took note of earlier. Note that it is important to add the dpp-10.0 folder, not any other folder, to this list:
- \image html zip_vsproj_7.png
-9. Going back to the previous window, now edit the library paths. Again click 'edit' when prompted to edit the library paths section. Add the path to the library folder you extracted to your machine, which we took note of earlier. Note that once more it is important to add the dpp-9.0 folder within it, not any other folder, to this list. Also be aware this is a **different folder** than the one you just added for includes!
- \image html zip_vsproj_8.png
+\image html zip_vsproj_7.png
+
+9. Going back to the previous window, now edit the library paths. Again click 'edit' when prompted to edit the library paths section. Add the path to the library folder you extracted to your machine, which we took note of earlier. Note that once more it is important to add the dpp-10.0 folder within it, not any other folder, to this list. Also be aware this is a **different folder** than the one you just added for includes!
+\image html zip_vsproj_8.png
+
10. Double check at this point that all the directories are filled in correctly. They should look generally like the ones in the screenshot below:
- \image html zip_vsproj_9.png
-11. Go to the general section in the same window now, and look for the drop down list labelled "C++ Language Standard". Make sure the selected option is **C++17 Standard (/std:c++17)**
- \image html zip_vsproj_10.png
+\image html zip_vsproj_9.png
+
+11. Go to the general section in the same window now, and look for the drop down list labelled "C++ Language Standard". Make sure the selected option is **C++17 Standard (/std:c++17)** or later.
+\image html zip_vsproj_10.png
+
12. Again within the same window, go to the input section, under the linker category, and add '**dpp.lib;**' to the start of the libraries to include, as shown below:
- \image html zip_vsproj_11.png
-13. Now you can paste some code into the editor, completely replacing the 'hello world' application that visual studio made for you. The example code here is the basic bot from the first example on this site. You should at this point also double check that the architecture you have selected (in this case x86) matches the version of the dll/lib files you downloaded from the website. This is **important** as if you mismatch them the compilation will just fail.
- \image html zip_vsproj_12.png
+\image html zip_vsproj_11.png
+
+13. Now you can paste some code into the editor, completely replacing the 'hello world' application that Visual Studio made for you. The example code here is the basic bot from the first example on this site. You should at this point also double check that the architecture you have selected (in this case x86) matches the version of the dll/lib files you downloaded from the website. This is **important** as if you mismatch them the compilation will just fail.
+\image html zip_vsproj_12.png
+
14. Go to the build menu and choose Build Solution (A handy shortcut for this is to just press **F7**):
- \image html zip_vsproj_13.png
+\image html zip_vsproj_13.png
+
15. Observe the build output. There may be warnings, but so long as the build output ends with "1 succeeded" then the process has worked. You may now run your bot!
- \image html zip_vsproj_14.png
+\image html zip_vsproj_14.png
## Troubleshooting
-- If you get an error that a dll is missing (e.g. `dpp.dll` or `opus.dll`) when starting your bot, then simply copy all dlls from the **bin** 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: `dpp.dll`, `zlib.dll`, `openssl.dll` and `libcrypto.dll` (or similarly named SSL related files), `libsodium.dll` and `opus.dll`.
+- If you get an error that a DLL is missing (e.g. `dpp.dll` or `opus.dll`) when starting your bot, then simply copy all DLLs from the **bin** directory of where you extracted the D++ 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: `dpp.dll`, `zlib.dll`, `openssl.dll` and `libcrypto.dll` (or similarly named SSL related files), `libsodium.dll` and `opus.dll`.
- Please note that if you change the architecture (step 13) you must reconfigure all of steps 7 through 12 again as these configurations are specific to each architecture. This is to allow for different sets of precompiled libs, e.g. for `x86`, `x64`, etc.
- You should run your bot from a command prompt. If you do not, and it exits, you will not be able to see any output as the window will immediately close.
- If you need to update the `opus.dll` or `zlib.dll` (or any other prebuilt dll) these can be obtained by requesting them to be installed via `vcpkg` then copying the dlls, libraries and headers from the vcpkg `install` folder.
diff --git a/docpages/install/install-xmake.md b/docpages/install/install-xmake.md
index d46091cc15..f89398dec0 100644
--- a/docpages/install/install-xmake.md
+++ b/docpages/install/install-xmake.md
@@ -1,12 +1,12 @@
-\page install-xmake Installing from xmake
+\page install-xmake Installing from XMake
To install D++ on a project from XMake:
- Ensure XMake [is correctly installed](https://xmake.io/#/guide/installation)
-- Create a new xmake project if you haven't already one, using `xmake init `
+- Create a new XMake project if you haven't already one, using `xmake init `
- Update the `xmake.lua` file by adding the `dpp` package, below the minimum configuration:
-~~~~~~~~~~~{.cmake}
+~~~~~~~~~~~lua
add_rules("mode.debug", "mode.release")
add_requires("dpp")