/[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 219 by rakin, Mon Jul 29 17:29:04 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 31  git clone https://github.com/onesoft-sud Line 39  git clone https://github.com/onesoft-sud
39  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following commands:
40    
41  ```  ```
42  sh init.sh  mkdir config tmp storage logs
43  touch config/config.json .env  touch logs/join-leave.log
44  echo "{}" > config/snippets.json  echo "{}" > config/snippets.json
45  npm install  cp sample-config.json config/config.json
46  npm install -D  npm install -D
47  ```  ```
48    
49    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    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
70    
71  Build the project:  Build the project:
72    
73  ```  ```
# Line 55  Start the bot: Line 85  Start the bot:
85  ```  ```
86  npm start  npm start
87  ```  ```
88    
89    And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
90    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    - **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.219

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26