{"id":19826276,"url":"https://github.com/aternosorg/modbot","last_synced_at":"2025-04-13T07:48:59.382Z","repository":{"id":37040190,"uuid":"245639322","full_name":"aternosorg/modbot","owner":"aternosorg","description":"An open source moderation bot with advanced features developed by Aternos.","archived":false,"fork":false,"pushed_at":"2025-03-17T11:23:56.000Z","size":3315,"stargazers_count":145,"open_issues_count":0,"forks_count":69,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-13T07:48:49.794Z","etag":null,"topics":["discord","discord-bot","discord-js"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aternosorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-07T13:38:54.000Z","updated_at":"2025-04-10T17:13:41.000Z","dependencies_parsed_at":"2024-01-20T23:31:33.409Z","dependency_job_id":"0eabcdcc-0112-490b-aded-b740da24ba9a","html_url":"https://github.com/aternosorg/modbot","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aternosorg%2Fmodbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aternosorg%2Fmodbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aternosorg%2Fmodbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aternosorg%2Fmodbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aternosorg","download_url":"https://codeload.github.com/aternosorg/modbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681494,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord","discord-bot","discord-js"],"created_at":"2024-11-12T11:09:57.103Z","updated_at":"2025-04-13T07:48:59.355Z","avatar_url":"https://github.com/aternosorg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ModBot\n[![Discord](https://img.shields.io/discord/826482655893127248?style=plastic)](https://discord.gg/zYYhgPtmxw)\n[![GitHub](https://img.shields.io/github/license/aternosorg/modbot?style=plastic)](https://github.com/aternosorg/modbot/blob/master/LICENSE)\n[![GitHub contributors](https://img.shields.io/github/contributors/aternosorg/modbot?style=plastic)](https://github.com/aternosorg/modbot/graphs/contributors)\n[![GitHub last commit](https://img.shields.io/github/last-commit/aternosorg/modbot?style=plastic)](https://github.com/aternosorg/modbot/commits/)\n\n---\nModBot is an open source moderation bot with advanced features developed by [Aternos](https://aternos.org/).\n\nIt uses **modern Discord features** like slash-commands, context-menus, timeouts, buttons, select-menus\nand modals and offers everything you need for moderation. Including bad-words and auto-responses\nwith support for regex, detecting phishing urls, temporary bans, a strike system, message logging\nand various other forms of automatic moderation filters.\n\n\n### Screenshots\nModerating users or viewing information is faster than ever thanks to buttons, modals and context menus:\n\n![User Embed](https://user-images.githubusercontent.com/45244473/196917527-cff86e16-f074-493d-8067-a85c0599c102.png)\n\nModBot will prevent accidentally punishing a user twice by warning the moderator if another moderator\nhas punished this user in the last 5 minutes.\n\n![Strike Confirmation](https://user-images.githubusercontent.com/45244473/196927951-5a3f8cda-8cda-4824-a094-ee868a335709.png)\n\n### Add ModBot to your server\nBy adding the bot to your server you agree to our [privacy policy](https://aternos.gmbh/en/modbot/privacy). \u003cbr\u003e\nInvite: [Click me](https://discord.com/oauth2/authorize?client_id=790967448111153153\u0026scope=bot%20applications.commands\u0026permissions=1099780074646)\n\nYou can view all commands by typing a slash `/` in the text input field. \nAll commands and options have clear descriptions.\n\nWe also have a [Discord server](https://discord.gg/zYYhgPtmxw). \u003cbr\u003e\n**Please note: ModBot is a side project for us. \nWe don't earn any money with it and primarily develop it for use on our own servers. \nWe can't help with every problem and won't add features that we don't need.**\n\n### Getting Started\n- You can view the settings with `/settings overview`\n- To set up a log channel use `/settings log-channel \u003c#channel\u003e`\n- You can import strikes, mutes and bans from Vortex using `/import`\n- If you want to configure a YouTube playlist, you can use `/settings playlist \u003curl\u003e`\n- You can also add a Zendesk help center, using `/settings helpcenter \u003curl\u003e` to enable the `/article` command.\n\n### Support\nYou can view the usage of commands with the help command.\u003cbr\u003e\nIf you think you found a bug in ModBot then please create an [issue](https://github.com/aternosorg/modbot/issues). \u003cbr\u003e\nFor security issues please refer to the [SECURITY.md](./SECURITY.md).\n\n### Self Hosting\nIf you want to host the bot yourself you can use our pre-built docker image or install it directly.\nIn both cases you will need a [MySQL](https://dev.mysql.com/downloads/mysql/) database and a \n[Discord application](https://discord.com/developers/applications/):\n\n1. Create a [Discord application](https://discord.com/developers/applications/) and enable the SERVER MEMBERS intent.\n   The bot needs this to reassign the muted role when a muted user joins your server\n2. Add a bot to the application and copy the auth token\n3. Configure the bot (see [CONFIGURATION.md](./CONFIGURATION.md))\n4. To invite the bot to your server replace `ID` with the client ID of your application\n   https://discord.com/oauth2/authorize?client_id=ID\u0026scope=bot%20applications.commands\u0026permissions=1099780074646 and open the link\n5. Follow the instructions for the installation method you want to use\n\n#### Docker\nRequirements: [Docker](https://docs.docker.com/get-docker/)\n```bash \ndocker run -e MODBOT_AUTH_TOKEN=\"\u003cdiscord-auth-token\u003e\" -e MODBOT_DATABASE_HOST=\"\u003cdatabase-host\u003e\" -e MODBOT_DATABASE_PASSWORD=\"\u003cdatabase-password\u003e\" ghcr.io/aternosorg/modbot\n```\n\n#### Direct Installation\nRequirements: [Node.js](https://nodejs.org/en/download/) (v20+), a [MySQL](https://dev.mysql.com/downloads/mysql/) database\n1. Download the code and run `npm ci`\n2. Run `npm start` to start the bot\n\n### Contributing\nIf you want to contribute you need to [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)\nthe repository, then add your changes to your fork and then create a [pull request](https://github.com/aternosorg/modbot/compare).\nWe also recommend looking at the [Documentation](https://discord.js.org/#/docs/) of discord.js. If you have any questions\ncreate an issue or join our [discord](#add-modbot-to-your-server)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faternosorg%2Fmodbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faternosorg%2Fmodbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faternosorg%2Fmodbot/lists"}