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
- Useful moderation tools 
- Secure
- Fun commands

### 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

First, download the latest release or clone the repo by running:

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

Then go inside the project directory, and run the following commands:

```
mkdir config tmp storage logs
touch logs/join-leave.log
echo "{}" > config/snippets.json
cp sample-config.json config/config.json
npm install -D
```

Then 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.

Build the project:

```
npm run build
```

Deploy slash commands globally:

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

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!

### Support

- **Email**: [email protected]
- **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
1	rakin	168	<p align="center">
2	rakin	211	<img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">
3	rakin	168	</p>
4	rakin	9
5	rakin	168	<h1 align="center">SudoBot</h1>
6	rakin	9
7	rakin	168	<p align="center">
8			<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>
9			<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">
11			<img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity">
12	rakin	217	<a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a>
13	rakin	168	</p>
14	rakin	9
15	rakin	168	<p align="center">
16			A Discord bot for moderation purposes.
17			</p>
18	rakin	173
19	rakin	179	### Features
20
21			- Strong automoderation system with tools like anti-spam and anti-raid
22			- Useful moderation tools
23			- Secure
24			- Fun commands
25
26	rakin	173	### Getting started
27
28			You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).
29			Alternatively, you can create your own Discord API application and then host SudoBot.
30
31			### Setup for Custom Hosting
32
33			First, download the latest release or clone the repo by running:
34
35			```
36			git clone https://github.com/onesoft-sudo/sudobot
37			```
38
39			Then go inside the project directory, and run the following commands:
40
41			```
42	rakin	176	mkdir config tmp storage logs
43			touch logs/join-leave.log
44	rakin	173	echo "{}" > config/snippets.json
45	rakin	176	cp sample-config.json config/config.json
46	rakin	173	npm install -D
47			```
48
49	rakin	176	Then open up the `config/config.json` file and change at least the following:
50
51			```json
52			{
53			"global": {
54			"id": "set your home guild id",
55			"owners": ["set owner user ids here"],
56			...
57			},
58			"guild id here": {
59			"prefix": "-",
60			"mod_role": "the mod role, users having it will be able to use the bot",
61			"gen_role": "general role id, which all users have",
62			"mute_role": "the muted role id",
63			"admin": "the admin role id. users having it will be immune to sudobot.",
64			...
65			}
66			}
67			```
68
69	rakin	178	Note: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
70
71	rakin	173	Build the project:
72
73			```
74			npm run build
75			```
76
77			Deploy slash commands globally:
78
79			```
80			node deploy-commands.js
81			```
82
83			Start the bot:
84
85			```
86			npm start
87			```
88	rakin	176
89	rakin	177	And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
90	rakin	176	Then you can run the following command in Discord to make sure everything is working:
91
92			```
93			-about
94			```
95
96			That should show the bot information.
97			Congratulations! You've successfully set up your own instance of SudoBot!
98
99			### Support
100
101			- Email: [email protected]
102	rakin	219	- Discord Servers: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)