| 1 |
<p align="center"> |
| 2 |
<a href="https://www.sudobot.online" title="Official Website of SudoBot" target="_blank"> |
| 3 |
<!-- |
| 4 |
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/nnanzhwwmpa2k3ebw0yg.png" height="114px" width="348px"> |
| 5 |
--> |
| 6 |
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png" height="114px" width="348px"> |
| 7 |
</a> |
| 8 |
</p> |
| 9 |
|
| 10 |
<br /> |
| 11 |
|
| 12 |
<p align="center"> |
| 13 |
<a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/onesoft-sudo/sudobot/build.yml?branch=main&event=push&style=flat&logo=github&logoColor=%23fff&label=Build&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60"></a> |
| 14 |
<a href="https://gnu.org/licenses/agpl-3.0.html"><img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2C77u%2FPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiINCgkiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4NCjxzdmcgd2lkdGg9IjE5N3B4IiBoZWlnaHQ9IjE5N3B4IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSI%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iOTgiIGZpbGw9ImJsYWNrIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iNzgiIGZpbGw9IndoaXRlIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iNTUiIGZpbGw9ImJsYWNrIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iMzAiIGZpbGw9IndoaXRlIi8%2BDQoJPHJlY3QgeD0iMTE1IiB5PSI4NSIgd2lkdGg9IjQ1IiBoZWlnaHQ9IjI1IiBmaWxsPSJ3aGl0ZSIvPg0KPC9zdmc%2B&logoColor=%23fff&label=License&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60" /></a> |
| 15 |
<a href="https://www.codefactor.io/repository/github/onesoft-sudo/sudobot"><img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/onesoft-sudo/sudobot?style=flat&logo=codefactor&logoColor=%23fff&label=Codefactor&labelColor=%23000&cacheSeconds=60&link=https%3A%2F%2Fwww.codefactor.io%2Frepository%2Fgithub%2Fonesoft-sudo%2Fsudobot"></a> |
| 16 |
<a href="https://github.com/onesoft-sudo/sudobot/releases/latest"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?style=flat&logo=npm&logoColor=white&label=Version&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60"></a> |
| 17 |
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?style=flat&logo=git&logoColor=white&label=Commits&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60"> |
| 18 |
<a href="https://discord.gg/892GWhTzgs"><img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Fguilds%2F964969362073198652%2Fwidget.json&query=presence_count&suffix=%20online&style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60&link=https%3A%2F%2Fdiscord.gg%2F892GWhTzgs" alt="Discord" /></a> |
| 19 |
<img alt="Uptime Robot ratio (7 days)" src="https://img.shields.io/uptimerobot/ratio/7/m797587935-30e6fe2182045bda2a330f8b?style=flat&logo=rescuetime&label=Main%20Instance%20Uptime&labelColor=rgb(0%2C0%2C0)&color=rgb(50%2C50%2C50)&cacheSeconds=60"> |
| 20 |
</p> |
| 21 |
|
| 22 |
<p align="center"> |
| 23 |
A free and open source Discord bot for moderation purposes.<br /> |
| 24 |
<a href="https://docs.sudobot.online" target="_blank">Documentation</a> • |
| 25 |
<a href="https://docs.sudobot.online/features/screenshots/" target="_blank">Screenshots</a> |
| 26 |
<br /> |
| 27 |
<br /> |
| 28 |
<a href="https://idx.google.com/import?url=https%3A%2F%2Fgithub.com%2Fonesoft-sudo%2Fsudobot" align="center"> |
| 29 |
<picture> |
| 30 |
<source |
| 31 |
media="(prefers-color-scheme: dark)" |
| 32 |
srcset="https://cdn.idx.dev/btn/open_dark_32.svg"> |
| 33 |
<source |
| 34 |
media="(prefers-color-scheme: light)" |
| 35 |
srcset="https://cdn.idx.dev/btn/open_light_32.svg"> |
| 36 |
<img |
| 37 |
height="32" |
| 38 |
alt="Open in IDX" |
| 39 |
src="https://cdn.idx.dev/btn/open_purple_32.svg"> |
| 40 |
</picture> |
| 41 |
</a> |
| 42 |
</p> |
| 43 |
|
| 44 |
<!-- |
| 45 |
<p align="center"> |
| 46 |
<a href="https://github.com/onesoft-sudo/sudobot/releases/latest"><img alt="Download from GitHub" src="https://res.cloudinary.com/rakinar2/image/upload/v1702811535/kh7v7c5jb4v3na1e67mg.png" width="276" height="48"></a> |
| 47 |
<a href="https://sourceforge.net/projects/sudobot/files/latest/download"><img alt="Download from SourceForge" src="https://a.fsdn.com/con/app/sf-download-button" width="276" height="48" srcset="https://a.fsdn.com/con/app/sf-download-button?button_size=2x 2x"></a> |
| 48 |
</p> --> |
| 49 |
|
| 50 |
## ❗ Need Contributors |
| 51 |
|
| 52 |
This project needs more contributors. Please look at the [Todos](https://github.com/onesoft-sudo/sudobot/blob/main/TODO.md) to see what you can do to help us. Of course you can add new features and/or fix/improve something that isn't listed in the todos! We'll be really thankful if you contribute. |
| 53 |
|
| 54 |
If you like the bot, then please make sure to star this repository! And also if possible, you could help us by donating. As an open source project development team, we don't earn anything after all these hard work. Even a small donation of $1 can help us a lot. |
| 55 |
|
| 56 |
### Features |
| 57 |
|
| 58 |
- Strong auto moderation system with tools like anti-spam and anti-raid ([Click here](https://docs.sudobot.online/automoderation/#what-can-the-bot-do) to see the full list) |
| 59 |
- Useful moderation tools and utilities |
| 60 |
- Secure |
| 61 |
- Fun commands |
| 62 |
- Active development & support |
| 63 |
|
| 64 |
### Getting started |
| 65 |
|
| 66 |
You can request an invitation for SudoBot [here](https://discord.gg/pazm3tqYh5), it's completely free, and you can ask us for help anytime. |
| 67 |
Alternatively, you can create your own Discord API application and then host SudoBot. |
| 68 |
|
| 69 |
### Setup for Custom Hosting |
| 70 |
|
| 71 |
Please look at [this page](https://docs.sudobot.online/getting-started) of the documentation. |
| 72 |
|
| 73 |
### Source Code & Downloads |
| 74 |
|
| 75 |
You can browse the source code at the [GitHub repository](https://github.com/onesoft-sudo/sudobot) or [Subversion repository](https://svn.onesoftnet.eu.org/viewvc). |
| 76 |
You can also download release tarballs at [OSN's download server](https://downloads.onesoftnet.eu.org): |
| 77 |
|
| 78 |
- HTTP: [https://downloads.onesoftnet.eu.org](https://downloads.onesoftnet.eu.org) |
| 79 |
- FTP: [ftp://ftp.onesoftnet.eu.org](ftp://ftp.onesoftnet.eu.org) with anonymous read access. |
| 80 |
|
| 81 |
### Contributors [A-Z] |
| 82 |
|
| 83 |
Thanks to all the active and indirect contributors! |
| 84 |
|
| 85 |
- [Ar Rakin](https://github.com/virtual-designer) (Maintainer) |
| 86 |
- [dicoderin](https://github.com/dicoderin) |
| 87 |
- [GuynnR](https://github.com/GuynnR) |
| 88 |
- Hana (A Discord User) |
| 89 |
- [Kars](https://github.com/kars1996) |
| 90 |
- [killerclaws12](https://github.com/killerclaws12) |
| 91 |
- [MonzterDev](https://github.com/MonzterDev) |
| 92 |
- [ninsaccplayzyt](https://github.com/ninsaccplayzyt) |
| 93 |
- [Ryanmello07](https://github.com/Ryanmello07) (Contributed by helping us improve, also by giving away a hosting server and domain name to us) |
| 94 |
|
| 95 |
### Mailing Lists |
| 96 |
|
| 97 |
If you prefer communicating over emails or mailing lists, you can send your message at <[email protected]>, which is a mailing list specifically for discussions, bug reports and questions about SudoBot. |
| 98 |
For more information about this mailing list, check out the [list info](https://lists.onesoftnet.eu.org/mailman/listinfo/sudobot) page. |
| 99 |
Mail archives for this mailing list can be found [here](https://lists.onesoftnet.eu.org/pipermail/sudobot). |
| 100 |
|
| 101 |
### License |
| 102 |
|
| 103 |
SudoBot is licensed under the [GNU Affero General Public License v3.0](https://gnu.org/licenses/agpl-3.0.html). You can find the full license text in the [LICENSE](./LICENSE) file distributed in this repository. |
| 104 |
|
| 105 |
#### Exceptions |
| 106 |
|
| 107 |
- [The emojis](https://www.onesoftnet.eu.org/downloads/sudo/emojis/) are licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). |
| 108 |
- [The SudoBot Logo](https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png) is licensed under the [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/). |
| 109 |
- [The documentation website of SudoBot](https://docs.sudobot.online) is dual-licensed under the [GNU Affero General Public License v3.0](https://gnu.org/licenses/agpl-3.0.html) and the [GNU Free Documentation License v1.3](https://gnu.org/licenses/fdl-1.3.html).<br />Read the [README.md](./docs/README.md) file in the `docs` directory for more information. |
| 110 |
- [BlazeBuild](./blazebuild), the build tool that SudoBot uses, is licensed under the [GNU General Public License v3.0](https://gnu.org/licenses/gpl-3.0.html). |
| 111 |
|
| 112 |
### Support |
| 113 |
|
| 114 |
- **Email**: [email protected] |
| 115 |
- **Mailing List**: [email protected] |
| 116 |
- **Website**: https://www.sudobot.online |
| 117 |
- **Discord Servers**: [OneSoftNet Server](https://discord.gg/892GWhTzgs) |
| 118 |
|
| 119 |
### Extra |
| 120 |
|
| 121 |
- **Download Emojis**: https://www.onesoftnet.eu.org/downloads/sudo/emojis/ <br /> |
| 122 |
Note that not all emojis are present there. You'll find the missing one's at [emoji.gg](https://emoji.gg). |
| 123 |
- **Dashboard**: https://github.com/onesoft-sudo/sudobot-dashboard <br /> |
| 124 |
The dashboard of SudoBot. Note that the dashboard is not complete yet. |
| 125 |
- **Old site**: https://sudobot-dashboard-6c7506h5v-osn.vercel.app/ |
| 126 |
|
| 127 |
Copyright © 2022-2024 OSN and all the contributors of SudoBot. |
Parent Directory
| 
Revision Log
