/discord-needle

Needle is a Discord bot that helps you declutter your server by creating Discord threads automatically.

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Needle

Needle is a Discord bot that helps you declutter your server by creating Discord threads automatically.

Website ✨   Invite Needle 🪡   Get support 💬

Self-hosting

This step-by-step guide assumes you have NodeJS version 16.9.0 or higher installed and that you have a Discord Bot user set up at Discord's developer page that has been invited to your server with the scopes applications.commands and bot.

  1. Fork and clone the repository
  2. Copy .env.example to .env and insert your bot's Discord API token and Application ID.
  3. Run npm install
  4. Run npm run deploy. This will make the slash commands show up in the servers the bot are in, but it can take up to ONE HOUR before they show up.
  5. Make sure the bot has the required permissions in Discord:
    • View channels
    • Send messages
    • Send messages in threads
    • Create public threads
    • Read message history
  6. Run npm start
  7. Deploy! 🎉

Contributing

Coming soon ™️

Join the Discord if interested!

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.