/[sudobot]/trunk/README.md
ViewVC logotype

Diff of /trunk/README.md

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 173 by rakin, Mon Jul 29 17:28:53 2024 UTC revision 230 by rakin, Mon Jul 29 17:29:07 2024 UTC
# Line 1  Line 1 
1  <p align="center">  <p align="center">
2  <img src="https://res.cloudinary.com/rakinar2/image/upload/v1651761676/sudobot4_r257uw.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>
4    
5  <h1 align="center">SudoBot</h1>  <h1 align="center">SudoBot</h1>
# Line 9  Line 9 
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>
13  </p>  </p>
14    
15  <p align="center">  <p align="center">
16  A Discord bot for moderation purposes.  A Discord bot for moderation purposes.
17  </p>  </p>
18    
19    ### 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  ### Getting started  ### Getting started
27    
28  You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).  You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).
# Line 28  First, download the latest release or cl Line 36  First, download the latest release or cl
36  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
37  ```  ```
38    
39  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following command:
40    
41  ```  ```
 sh init.sh  
 touch config/config.json .env  
 echo "{}" > config/snippets.json  
 npm install  
42  npm install -D  npm install -D
43  ```  ```
44    
45    Then open up the `config/config.json` file and change at least the following:
46    
47    ```json
48    {
49        "global": {
50            "id": "set your home guild id",
51            "owners": ["set owner user ids here"],
52            ...
53        },
54        "guild id here": {
55           "prefix": "-",
56           "mod_role": "the mod role, users having it will be able to use the bot",
57           "gen_role": "general role id, which all users have",
58           "mute_role": "the muted role id",
59           "admin": "the admin role id. users having it will be immune to sudobot.",
60           ...
61        }
62    }
63    ```
64    
65    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
66    
67  Build the project:  Build the project:
68    
69  ```  ```
# Line 55  Start the bot: Line 81  Start the bot:
81  ```  ```
82  npm start  npm start
83  ```  ```
84    
85    And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
86    Then you can run the following command in Discord to make sure everything is working:
87    
88    ```
89    -about
90    ```
91    
92    That should show the bot information.
93    Congratulations! You've successfully set up your own instance of SudoBot!
94    
95    ### Support
96    
97    - **Email**: [email protected]
98    - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
Legend:
Removed from v.173  
changed lines
  Added in v.230
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26