diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_change_template.md b/.github/PULL_REQUEST_TEMPLATE/docs_change_template.md index 5ac1e510fe..aeddededd1 100644 --- a/.github/PULL_REQUEST_TEMPLATE/docs_change_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/docs_change_template.md @@ -2,7 +2,7 @@ ## Documentation change checklist -- [ ] My documentation changes follow the [docs style guide](https://dpp.dev/docs_standards.html) and any code examples follow the [coding style guide](https://dpp.dev/coding-standards.html). +- [ ] My documentation changes follow the [docs style guide](https://dpp.dev/docs-standards.html) and any code examples follow the [coding style guide](https://dpp.dev/coding-standards.html). - [ ] I tested that my change works before raising the PR (via running `doxygen`, and testing examples). - [ ] I have not moved any existing pages or changed any existing URLs without strong justification as to why. - [ ] I have not generated content using AI or a desktop utility such as grammarly. diff --git a/docpages/04_building_a_bot.md b/docpages/04_building_a_bot.md index 682e5abaaa..ba55d6e50a 100644 --- a/docpages/04_building_a_bot.md +++ b/docpages/04_building_a_bot.md @@ -11,3 +11,4 @@ Click on a link below for a guide specifically for your system: * \subpage buildcmake * \subpage buildmeson * \subpage building-a-cpp-discord-bot-in-repl +* \subpage build-a-bot-xcode diff --git a/docpages/images/xcode_output.png b/docpages/images/xcode_output.png new file mode 100644 index 0000000000..a39e990693 Binary files /dev/null and b/docpages/images/xcode_output.png differ diff --git a/docpages/images/xcode_run.png b/docpages/images/xcode_run.png new file mode 100644 index 0000000000..5f54387092 Binary files /dev/null and b/docpages/images/xcode_run.png differ diff --git a/docpages/images/xcode_token.png b/docpages/images/xcode_token.png new file mode 100644 index 0000000000..7eb901c58b Binary files /dev/null and b/docpages/images/xcode_token.png differ diff --git a/docpages/make_a_bot/xcode.md b/docpages/make_a_bot/xcode.md new file mode 100644 index 0000000000..7247e38b8d --- /dev/null +++ b/docpages/make_a_bot/xcode.md @@ -0,0 +1,21 @@ +\page build-a-bot-xcode Building a Discord Bot using Xcode (OSX) + +\warning This tutorial expects you to have installed D++ via homebrew. If you haven't, please visit \ref install-brew. + +To create a bot with Xcode, follow the steps below to create a *working skeleton project you can build upon*. + +\note Since the brew package for D++ only supports C++17, you can't use coro with this project. If you wish to use coro, you need to \ref buildosx "build from source". If you do build from source, look to replace the include and library paths in this project to `/usr/local/include` and `/usr/local/lib`. + +1. Make sure you have Xcode downloaded, along with the developer command tools (for AppleClang). +2. Clone the [template project](https://github.com/Jaskowicz1/mac-bot-template/). **Make sure you download the entire project and not just the .cpp file.** +3. Open Xcode, hit "Open Existing Project" or "File"->"Open", navigate to the template folder and open the .xcodeproj file. You can also double click the file in Finder. +4. Replace "add your token here" with your bot's token in the "main" file. +\image html xcode_token.png +5. Click the run button to compile and run your bot! +\image html xcode_run.png +6. Observe the output and watch your bot run! You may get warnings in this stage and that's okay! +\image html xcode_output.png + +## Troubleshooting + +- Stuck? You can find us on the [official Discord server](https://discord.gg/dpp) - ask away! We don't bite!