sudobot/trunk/README.md


<p align="center">
<img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">
</p>

<h1 align="center">SudoBot</h1>

<p align="center">
<a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml/badge.svg" alt="Build"></a>
<img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub">
<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/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity">
<a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a>
</p>

<p align="center">
A Discord bot for moderation purposes.
</p>

### Features

- Strong automoderation system with tools like anti-spam and anti-raid ([Click here](https://onesoft-sudo.github.io/sudobot/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 invite for SudoBot [here](https://sudobot.everything-server.ml/).
Alternatively, you can create your own Discord API application and then host SudoBot.

### Setup for Custom Hosting

#### Requirements
* NodeJS version 16 or higher
* MongoDB version 5.0 or higher
* A Discord API application token with proper setup

#### Optional Services
* Cat and dog API Token (for fetching cat and dog images using `cat` and `dog` commands, the tokens can be obtained at [thecatapi.com](https://thecatapi.com) and [thedogapi.com](https://thedogapi.com))
* Pixabay API Token (can be obtained [here](https://pixabay.com/api/docs/))
* A Discord Webhook URL for sending error reports
* A JWT Secret for the API services (if you don't have an API secret, you can run `openssl rand -base64 10` to generate a random base64 string and use it as secret)

### Setup steps

1. Download the latest release or clone the repo by running:

```
git clone https://github.com/onesoft-sudo/sudobot
```

2. Go inside the project directory, and run the following command:

```
npm install -D
```

3. Open up the `config/config.json` file and change at least the following:

```json
{
    "global": {
        "id": "set your home guild id",
        "owners": ["set owner user ids here"],
        ...
    },
    "guild id here": {
       "prefix": "-",
       "mod_role": "the mod role, users having it will be able to use the bot",
       "gen_role": "general role id, which all users have",
       "mute_role": "the muted role id",
       "admin": "the admin role id. users having it will be immune to sudobot.",
       ...
    }
}
```

**Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.

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.

4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.

5. Build the project:

```
npm run build
```

6. Deploy slash commands globally:

```
node deploy-commands.js
```

7. Start the bot:

```
npm start
```

And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
Then you can run the following command in Discord to make sure everything is working:

```
-about
```

That should show the bot information.
Congratulations! You've successfully set up your own instance of SudoBot!

### Contributors

Thanks to all the contributors!

* [Ar Rakin](https://github.com/virtual-designer)
* [killerclaws12](https://github.com/killerclaws12)

### Support

- **Email**: [email protected]
- **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
1	rakin	413
2	rakin	168	<p align="center">
3	rakin	211	<img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">
4	rakin	168	</p>
5	rakin	9
6	rakin	168	<h1 align="center">SudoBot</h1>
7	rakin	9
8	rakin	168	<p align="center">
9			<a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml/badge.svg" alt="Build"></a>
10			<img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub">
11			<img src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?label=Version" alt="GitHub package.json version">
12			<img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity">
13	rakin	217	<a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a>
14	rakin	168	</p>
15	rakin	9
16	rakin	168	<p align="center">
17			A Discord bot for moderation purposes.
18			</p>
19	rakin	173
20	rakin	179	### Features
21
22	rakin	434	- Strong automoderation system with tools like anti-spam and anti-raid ([Click here](https://onesoft-sudo.github.io/sudobot/automoderation/#what-can-the-bot-do) to see the full list)
23			- Useful moderation tools and utilities
24	rakin	179	- Secure
25			- Fun commands
26	rakin	434	- Active development & support
27	rakin	179
28	rakin	173	### Getting started
29
30			You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).
31			Alternatively, you can create your own Discord API application and then host SudoBot.
32
33			### Setup for Custom Hosting
34
35	rakin	432	#### Requirements
36			* NodeJS version 16 or higher
37			* MongoDB version 5.0 or higher
38			* A Discord API application token with proper setup
39
40			#### Optional Services
41			* Cat and dog API Token (for fetching cat and dog images using `cat` and `dog` commands, the tokens can be obtained at [thecatapi.com](https://thecatapi.com) and [thedogapi.com](https://thedogapi.com))
42			* Pixabay API Token (can be obtained [here](https://pixabay.com/api/docs/))
43			* A Discord Webhook URL for sending error reports
44	rakin	451	* A JWT Secret for the API services (if you don't have an API secret, you can run `openssl rand -base64 10` to generate a random base64 string and use it as secret)
45	rakin	432
46	rakin	458	### Setup steps
47	rakin	173
48	rakin	458	1. Download the latest release or clone the repo by running:
49
50	rakin	173	```
51			git clone https://github.com/onesoft-sudo/sudobot
52			```
53
54	rakin	458	2. Go inside the project directory, and run the following command:
55	rakin	173
56			```
57			npm install -D
58			```
59
60	rakin	458	3. Open up the `config/config.json` file and change at least the following:
61	rakin	176
62			```json
63			{
64			"global": {
65			"id": "set your home guild id",
66			"owners": ["set owner user ids here"],
67			...
68			},
69			"guild id here": {
70			"prefix": "-",
71			"mod_role": "the mod role, users having it will be able to use the bot",
72			"gen_role": "general role id, which all users have",
73			"mute_role": "the muted role id",
74			"admin": "the admin role id. users having it will be immune to sudobot.",
75			...
76			}
77			}
78			```
79
80	rakin	178	Note: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
81
82	rakin	458	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.
83	rakin	414
84	rakin	458	4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
85	rakin	173
86	rakin	458	5. Build the project:
87
88	rakin	173	```
89			npm run build
90			```
91
92	rakin	458	6. Deploy slash commands globally:
93	rakin	173
94			```
95			node deploy-commands.js
96			```
97
98	rakin	458	7. Start the bot:
99	rakin	173
100			```
101			npm start
102			```
103	rakin	176
104	rakin	177	And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
105	rakin	176	Then you can run the following command in Discord to make sure everything is working:
106
107			```
108			-about
109			```
110
111			That should show the bot information.
112			Congratulations! You've successfully set up your own instance of SudoBot!
113
114	rakin	457	### Contributors
115
116			Thanks to all the contributors!
117
118			* [Ar Rakin](https://github.com/virtual-designer)
119			* [killerclaws12](https://github.com/killerclaws12)
120
121	rakin	176	### Support
122
123			- Email: [email protected]
124	rakin	219	- Discord Servers: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)