-
Notifications
You must be signed in to change notification settings - Fork 0
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
26 changed files
with
569 additions
and
116 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
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,49 @@ | ||
# Contribution Guidelines | ||
Thank you for your interest in contributing to the project! We appreciate your help in making this discord bot project even better. To ensure a smooth collaboration, please follow these guidelines when contributing to the project. | ||
|
||
### Getting Started | ||
To contribute to this project, follow these steps: | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone the forked repository to your local machine. | ||
3. Make the necessary changes and improvements to the codebase. | ||
4. Test your changes to ensure they work as expected. | ||
5. Commit your changes with clear and descriptive commit messages. | ||
6. Push the changes to your forked repository. | ||
7. Submit a pull request to the main repository. | ||
|
||
### Code Guidelines | ||
Please adhere to the following code guidelines: | ||
|
||
- Write clear and concise code that is easy to understand and maintain. | ||
- Follow the existing coding style and conventions used in the project. | ||
- Use meaningful variable and function names that accurately describe their purpose. | ||
- Comment your code when necessary, especially for complex logic or non-obvious functionality. | ||
|
||
### Testing | ||
To maintain the project's quality, it is essential to test your changes. Here's how you can test the project: | ||
|
||
- Run the existing tests to ensure that the project functions as expected. | ||
- Write additional tests to cover the new features or changes you made. | ||
- Ensure that all tests pass successfully before submitting your changes. | ||
|
||
### Documentation | ||
If you make changes that require updates to the documentation, please make sure to update the relevant parts of the project's documentation. This includes the README file, inline code comments, and any other relevant documentation files. | ||
|
||
### Issue Tracking | ||
If you find any bugs, have suggestions, or would like to request new features, please create an issue in the GitHub repository. Make sure to provide a clear and detailed description of the problem or enhancement you are proposing. | ||
|
||
### Pull Request Process | ||
To contribute your changes back to the main project, please follow these steps: | ||
|
||
1. Ensure that your forked repository is up to date with the latest changes from the main repository. | ||
2. Create a new branch for your changes, with a descriptive name. | ||
3. Make your changes and commit them with clear and concise messages. | ||
4. Push your branch to your forked repository. | ||
5. Open a pull request from your branch to the main repository. | ||
6. Provide a detailed description of the changes you made and the motivation behind them. | ||
7. Wait for feedback and address any requested changes if necessary. | ||
8. Once approved, your changes will be merged into the main repository. | ||
|
||
### Conclusion | ||
Thank you for considering contributing to this project! Your help is greatly appreciated. Let's work together to make this weather checking command-line tool even more useful and efficient. If you have any questions, feel free to reach out by creating an issue or contacting the project maintainers. Happy coding! |
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 |
---|---|---|
@@ -1,44 +1,63 @@ | ||
# 🤖 simplebot | ||
|
||
Simple Discord bot to entertain your server | ||
A Simple Discord bot to entertain your server | ||
|
||
## Installation | ||
### Requirements: | ||
- [.NET 7.0 or newer](https://dotnet.microsoft.com/en-us/download) | ||
- [API Ninjas API Key](https://api-ninjas.com/api) | ||
![IMG1](https://cdn.discordapp.com/attachments/973146682499956746/1119970853896069211/readme_img.png) | ||
## Prerequisites | ||
- [.NET 7.0 Or newer](https://dotnet.microsoft.com/en-us/download) | ||
- [API Ninjas Key](https://api-ninjas.com/api) | ||
- [Discord Application (bot)](https://discord.com/developers/applications) | ||
|
||
### Bot setup: | ||
- Create your aplication at Discord Developer Portal | ||
- In your app, go to `Bot/Privileged Gateway` Intents and enable all settings | ||
- Next, go to `OAuth2/URL Generator` and generate bot invite link | ||
- Go to `OAuth2/URL Generator` and generate bot invite link | ||
- If you have 2FA Authentication, you will be asked to prompt a 6 digit code | ||
- Create a JSON File in root directory: | ||
## Installation | ||
|
||
1. Create your [Discord Application](https://discord.com/developers/docs/getting-started#step-1-creating-an-app) | ||
2. Clone the repository and open it in your IDE | ||
3. Install dependencies | ||
4. Create `config.json` file in `Config` directory with the following content: | ||
```json | ||
{ | ||
"token": "Discord bot token here", | ||
"api-ninjas_apikey": "API Ninjas API Key here" | ||
"token": "YOUR DISCORD BOT TOKEN", | ||
"api-ninjas_apikey": "YOUR API NINJAS KEY", | ||
"xp_multiplier": 0.5, | ||
"level_cap": 20 | ||
} | ||
``` | ||
- Voulà! Now just run solution and everyting should be working! | ||
5. Run the project. | ||
## Usage | ||
|
||
This bot uses only [Slash Commands](https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ) | ||
|
||
## Usage | ||
This bot uses only slash commands, so to run a command, type: `/command` | ||
To getting started, go to your Discord Server and type `/help` | ||
|
||
![IMG2](https://cdn.discordapp.com/attachments/973146682499956746/1119977268777857024/IMG2.png) | ||
|
||
![IMG3](https://cdn.discordapp.com/attachments/973146682499956746/1119977269335691354/IMG3.png) | ||
|
||
To change the XP multiplier (amount of XP user will have after each message) can be change in `"xp_multiplier"` field in config file, and the requierd XP to new level can be modified in `"level_cap"` field | ||
## Contributing | ||
|
||
Contributions are always welcome! | ||
|
||
Full command list is at `/help` | ||
See `CONTRIBUTING.md` for ways to get started. | ||
|
||
Please adhere to this project's `CODE_OF_CONDUCT.md`. | ||
|
||
|
||
## Acknowledgements | ||
### Frameworks: | ||
|
||
#### Frameworks: | ||
- [DSharpPlus](https://dsharpplus.github.io/DSharpPlus/) | ||
- [RestSharp](https://restsharp.dev) | ||
- [Newtonsoft.Json](https://www.newtonsoft.com/json) | ||
- [DSharpPlus](https://dsharpplus.github.io/DSharpPlus/) | ||
|
||
### API's: | ||
- [Excuser API](https://excuser-three.vercel.app) | ||
- [Memegen API](https://api.memegen.link/docs) | ||
#### APIs: | ||
- [API Ninjas](https://api-ninjas.com/api) | ||
- [Excuse API](https://excuser-three.vercel.app) | ||
- [Meme API](https://github.com/D3vd/Meme_Api) | ||
- [API Ninjas](https://api-ninjas.com/api) | ||
- [Memegen API](https://api.memegen.link/docs) | ||
|
||
|
||
## License | ||
|
||
This project is under [MIT](https://github.com/pazurkota/simplebot/blob/master/LICENSE) license | ||
|
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
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
Oops, something went wrong.