/[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 483 by rakin, Mon Jul 29 17:30:27 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>
6    
# 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 ([Click here](https://onesoft-sudo.github.io/sudobot/automoderation/#what-can-the-bot-do) to see the full list)
22    - Useful moderation tools and utilities
23    - Secure
24    - Fun commands
25    - Active development & support
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 22  Alternatively, you can create your own D Line 31  Alternatively, you can create your own D
31    
32  ### Setup for Custom Hosting  ### Setup for Custom Hosting
33    
34  First, download the latest release or clone the repo by running:  #### Requirements
35    * NodeJS version 16 or higher
36    * MongoDB version 5.0 or higher
37    * A Discord API application token with proper setup
38    
39    #### Optional Services
40    * 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))
41    * Pixabay API Token (can be obtained [here](https://pixabay.com/api/docs/))
42    * A Discord Webhook URL for sending error reports
43    * 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)
44    
45    ### Setup steps
46    
47    1. Download the latest release or clone the repo by running:
48    
49  ```  ```
50  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
51  ```  ```
52    
53  Then go inside the project directory, and run the following commands:  2. Go inside the project directory, and run the following command:
54    
55  ```  ```
 mkdir config tmp storage logs  
 touch logs/join-leave.log  
 echo "{}" > config/snippets.json  
 cp sample-config.json config/config.json  
 npm install  
56  npm install -D  npm install -D
57  ```  ```
58    
59  Then open up the `config/config.json` file and change at least the following:  3. 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.  
60    
61  ```json  ```json
62  {  {
# Line 60  Then open up the `config/config.json` fi Line 76  Then open up the `config/config.json` fi
76  }  }
77  ```  ```
78    
79  Build the project:  **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
80    
81    > Alternatively, you can try the new `setup.js` installer script [BETA] by running `node setup.js`. It will ask you some questions about the configuration.
82    
83    4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
84    
85    5. Build the project:
86    
87  ```  ```
88  npm run build  npm run build
89  ```  ```
90    
91  Deploy slash commands globally:  6. Deploy slash commands globally:
92    
93  ```  ```
94  node deploy-commands.js  node deploy-commands.js
95  ```  ```
96    
97  Start the bot:  7. Start the bot:
98    
99  ```  ```
100  npm start  npm start
101  ```  ```
102    
103  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]!`.
104  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:
105    
106  ```  ```
# Line 88  Then you can run the following command i Line 110  Then you can run the following command i
110  That should show the bot information.  That should show the bot information.
111  Congratulations! You've successfully set up your own instance of SudoBot!  Congratulations! You've successfully set up your own instance of SudoBot!
112    
113    ### Contributors
114    
115    Thanks to all the contributors!
116    
117    * [Ar Rakin](https://github.com/virtual-designer)
118    * [killerclaws12](https://github.com/killerclaws12)
119    
120  ### Support  ### Support
121    
122  - **Email**: [email protected]  - **Email**: [email protected]
123  - **Discord Server**: [Support Server Invite](https://discord.gg/892GWhTzgs)  - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
124    
125    ### Extra
126    
127    - **Dashboard**: The dashboard for SudoBot can be found [here](https://github.com/onesoft-sudo/sudobot-dashboard).
Legend:
Removed from v.176  
changed lines
  Added in v.483
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26