-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
64 changed files
with
2,729 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our | ||
| community a harassment-free experience for everyone, regardless of age, body | ||
| size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
| identity and expression, level of experience, education, socio-economic status, | ||
| nationality, personal appearance, race, religion, or sexual identity | ||
| and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, | ||
| diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment for our | ||
| community include: | ||
|
|
||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, | ||
| and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the | ||
| overall community | ||
|
|
||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery, and sexual attention or | ||
| advances of any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or email | ||
| address, without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Enforcement Responsibilities | ||
|
|
||
| Community leaders are responsible for clarifying and enforcing our standards of | ||
| acceptable behavior and will take appropriate and fair corrective action in | ||
| response to any behavior that they deem inappropriate, threatening, offensive, | ||
| or harmful. | ||
|
|
||
| Community leaders have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions that are | ||
| not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
| decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when | ||
| an individual is officially representing the community in public spaces. | ||
| Examples of representing our community include using an official e-mail address, | ||
| posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at. | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining | ||
| the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed | ||
| unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing | ||
| clarity around the nature of the violation and an explanation of why the | ||
| behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No | ||
| interaction with the people involved, including unsolicited interaction with | ||
| those enforcing the Code of Conduct, for a specified period of time. This | ||
| includes avoiding interactions in community spaces as well as external channels | ||
| like social media. Violating these terms may lead to a temporary or | ||
| permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including | ||
| sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public | ||
| communication with the community for a specified period of time. No public or | ||
| private interaction with the people involved, including unsolicited interaction | ||
| with those enforcing the Code of Conduct, is allowed during this period. | ||
| Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community | ||
| standards, including sustained inappropriate behavior, harassment of an | ||
| individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within | ||
| the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.0, available at | ||
| https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
|
||
| Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
| enforcement ladder](https://github.com/mozilla/diversity). | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at | ||
| https://www.contributor-covenant.org/faq. Translations are available at | ||
| https://www.contributor-covenant.org/translations. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
|
|
||
| ## How has this been tested? | ||
| <!--- Please describe in detail how you tested your changes. --> | ||
| <!--- Include details of your testing environment, tests ran to see how --> | ||
| <!--- your change affects other areas of the code, etc. --> | ||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Types of changes | ||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
|
|
||
| ## Checklist: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| - [ ] My code follows the code style of this project. | ||
| - [ ] My change requires a change to the documentation. | ||
| - [ ] I have updated the documentation accordingly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| <!-- PROJECT SHIELDS --> | ||
| <!-- | ||
| *** I'm using markdown "reference style" links for readability. | ||
| *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| *** See the bottom of this document for the declaration of the reference variables | ||
| *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| *** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| --> | ||
|
|
||
| [![Issues][issues-shield]][issues-url] | ||
| [![License][license-shield]][license-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <p align="center"> | ||
| <a href="https://github.com/BrammyS/Discord-Bot-Template"> | ||
| <img src="https://cdn.brammys.com/file/brammys/screenshots/2022/02/9c725f64003b63d995003932536c1064.png" style="border-radius: 15%" alt="Logo" width="100"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Discord Bot Template</h3> | ||
|
|
||
| <p align="center"> | ||
| A simple ready to use Discord Bot Template using slash commands and buttons! | ||
| <br /> | ||
| <br /> | ||
| <a href="https://discord.com/oauth2/authorize?client_id=541336442979483658&permissions=268561494&scope=applications.commands%20bot">View Demo</a> | ||
| · | ||
| <a href="https://github.com/BrammyS/Discord-Bot-Template/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/BrammyS/Discord-Bot-Template/issues">Request Feature</a> | ||
| </p> | ||
| </p> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details open="open"> | ||
| <summary><h2 style="display: inline-block">Table of Contents</h2></summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#acknowledgements">Acknowledgements</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
|
|
||
| ## About The Project | ||
|
|
||
| A simple Discord Bot Template build with the [Color-Chan.Discord library](https://github.com/Color-Chan/Color-Chan.Discord). | ||
| This template includes basic commands including a help command with multiple pages using buttons. Plus a simple [MongoDB](https://www.mongodb.com/) connection. | ||
|
|
||
| - Basic commands | ||
| - Persistent command request logging | ||
| - Command usage metrics | ||
| - MongoDB connection | ||
|
|
||
| ### Default commands | ||
|
|
||
|  | ||
|
|
||
| ### Built With | ||
|
|
||
| * [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) | ||
| * [ASP.NET](https://docs.microsoft.com/en-us/aspnet/core/?view=aspnetcore-6.0) | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get a local copy up and running follow these simple steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| * [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) | ||
|
|
||
| ### Installation | ||
|
|
||
| #### Cloning | ||
|
|
||
| 1. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/BrammyS/Discord-Bot-Template.git | ||
| ``` | ||
| 2. Go to the git folder | ||
| ```sh | ||
| cd Discord-Bot-Template | ||
| ``` | ||
| 3. Run the local dev build | ||
| ```sh | ||
| dotnet build | ||
| ``` | ||
|
|
||
|
|
||
| ### Usage | ||
|
|
||
| #### Environment variables | ||
| To run the Bot you will need to set 2 environment variables first. | ||
| - `BOT_TOKEN` : Add your bot token as the value. The bot token van be found [here](https://discord.com/developers/applications/). | ||
| - `MONGO_CON_STRING` : Add your MongoDB connection string as the value. You can get a free MongoDB host on [MongoDB Atlas](https://www.mongodb.com/atlas/database). | ||
|
|
||
| #### Constants | ||
|
|
||
| After this you need to set the `PublicKey` and the `BotId` for your bot. These can be set in the [Constants.cs](https://github.com/BrammyS/Discord-Bot-Template/blob/dev/src/Bot.Discord/Constants.cs) class in Bot.Discord. | ||
|
|
||
| ### URL | ||
|
|
||
| Set the interaction end point for your bot. You will need to add this URL to you [application](https://discord.com/developers/applications/). | ||
| The interaction endpoint is located at `https://YOUR_DOMAIN.COM:5001/api/v1/discord/interaction`. Please do keep in mind that you will need to be able to access this endpoint from outside of your network. | ||
| [](https://discord.com/developers/applications/) | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any | ||
| contributions you make are **greatly appreciated**. | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| <!-- LICENSE --> | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGEMENTS --> | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| * [Color-Chan.Discord](https://github.com/Color-Chan/Color-Chan.Discord) | ||
| * [Mongodb](https://www.mongodb.com/) | ||
| * [Discord](https://discord.com/developers/docs/intro) | ||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
|
|
||
| [stars-shield]: https://img.shields.io/github/stars/BrammyS/Discord-Bot-Template?style=for-the-badge | ||
| [stars-url]: https://github.com/BrammyS/Discord-Bot-Template/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/BrammyS/Discord-Bot-Template?style=for-the-badge | ||
| [issues-url]: https://github.com/BrammyS/Discord-Bot-Template/issues | ||
| [license-shield]: https://img.shields.io/github/license/BrammyS/Discord-Bot-Template?style=for-the-badge | ||
| [license-url]: https://github.com/BrammyS/Discord-Bot-Template/blob/master/LICENSE |
Oops, something went wrong.