/[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 212 by rakin, Mon Jul 29 17:29:02 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 15  Line 15 
15  A Discord bot for moderation purposes.  A Discord bot for moderation purposes.
16  </p>  </p>
17    
18    ### Features
19    
20    - Strong automoderation system with tools like anti-spam and anti-raid
21    - Useful moderation tools
22    - Secure
23    - Fun commands
24    
25  ### Getting started  ### Getting started
26    
27  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 31  git clone https://github.com/onesoft-sud Line 38  git clone https://github.com/onesoft-sud
38  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following commands:
39    
40  ```  ```
41  sh init.sh  mkdir config tmp storage logs
42  touch config/config.json .env  touch logs/join-leave.log
43  echo "{}" > config/snippets.json  echo "{}" > config/snippets.json
44  npm install  cp sample-config.json config/config.json
45  npm install -D  npm install -D
46  ```  ```
47    
48    Then open up the `config/config.json` file and change at least the following:
49    
50    ```json
51    {
52        "global": {
53            "id": "set your home guild id",
54            "owners": ["set owner user ids here"],
55            ...
56        },
57        "guild id here": {
58           "prefix": "-",
59           "mod_role": "the mod role, users having it will be able to use the bot",
60           "gen_role": "general role id, which all users have",
61           "mute_role": "the muted role id",
62           "admin": "the admin role id. users having it will be immune to sudobot.",
63           ...
64        }
65    }
66    ```
67    
68    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
69    
70  Build the project:  Build the project:
71    
72  ```  ```
# Line 55  Start the bot: Line 84  Start the bot:
84  ```  ```
85  npm start  npm start
86  ```  ```
87    
88    And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
89    Then you can run the following command in Discord to make sure everything is working:
90    
91    ```
92    -about
93    ```
94    
95    That should show the bot information.
96    Congratulations! You've successfully set up your own instance of SudoBot!
97    
98    ### Support
99    
100    - **Email**: [email protected]
101    - **Discord Server**: [Support Server Invite](https://discord.gg/892GWhTzgs)
Legend:
Removed from v.173  
changed lines
  Added in v.212
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26