|
|
|
1 |
<p align="center"> |
<p align="center"> |
2 |
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px"> |
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px"> |
3 |
</p> |
</p> |
9 |
<img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub"> |
<img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub"> |
10 |
<img src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?label=Version" alt="GitHub package.json version"> |
<img src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?label=Version" alt="GitHub package.json version"> |
11 |
<img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity"> |
<img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity"> |
12 |
<a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a> |
<a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=OSN+Support+Chat" alt="Discord"></a> |
13 |
</p> |
</p> |
14 |
|
|
15 |
<p align="center"> |
<p align="center"> |
16 |
A Discord bot for moderation purposes. |
A Discord bot for moderation purposes. <a href="https://docs.sudobot.onesoftnet.eu.org/features/screenshots/">Click here</a> to see the screenshots. |
17 |
</p> |
</p> |
18 |
|
|
19 |
### Features |
### Features |
33 |
|
|
34 |
#### Requirements |
#### Requirements |
35 |
* NodeJS version 16 or higher |
* NodeJS version 16 or higher |
36 |
* MongoDB version 5.0 or higher |
* MongoDB version 5.0 or higher ([Click to get free MongoDB service](https://www.mongodb.com/atlas)) |
37 |
* A Discord API application token with proper setup |
* A Discord API application token with proper setup |
38 |
|
|
39 |
#### Optional Services |
#### Optional Services |
78 |
|
|
79 |
**Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required. |
**Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required. |
80 |
|
|
81 |
Alternatively, you can try the new `setup.js` installer script [BETA] by running `node setup.js`. It will ask you some questions about the configuration. |
> Alternatively, you can try the new `setup.js` installer script [BETA] by running `node setup.js`. It will ask you some questions about the configuration. |
82 |
|
|
83 |
4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed. |
4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed. |
84 |
|
|
120 |
### Support |
### Support |
121 |
|
|
122 |
- **Email**: [email protected] |
- **Email**: [email protected] |
123 |
- **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs) |
- **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [OneSoftNet Server](https://discord.gg/892GWhTzgs) |
124 |
|
|
125 |
|
### Extra |
126 |
|
|
127 |
|
- **Dashboard**: The dashboard for SudoBot can be found [here](https://github.com/onesoft-sudo/sudobot-dashboard). |
128 |
|
- **Download Emojis**: https://www.onesoftnet.eu.org/downloads/sudo/emojis/ |