[go: up one dir, main page]
Menu ▾ ▴

Tree [4d3f34] v3.0.2 /
 History

HTTPS git://
HTTPS access

File Date Author Commit
 .github 2022-08-15 Ar Rakin Ar Rakin [f5de1d] chore: update issue templates
 .husky 2022-07-17 Ar Rakin Ar Rakin [9a1dd7] build: add husky directory
 docs 2022-09-03 Ar Rakin Ar Rakin [b7fbc9] docs: update terms of service
 resources 2022-09-03 Ar Rakin Ar Rakin [c1ec0d] refactor: mention users while welcoming
 src 2022-09-04 Ar Rakin Ar Rakin [4d3f34] fix: emoji command not working (#62)
 .editorconfig 2022-05-27 Ar Rakin Ar Rakin [c70fb4] Release version 2.0
 .env.example 2022-08-26 Ar Rakin Ar Rakin [c0a64b] chore: update example env file
 .gitignore 2022-08-14 Ar Rakin Ar Rakin [05f55a] chore: ignore lock file
 .gitpod.yml 2022-08-29 Ar Rakin Ar Rakin [792c14] feat: add basic user lookup command
 CODE_OF_CONDUCT.md 2022-06-13 Ar Rakin Ar Rakin [30eb94] Added Code of Conduct (#14)
 CONTRIBUTING.md 2022-06-13 Ar Rakin Ar Rakin [d3c41a] Create CONTRIBUTING.md
 Changelog.md 2022-08-26 Ar Rakin Ar Rakin [e3c250] docs: add changelog
 LICENSE 2022-08-09 Ar Rakin Ar Rakin [57912a] Create LICENSE
 README.md 2022-08-16 Ar Rakin Ar Rakin [a32109] docs: update readme
 SECURITY.md 2022-07-18 Ar Rakin Ar Rakin [96b327] doc: add security policy
 commitlint.config.js 2022-07-17 Ar Rakin Ar Rakin [7802ba] build: add husky and commitlint
 deploy-commands.js 2022-08-31 Ar Rakin Ar Rakin [cc780c] feat: add a PFP lookup command (#64)
 ecosystem.config.js 2022-08-26 Ar Rakin Ar Rakin [f5609e] style: remove unneeded spaces
 init.sh 2022-08-18 Ar Rakin Ar Rakin [7bac92] feat: improved channel locking system (#18)
 mkdocs.yml 2022-06-12 Ar Rakin Ar Rakin [000d89] Change copyright holder name
 package.json 2022-09-01 Ar Rakin Ar Rakin [4a7d14] feat: save the given status to config file (#66)
 sample-config.json 2022-07-30 Ar Rakin Ar Rakin [b63be1] fix: wrong sample config
 slappey.json 2022-05-27 Ar Rakin Ar Rakin [c70fb4] Release version 2.0
 start.sh 2022-05-29 Ar Rakin Ar Rakin [86e6da] Added debug info support and startup manager
 tsconfig.json 2022-06-12 Ar Rakin Ar Rakin [8d7c75] Updated package.json

Read Me

SudoBot

Build GitHub GitHub package.json version GitHub commit activity Discord

A Discord bot for moderation purposes.

Features

  • Strong automoderation system with tools like anti-spam and anti-raid
  • Useful moderation tools
  • Secure
  • Fun commands

Getting started

You can request an invite for SudoBot here.
Alternatively, you can create your own Discord API application and then host SudoBot.

Setup for Custom Hosting

First, download the latest release or clone the repo by running:

git clone https://github.com/onesoft-sudo/sudobot

Then go inside the project directory, and run the following command:

npm install -D

Then open up the config/config.json file and change at least the following:

{
    "global": {
        "id": "set your home guild id",
        "owners": ["set owner user ids here"],
        ...
    },
    "guild id here": {
       "prefix": "-",
       "mod_role": "the mod role, users having it will be able to use the bot",
       "gen_role": "general role id, which all users have",
       "mute_role": "the muted role id",
       "admin": "the admin role id. users having it will be immune to sudobot.",
       ...
    }
}

Note: ... means other options that exist in the config, you can edit them to customize the settings, but not required.

Build the project:

npm run build

Deploy slash commands globally:

node deploy-commands.js

Start the bot:

npm start

And if everything was configured correctly, you should not see an error and the bot should say Logged in as [tag]!.
Then you can run the following command in Discord to make sure everything is working:

-about

That should show the bot information.
Congratulations! You've successfully set up your own instance of SudoBot!

Support