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

Diff of /trunk/README.md

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

revision 176 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 35  mkdir config tmp storage logs Line 42  mkdir config tmp storage logs
42  touch logs/join-leave.log  touch logs/join-leave.log
43  echo "{}" > config/snippets.json  echo "{}" > config/snippets.json
44  cp sample-config.json config/config.json  cp sample-config.json config/config.json
 npm install  
45  npm install -D  npm install -D
46  ```  ```
47    
48  Then open up the `config/config.json` file and change at least the following:  Then open up the `config/config.json` file and change at least the following:
 **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.  
49    
50  ```json  ```json
51  {  {
# Line 60  Then open up the `config/config.json` fi Line 65  Then open up the `config/config.json` fi
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 78  Start the bot: Line 85  Start the bot:
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 "The system has logged in to discord".  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:  Then you can run the following command in Discord to make sure everything is working:
90    
91  ```  ```
Legend:
Removed from v.176  
changed lines
  Added in v.212
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26