├── .editorconfig ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── PULL_REQUEST_TEMPLATE.md ├── dependabot.yml └── workflows │ ├── dependency-review.yml │ └── maven.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── pom.xml └── src └── main └── java └── com └── github └── dominik48n └── jdacommands ├── Command.java ├── CommandRegistry.java ├── JDACommands.java └── listener ├── MessageReceivedListener.java └── SlashCommandInteractionListener.java /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | # Unix-style newlines with a newline ending every file 5 | [*] 6 | end_of_line = lf 7 | insert_final_newline = true 8 | 9 | # Set encoding of files with specified ending. 10 | [*.{java, json, yml, yaml, xml}] 11 | charset = utf-8 12 | 13 | # Set indentation for Java source files. 14 | [*.java] 15 | indent_style = space 16 | indent_size = 4 17 | 18 | # YAML doesn't like tabs 19 | [*.{yml, yaml}] 20 | indent_style = space 21 | indent_size = 4 22 | 23 | # Consistency. 24 | [*{.xml, json}] 25 | indent_style = space 26 | indent_size = 2 27 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Handle line endings automatically for files detected as text 2 | # and leave all files detected as binary untouched. 3 | * text=auto eol=lf 4 | 5 | # Force the following filetypes to have unix eols 6 | *.java text eol=lf 7 | *.xml text eol=lf 8 | *.json text eol=lf 9 | *.yaml text eol=lf 10 | *.yml text eol=lf 11 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | When did the bug appear and what do you have to do to make this bug appear again? 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Screenshots** 20 | If applicable, add screenshots to help explain your problem. 21 | 22 | **System (please complete the following information):** 23 | - Java-Version: [e.g. 11] 24 | - JDA-Version [e.g. 5.0.0-alpha.20] 25 | - Project-Version [e.g. 1.0.0] 26 | 27 | **Additional context** 28 | Add any other context about the problem here. 29 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Pull Request Template 2 | 3 | ## Description 4 | 5 | Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. 6 | 7 | Fixes # (issue) 8 | 9 | ## Type of change 10 | 11 | Please delete options that are not relevant. 12 | 13 | - [ ] Bug fix (non-breaking change which fixes an issue) 14 | - [ ] New feature (non-breaking change which adds functionality) 15 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 16 | - [ ] This change requires a documentation update 17 | 18 | ## How Has This Been Tested? 19 | 20 | Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration 21 | 22 | - [ ] Test A 23 | - [ ] Test B 24 | 25 | **Test Configuration**: 26 | * Firmware version: 27 | * Hardware: 28 | * Toolchain: 29 | * SDK: 30 | 31 | ## Checklist: 32 | 33 | - [ ] My code follows the style guidelines of this project 34 | - [ ] I have performed a self-review of my own code 35 | - [ ] I have commented my code, particularly in hard-to-understand areas 36 | - [ ] I have made corresponding changes to the documentation 37 | - [ ] My changes generate no new warnings 38 | - [ ] I have added tests that prove my fix is effective or that my feature works 39 | - [ ] New and existing unit tests pass locally with my changes 40 | - [ ] Any dependent changes have been merged and published in downstream modules 41 | - [ ] I have checked my code and corrected any misspellings 42 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "mvn" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | -------------------------------------------------------------------------------- /.github/workflows/dependency-review.yml: -------------------------------------------------------------------------------- 1 | # Dependency Review Action 2 | # 3 | # This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging. 4 | # 5 | # Source repository: https://github.com/actions/dependency-review-action 6 | # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement 7 | name: 'Dependency Review' 8 | on: [pull_request] 9 | 10 | permissions: 11 | contents: read 12 | 13 | jobs: 14 | dependency-review: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - name: 'Checkout Repository' 18 | uses: actions/checkout@v3 19 | - name: 'Dependency Review' 20 | uses: actions/dependency-review-action@v2 21 | -------------------------------------------------------------------------------- /.github/workflows/maven.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven 3 | 4 | name: Java CI with Maven 5 | 6 | on: 7 | push: 8 | branches: [ "develop" ] 9 | pull_request: 10 | branches: [ "master" ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | - name: Set up JDK 8 20 | uses: actions/setup-java@v3 21 | with: 22 | java-version: '8' 23 | distribution: 'temurin' 24 | cache: maven 25 | - name: Build with Maven 26 | run: mvn -B package --file pom.xml 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | dependency-reduced-pom.xml 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | .sts4-cache 12 | 13 | ### IntelliJ IDEA ### 14 | .idea 15 | *.iws 16 | *.iml 17 | *.ipr 18 | 19 | ### NetBeans ### 20 | /nbproject/private/ 21 | /nbbuild/ 22 | /dist/ 23 | /nbdist/ 24 | /.nb-gradle/ 25 | build/ 26 | !**/src/main/**/build/ 27 | !**/src/test/**/build/ 28 | 29 | ### VS Code ### 30 | .vscode/ 31 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | Discord. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to JDA Commands 2 | JDA Commands has a very lenient policy towards PRs, but would prefer that you try and adhere to the following guidelines. 3 | 4 | ## PR Policy 5 | We'll accept changes that make sense. You should be able to justify their existence, along with any maintenance costs that come with them. Remember, these changes will affect everyone. While we will fix minor formatting issues, you should stick to the guide below when making and submitting changes. 6 | 7 | ## CodeStyle 8 | You should generally follow our code style. As expected, you will find this in the current code. 9 | -------------------------------------------------------------------------------- /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 2022 Dominik48N 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 | # JDA Commands 2 | JDA Commands is an extension for JDA to make commands easier and clearer to develop. 3 | 4 | With the API you can easily create commands for the JDA and clearly divide them into different classes. Slash and custom commands are also supported. 5 | 6 | If you have questions or problems regarding the JDA Commands API, you can create an [issue](https://github.com/Dominik48N/jda-commands/issues) or use the [discussion](https://github.com/Dominik48N/jda-commands/discussions). 7 | 8 | ## Requirements 9 | The following things are required to use JDA Commands: 10 | * Java 8+ 11 | * [JDA](https://github.com/DV8FromTheWorld/JDA) v5.0.0-alpha.20 12 | 13 | ## Usage 14 | How you can use the API is written in our [wiki](https://github.com/Dominik48N/jda-commands/wiki). Here you will only be briefly shown how to implement the API in Maven and Gradle. 15 | 16 | ### Maven 17 | Add the following to your `pom.xml`: 18 | ```xml 19 | 20 | 21 | jitpack.io 22 | https://jitpack.io 23 | 24 | 25 | 26 | 27 | 28 | com.github.Dominik48N 29 | jda-commands 30 | 1.0.2 31 | 32 | 33 | ``` 34 | 35 | ### Gradle 36 | Add the following to your `build.gradle`: 37 | ```kt 38 | allprojects { 39 | repositories { 40 | maven { url 'https://jitpack.io' } 41 | } 42 | } 43 | 44 | dependencies { 45 | implementation 'com.github.Dominik48N:jda-commands:1.0.2' 46 | } 47 | ``` 48 | 49 | ## License 50 | This repository is licensed with the [Apache License 2.0](https://github.com/Dominik48N/jda-commands/blob/master/LICENSE). 51 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.github.dominik48n 8 | jda-commands 9 | 1.0.0 10 | 11 | JDA-Commands 12 | JDA Commands is an extension for JDA to make commands easier and clearer to develop. 13 | https://github.com/Dominik48N/jda-commands 14 | 15 | 16 | 8 17 | 8 18 | 19 | 20 | 21 | 22 | net.dv8tion 23 | JDA 24 | 5.0.0-alpha.20 25 | provided 26 | 27 | 28 | org.apache.commons 29 | commons-lang3 30 | 3.12.0 31 | compile 32 | 33 | 34 | 35 | 36 | ${project.name}-${project.version} 37 | 38 | 39 | 40 | org.apache.maven.plugins 41 | maven-shade-plugin 42 | 3.3.0 43 | 44 | 45 | 46 | shade 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /src/main/java/com/github/dominik48n/jdacommands/Command.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2022 Dominik48N 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.dominik48n.jdacommands; 17 | 18 | import com.google.common.base.Preconditions; 19 | import java.util.Arrays; 20 | import net.dv8tion.jda.api.entities.Guild; 21 | import net.dv8tion.jda.api.entities.Member; 22 | import net.dv8tion.jda.api.entities.Role; 23 | import net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion; 24 | import net.dv8tion.jda.api.entities.channel.unions.GuildMessageChannelUnion; 25 | import net.dv8tion.jda.api.entities.channel.unions.MessageChannelUnion; 26 | 27 | public abstract class Command { 28 | 29 | /** 30 | * This is the command name. 31 | */ 32 | private final String name; 33 | 34 | /** 35 | * Which prefix should be in front of the command? 36 | * Please make sure that if you use / as a prefix, the command is suggested from Discord. 37 | */ 38 | private final String prefix; 39 | 40 | /** 41 | * If you use the / prefix, you can use this to provide a description that will be displayed below the command. 42 | */ 43 | private final String description; 44 | 45 | /** 46 | * Use these command aliases. 47 | */ 48 | private final String[] aliases; 49 | 50 | /** 51 | * These roles have access to this command. If this array is empty, anyone can access it. 52 | */ 53 | private final Role[] access; 54 | 55 | public Command(final String name, final String prefix) { 56 | this(name, prefix, (String) null); 57 | } 58 | 59 | public Command(final String name, final String prefix, final String description) { 60 | this(name, prefix, description, new String[]{}); 61 | } 62 | 63 | public Command(final String name, final String prefix, final Role... access) { 64 | this(name, prefix, null, access); 65 | } 66 | 67 | public Command(final String name, final String prefix, final String description, final String... aliases) { 68 | this(name, prefix, description, aliases, new Role[]{}); 69 | } 70 | 71 | public Command(final String name, final String prefix, final String description, final Role... access) { 72 | this(name, prefix, description, new String[]{}, access); 73 | } 74 | 75 | public Command(final String name, final String prefix, final String description, final String[] aliases, final Role[] access) { 76 | // Check null arguments 77 | Preconditions.checkNotNull(name, "The name of a command cannot be null."); 78 | Preconditions.checkNotNull(prefix, "The prefix of a command cannot be null."); 79 | Preconditions.checkNotNull(aliases, "The aliases of a command cannot be null."); 80 | Preconditions.checkNotNull(access, "The access roles of a command cannot be null."); 81 | 82 | // Define arguments 83 | this.name = name; 84 | this.prefix = prefix; 85 | this.description = description != null ? description : "-/-"; 86 | this.aliases = Arrays.stream(aliases).map(String::toLowerCase).toArray(String[]::new); 87 | this.access = access; 88 | } 89 | 90 | public String getName() { 91 | return this.name; 92 | } 93 | 94 | public String getPrefix() { 95 | return this.prefix; 96 | } 97 | 98 | public String getDescription() { 99 | return this.description; 100 | } 101 | 102 | public String[] getAliases() { 103 | return this.aliases; 104 | } 105 | 106 | public Role[] getAccess() { 107 | return this.access; 108 | } 109 | 110 | /** 111 | * This abstract method is executed when the command is entered. 112 | * 113 | * @param guild the {@link Guild} the command was run on. 114 | * @param member the command executor as {@link Member} 115 | * @param channel the {@link MessageChannelUnion} 116 | * @param guildChannel the {@link GuildChannelUnion} 117 | * @param arguments These are the arguments that were additionally specified. 118 | */ 119 | public abstract void execute( 120 | final Guild guild, 121 | final Member member, 122 | final MessageChannelUnion channel, 123 | final GuildMessageChannelUnion guildChannel, 124 | final String[] arguments 125 | ); 126 | } 127 | -------------------------------------------------------------------------------- /src/main/java/com/github/dominik48n/jdacommands/CommandRegistry.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2022 Dominik48N 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.dominik48n.jdacommands; 17 | 18 | import java.util.Collections; 19 | import java.util.HashMap; 20 | import java.util.Map; 21 | import net.dv8tion.jda.api.JDA; 22 | 23 | public class CommandRegistry { 24 | 25 | private final Map commands = new HashMap<>(); 26 | 27 | private final JDA jda; 28 | 29 | protected CommandRegistry(final JDA jda) { 30 | this.jda = jda; 31 | } 32 | 33 | /** 34 | * Register a new command 35 | * 36 | * @param command the {@link Command} 37 | */ 38 | public void registerCommand(final Command command) { 39 | final String name = command.getName().toLowerCase(); 40 | 41 | this.commands.put(name, command); 42 | 43 | for (final String alias : command.getAliases()) { 44 | this.commands.put(alias, command); 45 | } 46 | 47 | if (command.getPrefix().startsWith("/")) { 48 | this.jda.upsertCommand(name, command.getDescription()).queue(); 49 | 50 | for (final String alias : command.getAliases()) { 51 | this.jda.upsertCommand(alias, command.getDescription()).queue(); 52 | } 53 | } 54 | } 55 | 56 | /** 57 | * Unregister a command 58 | * 59 | * @param name the name of the command 60 | */ 61 | public void unregisterCommand(String name) { 62 | name = name.toLowerCase(); 63 | 64 | final Command command = this.commands.remove(name); 65 | 66 | if (command == null) return; // Command is not exists. 67 | 68 | for (final String alias : command.getAliases()) { 69 | this.commands.remove(alias); 70 | } 71 | } 72 | 73 | public Map getCommands() { 74 | return Collections.unmodifiableMap(this.commands); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /src/main/java/com/github/dominik48n/jdacommands/JDACommands.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2022 Dominik48N 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.dominik48n.jdacommands; 17 | 18 | import com.github.dominik48n.jdacommands.listener.MessageReceivedListener; 19 | import com.github.dominik48n.jdacommands.listener.SlashCommandInteractionListener; 20 | import net.dv8tion.jda.api.JDA; 21 | 22 | public class JDACommands { 23 | 24 | private static JDACommands INSTANCE; 25 | 26 | private final CommandRegistry commandRegistry; 27 | private final JDA jda; 28 | 29 | private JDACommands(final JDA jda) { 30 | // Initialize variables 31 | this.commandRegistry = new CommandRegistry(jda); 32 | this.jda = jda; 33 | 34 | // Register listeners 35 | this.jda.addEventListener(new SlashCommandInteractionListener()); 36 | this.jda.addEventListener(new MessageReceivedListener()); 37 | 38 | // Define class instance 39 | INSTANCE = this; 40 | } 41 | 42 | public CommandRegistry getCommandRegistry() { 43 | return this.commandRegistry; 44 | } 45 | 46 | public JDA getJDA() { 47 | return this.jda; 48 | } 49 | 50 | /** 51 | * Initialize the jda commands. 52 | * Please Note: If the JDA Commands have already been initialized, this will not work a second time. 53 | * 54 | * @param jda the bot {@link JDA} 55 | * @return the initialized {@link JDACommands} class. 56 | */ 57 | public static JDACommands init(final JDA jda) { 58 | if (INSTANCE != null) throw new IllegalStateException("JDACommands is already initialized."); 59 | return new JDACommands(jda); 60 | } 61 | 62 | public static JDACommands getInstance() { 63 | if (INSTANCE == null) throw new IllegalStateException("JDACommands is not initialized."); 64 | return INSTANCE; 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /src/main/java/com/github/dominik48n/jdacommands/listener/MessageReceivedListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2022 Dominik48N 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.dominik48n.jdacommands.listener; 17 | 18 | import com.github.dominik48n.jdacommands.Command; 19 | import com.github.dominik48n.jdacommands.JDACommands; 20 | import java.util.Arrays; 21 | import net.dv8tion.jda.api.entities.Member; 22 | import net.dv8tion.jda.api.events.message.MessageReceivedEvent; 23 | import net.dv8tion.jda.api.hooks.ListenerAdapter; 24 | 25 | public class MessageReceivedListener extends ListenerAdapter { 26 | 27 | public void onMessageReceived(final MessageReceivedEvent event) { 28 | final String message = event.getMessage().getContentStripped(); 29 | final Command command = JDACommands.getInstance().getCommandRegistry().getCommands().get(message); 30 | 31 | if (command == null || command.getPrefix().startsWith("/")) 32 | // The command is not exists or a slash command! 33 | return; 34 | 35 | // Check if member has access 36 | final Member member = event.getMember(); 37 | if (member == null) return; // The member cannot be null 38 | if (command.getAccess().length != 0 39 | && member.getRoles().stream().filter(role -> Arrays.stream(command.getAccess()).anyMatch(role1 -> role1 == role)).count() <= 0L 40 | ) 41 | // Member has no access of to the command 42 | return; 43 | 44 | // Execute the command 45 | final String[] splitMessage = message.split(" "); 46 | command.execute( 47 | event.getGuild(), 48 | member, 49 | event.getChannel(), 50 | event.getGuildChannel(), 51 | Arrays.copyOfRange(splitMessage, 1, splitMessage.length) 52 | ); 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /src/main/java/com/github/dominik48n/jdacommands/listener/SlashCommandInteractionListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2022 Dominik48N 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.github.dominik48n.jdacommands.listener; 17 | 18 | import com.github.dominik48n.jdacommands.Command; 19 | import com.github.dominik48n.jdacommands.JDACommands; 20 | import java.util.Arrays; 21 | import net.dv8tion.jda.api.entities.Member; 22 | import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent; 23 | import net.dv8tion.jda.api.hooks.ListenerAdapter; 24 | import org.apache.commons.lang3.ArrayUtils; 25 | 26 | public class SlashCommandInteractionListener extends ListenerAdapter { 27 | 28 | public void onSlashCommandInteraction(final SlashCommandInteractionEvent event) { 29 | final Command command = JDACommands.getInstance().getCommandRegistry().getCommands().get(event.getName().toLowerCase()); 30 | 31 | if (command == null || !command.getPrefix().startsWith("/")) 32 | // The command is not a slash command! 33 | return; 34 | 35 | // Check if member has access 36 | final Member member = event.getMember(); 37 | if (member == null) return; // The member cannot be null 38 | if (command.getAccess().length != 0 39 | && member.getRoles().stream().filter(role -> Arrays.stream(command.getAccess()).anyMatch(role1 -> role1 == role)).count() <= 0L 40 | ) 41 | // Member has no access of to the command 42 | return; 43 | 44 | // Execute the command 45 | command.execute( 46 | event.getGuild(), 47 | member, 48 | event.getChannel(), 49 | event.getGuildChannel(), 50 | ArrayUtils.addAll( 51 | event.getSubcommandGroup() != null ? event.getSubcommandGroup().split(" ") : new String[] {}, 52 | event.getSubcommandName() != null ? event.getSubcommandName().split(" ") : new String[] {} 53 | ) 54 | ); 55 | } 56 | } 57 | --------------------------------------------------------------------------------