/[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 177 by rakin, Mon Jul 29 17:28:53 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    **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
44    
45    ```json
46    {
47        "global": {
48            "id": "set your home guild id",
49            "owners": ["set owner user ids here"],
50            ...
51        },
52        "guild id here": {
53           "prefix": "-",
54           "mod_role": "the mod role, users having it will be able to use the bot",
55           "gen_role": "general role id, which all users have",
56           "mute_role": "the muted role id",
57           "admin": "the admin role id. users having it will be immune to sudobot.",
58           ...
59        }
60    }
61    ```
62    
63  Build the project:  Build the project:
64    
65  ```  ```
# Line 55  Start the bot: Line 77  Start the bot:
77  ```  ```
78  npm start  npm start
79  ```  ```
80    
81    And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
82    Then you can run the following command in Discord to make sure everything is working:
83    
84    ```
85    -about
86    ```
87    
88    That should show the bot information.
89    Congratulations! You've successfully set up your own instance of SudoBot!
90    
91    ### Support
92    
93    - **Email**: [email protected]
94    - **Discord Server**: [Support Server Invite](https://discord.gg/892GWhTzgs)
Legend:
Removed from v.173  
changed lines
  Added in v.177
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26