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

Diff of /trunk/README.md

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

revision 173 by rakin, Mon Jul 29 17:28:53 2024 UTC revision 178 by rakin, Mon Jul 29 17:28:54 2024 UTC
# Line 31  git clone https://github.com/onesoft-sud Line 31  git clone https://github.com/onesoft-sud
31  Then go inside the project directory, and run the following commands:  Then go inside the project directory, and run the following commands:
32    
33  ```  ```
34  sh init.sh  mkdir config tmp storage logs
35  touch config/config.json .env  touch logs/join-leave.log
36  echo "{}" > config/snippets.json  echo "{}" > config/snippets.json
37    cp sample-config.json config/config.json
38  npm install  npm install
39  npm install -D  npm install -D
40  ```  ```
41    
42    Then open up the `config/config.json` file and change at least the following:
43    
44    ```json
45    {
46        "global": {
47            "id": "set your home guild id",
48            "owners": ["set owner user ids here"],
49            ...
50        },
51        "guild id here": {
52           "prefix": "-",
53           "mod_role": "the mod role, users having it will be able to use the bot",
54           "gen_role": "general role id, which all users have",
55           "mute_role": "the muted role id",
56           "admin": "the admin role id. users having it will be immune to sudobot.",
57           ...
58        }
59    }
60    ```
61    
62    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
63    
64  Build the project:  Build the project:
65    
66  ```  ```
# Line 55  Start the bot: Line 78  Start the bot:
78  ```  ```
79  npm start  npm start
80  ```  ```
81    
82    And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
83    Then you can run the following command in Discord to make sure everything is working:
84    
85    ```
86    -about
87    ```
88    
89    That should show the bot information.
90    Congratulations! You've successfully set up your own instance of SudoBot!
91    
92    ### Support
93    
94    - **Email**: [email protected]
95    - **Discord Server**: [Support Server Invite](https://discord.gg/892GWhTzgs)
Legend:
Removed from v.173  
changed lines
  Added in v.178
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26