sudobot/trunk/README.md

<p align="center">
<a href="https://www.sudobot.org" title="Official Website of SudoBot" target="_blank">
<!--
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/nnanzhwwmpa2k3ebw0yg.png" height="114px" width="348px">
-->
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png" height="114px" width="348px">
</a> 
</p>

<br />

<p align="center">
<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>
<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>
<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>
<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>
<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">
<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>
</p>

<p align="center">
A free and open source Discord bot for moderation purposes. <a href="https://docs.sudobot.org/features/screenshots/">Click here</a> to see the screenshots.
</p>

<!--
<p align="center">
<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>
<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>
</p> -->

## ❗ Need Contributors

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.

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.

### Features

-   Strong auto moderation system with tools like anti-spam and anti-raid ([Click here](https://docs.sudobot.org/automoderation/#what-can-the-bot-do) to see the full list)
-   Useful moderation tools and utilities
-   Secure
-   Fun commands
-   Active development & support

### Getting started

You can request an invitation for SudoBot [here](https://discord.gg/pazm3tqYh5), it's completely free, and you can ask us for help anytime.
Alternatively, you can create your own Discord API application and then host SudoBot.

### Setup for Custom Hosting

Please look at [this page](https://docs.sudobot.org/getting-started) of the documentation.

### Source Code & Downloads

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).
You can also download release tarballs at [OSN's download server](https://downloads.onesoftnet.eu.org):

-  HTTP: [https://downloads.onesoftnet.eu.org](https://downloads.onesoftnet.eu.org)
-  FTP: [ftp://ftp.onesoftnet.eu.org](ftp://ftp.onesoftnet.eu.org) with anonymous read access.

### Contributors [A-Z]

Thanks to all the active and indirect contributors!

-   [Ar Rakin](https://github.com/virtual-designer) (Maintainer)
-   [dicoderin](https://github.com/dicoderin)
-   [GuynnR](https://github.com/GuynnR)
-   Hana (A Discord User)
-   [Kars](https://github.com/kars1996) (Contributed by giving away a domain to us)
-   [killerclaws12](https://github.com/killerclaws12)
-   [MonzterDev](https://github.com/MonzterDev)
-   [ninsaccplayzyt](https://github.com/ninsaccplayzyt)
-   [Ryanmello07](https://github.com/Ryanmello07) (Contributed by giving away a hosting server and by giving a lot of suggestions/ideas to us)

### License

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.

#### Exceptions

- [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/).
- [The SudoBot Logo](https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png) is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
- [The documentation website of SudoBot](https://docs.sudobot.org) 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.
- [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).

### Support

-   **Email**: [email protected]
-   **Website**: https://www.sudobot.org
-   **Discord Servers**: [OneSoftNet Server](https://discord.gg/892GWhTzgs)

### Extra

-   **Download Emojis**: https://www.onesoftnet.eu.org/downloads/sudo/emojis/ <br />
    Note that not all emojis are present there. You'll find the missing one's at [emoji.gg](https://emoji.gg).
-   **Dashboard**: https://github.com/onesoft-sudo/sudobot-dashboard <br />
    The dashboard of SudoBot. Note that the dashboard is not complete yet.

Copyright © 2022-2024 OSN and all the contributors of SudoBot.
1	<p align="center">
2	<a href="https://www.sudobot.org" 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	</p>
20
21	<p align="center">
22	A free and open source Discord bot for moderation purposes. <a href="https://docs.sudobot.org/features/screenshots/">Click here</a> to see the screenshots.
23	</p>
24
25	<!--
26	<p align="center">
27	<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>
28	<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>
29	</p> -->
30
31	## ❗ Need Contributors
32
33	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.
34
35	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.
36
37	### Features
38
39	- Strong auto moderation system with tools like anti-spam and anti-raid ([Click here](https://docs.sudobot.org/automoderation/#what-can-the-bot-do) to see the full list)
40	- Useful moderation tools and utilities
41	- Secure
42	- Fun commands
43	- Active development & support
44
45	### Getting started
46
47	You can request an invitation for SudoBot [here](https://discord.gg/pazm3tqYh5), it's completely free, and you can ask us for help anytime.
48	Alternatively, you can create your own Discord API application and then host SudoBot.
49
50	### Setup for Custom Hosting
51
52	Please look at [this page](https://docs.sudobot.org/getting-started) of the documentation.
53
54	### Source Code & Downloads
55
56	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).
57	You can also download release tarballs at [OSN's download server](https://downloads.onesoftnet.eu.org):
58
59	- HTTP: [https://downloads.onesoftnet.eu.org](https://downloads.onesoftnet.eu.org)
60	- FTP: [ftp://ftp.onesoftnet.eu.org](ftp://ftp.onesoftnet.eu.org) with anonymous read access.
61
62	### Contributors [A-Z]
63
64	Thanks to all the active and indirect contributors!
65
66	- [Ar Rakin](https://github.com/virtual-designer) (Maintainer)
67	- [dicoderin](https://github.com/dicoderin)
68	- [GuynnR](https://github.com/GuynnR)
69	- Hana (A Discord User)
70	- [Kars](https://github.com/kars1996) (Contributed by giving away a domain to us)
71	- [killerclaws12](https://github.com/killerclaws12)
72	- [MonzterDev](https://github.com/MonzterDev)
73	- [ninsaccplayzyt](https://github.com/ninsaccplayzyt)
74	- [Ryanmello07](https://github.com/Ryanmello07) (Contributed by giving away a hosting server and by giving a lot of suggestions/ideas to us)
75
76	### License
77
78	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.
79
80	#### Exceptions
81
82	- [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/).
83	- [The SudoBot Logo](https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png) is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
84	- [The documentation website of SudoBot](https://docs.sudobot.org) 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.
85	- [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).
86
87	### Support
88
89	- Email: [email protected]
90	- Website: https://www.sudobot.org
91	- Discord Servers: [OneSoftNet Server](https://discord.gg/892GWhTzgs)
92
93	### Extra
94
95	- Download Emojis: https://www.onesoftnet.eu.org/downloads/sudo/emojis/ <br />
96	Note that not all emojis are present there. You'll find the missing one's at [emoji.gg](https://emoji.gg).
97	- Dashboard: https://github.com/onesoft-sudo/sudobot-dashboard <br />
98	The dashboard of SudoBot. Note that the dashboard is not complete yet.
99
100	Copyright © 2022-2024 OSN and all the contributors of SudoBot.