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

Diff of /trunk/README.md

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

revision 177 by rakin, Mon Jul 29 17:28:53 2024 UTC revision 405 by rakin, Mon Jul 29 17:30:04 2024 UTC
# Line 1  Line 1 
1    
2  <p align="center">  <p align="center">
3  <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">
4  </p>  </p>
5    
6  <h1 align="center">SudoBot</h1>  <h1 align="center">SudoBot</h1>
# Line 9  Line 10 
10  <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">
11  <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">
12  <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">
13    <a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a>
14  </p>  </p>
15    
16  <p align="center">  <p align="center">
17  A Discord bot for moderation purposes.  A Discord bot for moderation purposes.
18  </p>  </p>
19    
20    ### Features
21    
22    - Strong automoderation system with tools like anti-spam and anti-raid
23    - Useful moderation tools
24    - Secure
25    - Fun commands
26    
27  ### Getting started  ### Getting started
28    
29  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 37  First, download the latest release or cl
37  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
38  ```  ```
39    
40  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following command:
41    
42  ```  ```
 mkdir config tmp storage logs  
 touch logs/join-leave.log  
 echo "{}" > config/snippets.json  
 cp sample-config.json config/config.json  
 npm install  
43  npm install -D  npm install -D
44  ```  ```
45    
46  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.  
47    
48  ```json  ```json
49  {  {
# Line 60  Then open up the `config/config.json` fi Line 63  Then open up the `config/config.json` fi
63  }  }
64  ```  ```
65    
66    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
67    
68  Build the project:  Build the project:
69    
70  ```  ```
# Line 91  Congratulations! You've successfully set Line 96  Congratulations! You've successfully set
96  ### Support  ### Support
97    
98  - **Email**: [email protected]  - **Email**: [email protected]
99  - **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.177  
changed lines
  Added in v.405
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26