|
1 |
| - |
2 |
| -# BhaluBot Discord Bot (Under Development) |
3 |
| - |
4 |
| -BhaluBot is a versatile Discord bot designed to elevate your server experience with interactive and entertaining features. From generating random images to providing insightful responses, BhaluBot is here to make your Discord server lively and engaging. |
5 |
| - |
6 |
| -**Please note: This bot is currently under development. More commands will be added soon.** |
7 |
| - |
8 |
| -## Installation: |
9 |
| - |
10 |
| -1. **Clone the repository:** |
11 |
| - ``` |
12 |
| - git clone https://github.com/Amitminer/BhaluBot-PY.git |
13 |
| - cd BhaluBot |
14 |
| - ``` |
15 |
| - |
16 |
| -2. **Install Dependencies:** |
17 |
| - ``` |
18 |
| - pip install -r requirements.txt |
19 |
| - ``` |
20 |
| - |
21 |
| -4. **Setup:** |
22 |
| - |
23 |
| - - **Configuration:** |
24 |
| - BhaluBot uses a `config.yml` file for configuration. Ensure the following settings are correctly configured in the `config.yml` |
25 |
| - |
26 |
| - - **Environment Variables:** |
27 |
| - Create a `.env` file in the root directory to store your sensitive information. Here are the environment variables you can set in the `.env` file [Click me to see .env setup](https://github.com/Amitminer/BhaluBot-PY#environment-variables-env) |
28 |
| - |
29 |
| -5. **Start the bot using:** |
30 |
| - |
31 |
| - ```bash |
32 |
| - ./start.sh |
33 |
| - ``` |
34 |
| - or |
35 |
| - ```bash |
36 |
| - ./start.bat |
37 |
| - ``` |
38 |
| - |
39 |
| -## Commands: |
40 |
| - |
41 |
| -- **`+random (your query)`** |
42 |
| - |
43 |
| - Generates a random image based on your query, for example: |
44 |
| - ``` |
45 |
| - +random supercar |
46 |
| - ``` |
47 |
| - BhaluBot will send you a random supercar image. Powered by Unsplash API. |
48 |
| - |
49 |
| -- **`+spam (count) (message to spam)`** |
50 |
| - |
51 |
| - Sends the specified message multiple times, for example: |
52 |
| - ``` |
53 |
| - +spam 5 hello |
54 |
| - ``` |
55 |
| - BhaluBot will send "hello" 5 times. |
56 |
| - |
57 |
| -- **`+say (message)`** |
58 |
| - |
59 |
| - Bot will send the specified message, for example: |
60 |
| - ``` |
61 |
| - +say Hello, everyone! |
62 |
| - ``` |
63 |
| - BhaluBot will send "Hello, everyone!" |
64 |
| - |
65 |
| -- **`+shutdown`** |
66 |
| - |
67 |
| - Shuts down the bot for maintenance. This command is owner-only. |
68 |
| - |
69 |
| -## Configuration: |
70 |
| - |
71 |
| -- **`config.yml`** |
72 |
| - |
73 |
| - ```yaml |
74 |
| - # Your bot prefix |
75 |
| - prefix: + |
76 |
| - ``` |
77 |
| - |
78 |
| -## Environment Variables (`.env`): |
79 |
| - |
80 |
| -Create a `.env` file in the root directory to store your sensitive information. Here are the environment variables you can set in the `.env` file: |
81 |
| - |
82 |
| -- `DISCORD_BOT_TOKEN`: Your Discord bot token. |
83 |
| -- `OPENAI_API_KEY`: Your OpenAI API key. Get it from [OpenAI](https://platform.openai.com/). |
84 |
| -- `UNSPLASH_ACCESS_KEY`: Your Unsplash API key. Obtain it from [Unsplash](https://unsplash.com/developers). |
85 |
| -- `CHATGPT_ACCESS_TOKEN`: Your ChatGPT API access token. |
86 |
| - |
87 |
| -Example `.env` file: |
88 |
| - |
89 |
| -```plaintext |
90 |
| -DISCORD_BOT_TOKEN=your_discord_bot_token |
91 |
| -OPENAI_API_KEY=your_openai_api_key |
92 |
| -UNSPLASH_ACCESS_KEY=your_unsplash_access_key |
93 |
| -CHATGPT_ACCESS_TOKEN=your_chatgpt_access_token |
94 |
| -``` |
95 |
| - |
96 |
| -Make sure to replace `your_discord_bot_token`, `your_openai_api_key`, `your_unsplash_access_key`, and `your_chatgpt_access_token` with your actual tokens and keys. |
97 |
| - |
98 |
| -These environment variables are crucial for the proper functioning of BhaluBot. Ensure that you keep this file secure and do not share these sensitive details publicly. |
99 |
| - |
100 |
| - |
101 |
| -## Contributing: |
102 |
| - |
103 |
| -If you find a bug or want to suggest an improvement, please feel free to open an issue or submit a pull request. Your contributions are greatly appreciated! |
104 |
| - |
105 |
| -## License: |
106 |
| - |
107 |
| -Bhalu Bot is open-source software licensed under the [MIT License](LICENSE). |
108 |
| - |
109 |
| -## Credits: |
110 |
| - |
111 |
| -The Bhalu Discord Bot is created and maintained by [AmitxD](https://github.com/Amitminer), based on BhaluBot (php). |
| 1 | + |
| 2 | +# BhaluBot Discord Bot (Under Development) |
| 3 | + |
| 4 | +BhaluBot is a versatile Discord bot designed to elevate your server experience with interactive and entertaining features. From generating random images to providing insightful responses, BhaluBot is here to make your Discord server lively and engaging. |
| 5 | + |
| 6 | +**Please note: This bot is currently under development. More commands will be added soon.** |
| 7 | + |
| 8 | +## Installation: |
| 9 | + |
| 10 | +1. **Clone the repository:** |
| 11 | + ``` |
| 12 | + git clone https://github.com/Amitminer/BhaluBot-PY.git |
| 13 | + cd BhaluBot |
| 14 | + ``` |
| 15 | + |
| 16 | +2. **Install Dependencies:** |
| 17 | + ``` |
| 18 | + pip install -r requirements.txt |
| 19 | + ``` |
| 20 | + |
| 21 | +4. **Setup:** |
| 22 | + |
| 23 | + - **Configuration:** |
| 24 | + BhaluBot uses a `config.yml` file for configuration. Ensure the following settings are correctly configured in the `config.yml` |
| 25 | + |
| 26 | + - **Environment Variables:** |
| 27 | + Create a `.env` file in the root directory to store your sensitive information. Here are the environment variables you can set in the `.env` file [Click me to see .env setup](https://github.com/Amitminer/BhaluBot-PY#environment-variables-env) |
| 28 | + |
| 29 | +5. **Start the bot using:** |
| 30 | + |
| 31 | + ```bash |
| 32 | + ./start.sh |
| 33 | + ``` |
| 34 | + or |
| 35 | + ```bash |
| 36 | + ./start.bat |
| 37 | + ``` |
| 38 | + |
| 39 | +## Commands: |
| 40 | + |
| 41 | +- **`+random (your query)`** |
| 42 | + |
| 43 | + Generates a random image based on your query, for example: |
| 44 | + ``` |
| 45 | + +random supercar |
| 46 | + ``` |
| 47 | + BhaluBot will send you a random supercar image. Powered by Unsplash API. |
| 48 | + |
| 49 | +- **`+spam (count) (message to spam)`** |
| 50 | + |
| 51 | + Sends the specified message multiple times, for example: |
| 52 | + ``` |
| 53 | + +spam 5 hello |
| 54 | + ``` |
| 55 | + BhaluBot will send "hello" 5 times. |
| 56 | + |
| 57 | +- **`+say (message)`** |
| 58 | + |
| 59 | + Bot will send the specified message, for example: |
| 60 | + ``` |
| 61 | + +say Hello, everyone! |
| 62 | + ``` |
| 63 | + BhaluBot will send "Hello, everyone!" |
| 64 | + |
| 65 | +- **`+shutdown`** |
| 66 | + |
| 67 | + Shuts down the bot for maintenance. This command is owner-only. |
| 68 | + |
| 69 | +## Configuration: |
| 70 | + |
| 71 | +- **`config.yml`** |
| 72 | + |
| 73 | + ```yaml |
| 74 | + # Your bot prefix |
| 75 | + prefix: + |
| 76 | + ``` |
| 77 | + |
| 78 | +## Environment Variables (`.env`): |
| 79 | + |
| 80 | +Create a `.env` file in the root directory to store your sensitive information. Here are the environment variables you can set in the `.env` file: |
| 81 | + |
| 82 | +- `DISCORD_BOT_TOKEN`: Your Discord bot token. |
| 83 | +- `OPENAI_API_KEY`: Your OpenAI API key. Get it from [OpenAI](https://platform.openai.com/). |
| 84 | +- `UNSPLASH_ACCESS_KEY`: Your Unsplash API key. Obtain it from [Unsplash](https://unsplash.com/developers). |
| 85 | +- `CHATGPT_ACCESS_TOKEN`: Your ChatGPT API access token. |
| 86 | + |
| 87 | +Example `.env` file: |
| 88 | + |
| 89 | +```plaintext |
| 90 | +DISCORD_BOT_TOKEN=your_discord_bot_token |
| 91 | +OPENAI_API_KEY=your_openai_api_key |
| 92 | +UNSPLASH_ACCESS_KEY=your_unsplash_access_key |
| 93 | +CHATGPT_ACCESS_TOKEN=your_chatgpt_access_token |
| 94 | +``` |
| 95 | + |
| 96 | +Make sure to replace `your_discord_bot_token`, `your_openai_api_key`, `your_unsplash_access_key`, and `your_chatgpt_access_token` with your actual tokens and keys. |
| 97 | + |
| 98 | +These environment variables are crucial for the proper functioning of BhaluBot. Ensure that you keep this file secure and do not share these sensitive details publicly. |
| 99 | + |
| 100 | + |
| 101 | +## Contributing: |
| 102 | + |
| 103 | +If you find a bug or want to suggest an improvement, please feel free to open an issue or submit a pull request. Your contributions are greatly appreciated! |
| 104 | + |
| 105 | +## License: |
| 106 | + |
| 107 | +Bhalu Bot is open-source software licensed under the [MIT License](LICENSE). |
| 108 | + |
| 109 | +## Credits: |
| 110 | + |
| 111 | +The Bhalu Discord Bot is created and maintained by [AmitxD](https://github.com/Amitminer), based on BhaluBot (php). |
0 commit comments