├── .circleci └── config.yml ├── .dockerignore ├── .github ├── dependabot.yml └── workflows │ ├── codeql-analysis.yml │ └── docker-image.yml ├── .gitignore ├── CMakeLists.txt ├── CONTRIBUTING.md ├── Dockerfile ├── LICENSE ├── README.md ├── cmake └── FindDPP.cmake ├── include └── templatebot │ └── templatebot.h └── src └── main.cpp /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | jobs: 4 | build: 5 | docker: 6 | - image: "debian:bookworm" 7 | steps: 8 | - checkout 9 | - run: 10 | name: Installing SUDO 11 | command: 'apt-get update && apt-get install -y sudo && rm -rf /var/lib/apt/lists/*' 12 | - run: 13 | name: Installing GCC 14 | command: 'apt-get update && apt-get install -y gcc g++ build-essential git' 15 | - run: 16 | name: Install CMAKE 17 | command: 'apt-get update && apt-get install -y cmake' 18 | - run: 19 | name: Installing other dependencies 20 | command: 'apt-get update && apt-get install -y libssl-dev zlib1g-dev curl wget' 21 | - run: 22 | name: Cloning D++ 23 | command: 'git clone https://github.com/brainboxdotcc/DPP.git' 24 | - run: 25 | name: Creating D++ build files 26 | command: 'cmake -HDPP -BDPP/build' 27 | - run: 28 | name: Building D++ 29 | command: 'cmake --build DPP/build -j 8' 30 | - run: 31 | name: Installing D++ 32 | command: 'cd DPP/build && make install' 33 | - run: 34 | name: Creating Build Files 35 | command: 'cmake -H. -Bbuild' 36 | - run: 37 | name: Creating Binary Files 38 | command: 'cmake --build build -j 8' 39 | 40 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | build/ 2 | out/ 3 | .vs/ 4 | .vscode/ 5 | .idea/ 6 | tmp/ 7 | config.json 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "docker" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | # 7 | # ******** NOTE ******** 8 | # We have attempted to detect the languages in your repository. Please check 9 | # the `language` matrix defined below to confirm you have the correct set of 10 | # supported CodeQL languages. 11 | # 12 | name: "CodeQL" 13 | 14 | on: 15 | push: 16 | branches: [ main ] 17 | pull_request: 18 | # The branches below must be a subset of the branches above 19 | branches: [ main ] 20 | schedule: 21 | - cron: '26 21 * * 0' 22 | 23 | jobs: 24 | analyze: 25 | name: Analyze 26 | runs-on: ubuntu-latest 27 | permissions: 28 | actions: read 29 | contents: read 30 | security-events: write 31 | 32 | strategy: 33 | fail-fast: false 34 | matrix: 35 | language: [ 'cpp' ] 36 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] 37 | # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support 38 | 39 | steps: 40 | - name: Checkout repository 41 | uses: actions/checkout@v3 42 | 43 | # Initializes the CodeQL tools for scanning. 44 | - name: Initialize CodeQL 45 | uses: github/codeql-action/init@v2 46 | with: 47 | languages: ${{ matrix.language }} 48 | # If you wish to specify custom queries, you can do so here or in a config file. 49 | # By default, queries listed here will override any specified in a config file. 50 | # Prefix the list here with "+" to use these queries and those in the config file. 51 | 52 | # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs 53 | # queries: security-extended,security-and-quality 54 | 55 | 56 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 57 | # If this step fails, then you should remove it and run the build manually (see below) 58 | - name: Autobuild 59 | uses: github/codeql-action/autobuild@v2 60 | 61 | # ℹ️ Command-line programs to run using the OS shell. 62 | # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun 63 | 64 | # If the Autobuild fails above, remove it and uncomment the following three lines. 65 | # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. 66 | 67 | # - run: | 68 | # echo "Run, Build Application using script" 69 | # ./location_of_script_within_repo/buildscript.sh 70 | 71 | - name: Perform CodeQL Analysis 72 | uses: github/codeql-action/analyze@v2 73 | -------------------------------------------------------------------------------- /.github/workflows/docker-image.yml: -------------------------------------------------------------------------------- 1 | name: Docker Image CI 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | schedule: 7 | - cron: '0 1 * * *' 8 | 9 | jobs: 10 | docker-build: 11 | runs-on: ubuntu-latest 12 | concurrency: 13 | group: docker-deployment 14 | cancel-in-progress: false 15 | steps: 16 | - 17 | name: Set up QEMU 18 | uses: docker/setup-qemu-action@v1 19 | - 20 | name: Set up Docker Buildx 21 | uses: docker/setup-buildx-action@v1 22 | - 23 | name: Login to DockerHub 24 | uses: docker/login-action@v1 25 | with: 26 | username: ${{ secrets.DOCKERHUB_USERNAME }} 27 | password: ${{ secrets.DOCKERHUB_TOKEN }} 28 | - 29 | name: Login to GitHub Container Registry 30 | uses: docker/login-action@v1 31 | with: 32 | registry: ghcr.io 33 | username: ${{ github.repository_owner }} 34 | password: ${{ secrets.GITHUB_TOKEN }} 35 | - 36 | name: Build and push 37 | uses: docker/build-push-action@v2 38 | with: 39 | push: true 40 | tags: brainboxdotcc/templatebot 41 | - # copy multiplatform image from dockerhub to quay and ghcr 42 | name: Push Image to multiple registries 43 | uses: akhilerm/tag-push-action@v2.0.0 44 | with: 45 | src: docker.io/brainboxdotcc/templatebot:latest 46 | dst: | 47 | ghcr.io/brainboxdotcc/templatebot:latest 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | out/ 3 | .vs/ 4 | .vscode/ 5 | .idea/ 6 | tmp/ 7 | config.json 8 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required (VERSION 3.6) 2 | 3 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) 4 | set(BOT_NAME "templatebot") 5 | 6 | project(${BOT_NAME}) 7 | aux_source_directory("src" coresrc) 8 | add_executable(${BOT_NAME} ${coresrc}) 9 | 10 | string(ASCII 27 Esc) 11 | 12 | set(CMAKE_POSITION_INDEPENDENT_CODE ON) 13 | 14 | set_target_properties(${BOT_NAME} PROPERTIES 15 | CXX_STANDARD 17 16 | CXX_STANDARD_REQUIRED ON 17 | ) 18 | 19 | set(THREADS_PREFER_PTHREAD_FLAG TRUE) 20 | find_package(Threads REQUIRED) 21 | find_package(DPP) 22 | if(APPLE) 23 | if(CMAKE_APPLE_SILICON_PROCESSOR) 24 | set(OPENSSL_ROOT_DIR "/opt/homebrew/opt/openssl") 25 | else() 26 | set(OPENSSL_ROOT_DIR "/usr/local/opt/openssl") 27 | endif() 28 | find_package(OpenSSL REQUIRED) 29 | else() 30 | find_package(OpenSSL REQUIRED) 31 | endif() 32 | 33 | if(NOT CMAKE_SYSTEM_NAME STREQUAL Windows) 34 | set(DL_LIBRARY dl) 35 | endif() 36 | 37 | target_include_directories(${BOT_NAME} PUBLIC 38 | ${CMAKE_CURRENT_SOURCE_DIR}/include 39 | ${OPENSSL_INCLUDE_DIR} 40 | ) 41 | 42 | target_link_libraries(${BOT_NAME} 43 | ${DL_LIBRARY} 44 | ${CMAKE_THREAD_LIBS_INIT} 45 | ${OPENSSL_CRYPTO_LIBRARY} 46 | ${OPENSSL_SSL_LIBRARY} 47 | ) 48 | 49 | if (DPP_FOUND) 50 | target_link_libraries(${BOT_NAME} ${DPP_LIBRARIES}) 51 | target_include_directories(${BOT_NAME} PUBLIC ${DPP_INCLUDE_DIR}) 52 | else() 53 | message(WARNING "Could not find DPP install. Building from source instead.") 54 | option(DPP_BUILD_TEST "" OFF) 55 | include(FetchContent) 56 | 57 | FetchContent_Declare( 58 | libdpp 59 | GIT_REPOSITORY https://github.com/brainboxdotcc/DPP.git 60 | GIT_TAG master) 61 | 62 | FetchContent_GetProperties(libdpp) 63 | if(NOT libdpp_POPULATED) 64 | FetchContent_Populate(libdpp) 65 | target_include_directories(${BOT_NAME} PUBLIC 66 | ${libdpp_SOURCE_DIR}/include 67 | ) 68 | add_subdirectory( 69 | ${libdpp_SOURCE_DIR} 70 | ${libdpp_BINARY_DIR} 71 | EXCLUDE_FROM_ALL) 72 | endif() 73 | 74 | target_link_libraries(${BOT_NAME} dpp) 75 | endif() 76 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Please see the contributing guidelines for [D++](https://github.com/brainboxdotcc/DPP) for details of how to contribute. 2 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # replace 'templatebot' with the name of your bot in the paths 2 | 3 | FROM brainboxdotcc/dpp:latest 4 | 5 | WORKDIR /usr/src/templatebot 6 | 7 | COPY . . 8 | 9 | WORKDIR /usr/src/templatebot/build 10 | 11 | RUN cmake .. 12 | RUN make -j$(nproc) 13 | 14 | ENTRYPOINT [ "/usr/src/templatebot/build/templatebot" ] 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # D++ CMake Template (templatebot) 2 | 3 | CMake template for a simple [D++](https://dpp.dev) bot. This template assumes that D++ is already installed. 4 | 5 | ## Compilation 6 | 7 | mkdir build 8 | cd build 9 | cmake .. 10 | make -j 11 | 12 | If DPP is installed in a different location you can specify the root directory to look in while running cmake 13 | 14 | cmake .. -DDPP_ROOT_DIR= 15 | 16 | ## Running the template bot 17 | 18 | Create a config.json in the directory above the build directory: 19 | 20 | ```json 21 | { "token": "your bot token here" } 22 | ``` 23 | 24 | Start the bot: 25 | 26 | cd build 27 | ./templatebot 28 | 29 | ## Extending the bot 30 | 31 | You can add as many header files and .cpp files into the src and include folders as you wish. All .cpp files in the src directory will be linked together into the bot's executable. 32 | 33 | ## Renaming the bot 34 | 35 | To rename the bot, search and replace "templatebot" in the `CMakeLists.txt` with your new bots name and then rename the templatebot folder in include. Rerun `cmake ..` from the `build` directory and rebuild. 36 | -------------------------------------------------------------------------------- /cmake/FindDPP.cmake: -------------------------------------------------------------------------------- 1 | find_path(DPP_INCLUDE_DIR NAMES dpp/dpp.h HINTS ${DPP_ROOT_DIR}) 2 | 3 | find_library(DPP_LIBRARIES NAMES dpp "libdpp.a" HINTS ${DPP_ROOT_DIR}) 4 | 5 | include(FindPackageHandleStandardArgs) 6 | 7 | find_package_handle_standard_args(DPP DEFAULT_MSG DPP_LIBRARIES DPP_INCLUDE_DIR) 8 | -------------------------------------------------------------------------------- /include/templatebot/templatebot.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | #include 5 | 6 | // Place any forward declarations here 7 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | /* When you invite the bot, be sure to invite it with the 5 | * scopes 'bot' and 'applications.commands', e.g. 6 | * https://discord.com/oauth2/authorize?client_id=940762342495518720&scope=bot+applications.commands&permissions=139586816064 7 | */ 8 | 9 | using json = nlohmann::json; 10 | 11 | int main(int argc, char const *argv[]) 12 | { 13 | json configdocument; 14 | std::ifstream configfile("../config.json"); 15 | configfile >> configdocument; 16 | 17 | /* Setup the bot */ 18 | dpp::cluster bot(configdocument["token"]); 19 | 20 | /* Output simple log messages to stdout */ 21 | bot.on_log(dpp::utility::cout_logger()); 22 | 23 | /* Handle slash command */ 24 | bot.on_slashcommand([](const dpp::slashcommand_t& event) { 25 | if (event.command.get_command_name() == "ping") { 26 | event.reply("Pong!"); 27 | } 28 | }); 29 | 30 | /* Register slash command here in on_ready */ 31 | bot.on_ready([&bot](const dpp::ready_t& event) { 32 | /* Wrap command registration in run_once to make sure it doesnt run on every full reconnection */ 33 | if (dpp::run_once()) { 34 | bot.global_command_create(dpp::slashcommand("ping", "Ping pong!", bot.me.id)); 35 | } 36 | }); 37 | 38 | /* Start the bot */ 39 | bot.start(dpp::st_wait); 40 | 41 | return 0; 42 | } 43 | --------------------------------------------------------------------------------