/[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 451 by rakin, Mon Jul 29 17:30:18 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 ([Click here](https://onesoft-sudo.github.io/sudobot/automoderation/#what-can-the-bot-do) to see the full list)
23    - Useful moderation tools and utilities
24    - Secure
25    - Fun commands
26    - Active development & support
27    
28  ### Getting started  ### Getting started
29    
30  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 22  Alternatively, you can create your own D Line 32  Alternatively, you can create your own D
32    
33  ### Setup for Custom Hosting  ### Setup for Custom Hosting
34    
35    #### Requirements
36    * NodeJS version 16 or higher
37    * MongoDB version 5.0 or higher
38    * A Discord API application token with proper setup
39    
40    #### Optional Services
41    * Cat and dog API Token (for fetching cat and dog images using `cat` and `dog` commands, the tokens can be obtained at [thecatapi.com](https://thecatapi.com) and [thedogapi.com](https://thedogapi.com))
42    * Pixabay API Token (can be obtained [here](https://pixabay.com/api/docs/))
43    * A Discord Webhook URL for sending error reports
44    * A JWT Secret for the API services (if you don't have an API secret, you can run `openssl rand -base64 10` to generate a random base64 string and use it as secret)
45    
46  First, download the latest release or clone the repo by running:  First, download the latest release or clone the repo by running:
47    
48  ```  ```
49  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
50  ```  ```
51    
52  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following command:
53    
54  ```  ```
 mkdir config tmp storage logs  
 touch logs/join-leave.log  
 echo "{}" > config/snippets.json  
 cp sample-config.json config/config.json  
 npm install  
55  npm install -D  npm install -D
56  ```  ```
57    
58  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.  
59    
60  ```json  ```json
61  {  {
# Line 60  Then open up the `config/config.json` fi Line 75  Then open up the `config/config.json` fi
75  }  }
76  ```  ```
77    
78    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
79    
80    Then copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
81    
82  Build the project:  Build the project:
83    
84  ```  ```
# Line 78  Start the bot: Line 97  Start the bot:
97  npm start  npm start
98  ```  ```
99    
100  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]!`.
101  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:
102    
103  ```  ```
# Line 91  Congratulations! You've successfully set Line 110  Congratulations! You've successfully set
110  ### Support  ### Support
111    
112  - **Email**: [email protected]  - **Email**: [email protected]
113  - **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.451
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26