/[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 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 35  mkdir config tmp storage logs Line 43  mkdir config tmp storage logs
43  touch logs/join-leave.log  touch logs/join-leave.log
44  echo "{}" > config/snippets.json  echo "{}" > config/snippets.json
45  cp sample-config.json config/config.json  cp sample-config.json config/config.json
 npm install  
46  npm install -D  npm install -D
47  ```  ```
48    
49  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.  
50    
51  ```json  ```json
52  {  {
# Line 60  Then open up the `config/config.json` fi Line 66  Then open up the `config/config.json` fi
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 78  Start the bot: Line 86  Start the bot:
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 "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]!`.
90  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:
91    
92  ```  ```
# Line 91  Congratulations! You've successfully set Line 99  Congratulations! You've successfully set
99  ### Support  ### Support
100    
101  - **Email**: [email protected]  - **Email**: [email protected]
102  - **Discord Server**: [Support Server Invite](https://discord.gg/892GWhTzgs)  - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
Legend:
Removed from v.176  
changed lines
  Added in v.219
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26