WeeSupport

A simple-ish bot to assist with the organisation of your Discord community's support channels.

Why?

A lot of my most recent contributions have been to the Arcadia Technology / Crafty Controller project.

During my time contributing and supporting users in their Discord there was always hurdles with support, users posting in the wrong channel, users not posting issues in threads or threads not being tracked correctly (resolved/unresolved).

WeeSupport was created to resolve these issues and provide a clear and concise support process.

Features

• Makes use of modern Discord.js features such as (/) Commands, Modal Inputs & Threads.
• Minimal setup, select your support channels, moderator roles and away you go!
• Directs users (by DM) to support channels if command is used in a non-support channel.
• Automated process of ticket creation and resolution. Renaming, locking and archiving threads on resolution.
• Deletes any message in a support channel that is not a (/) command, and removes 'started a thread' message on resolution for easy open issue tracking. (Mod messages are exempt)

Screenshots

Below are demonstrations of WeeSupport functionality in action on Crafty Controller's Deployment:

Ticket Creation:

Resolved Ticket:

Config

Found in ./config/config.js

export default {
  token: '<Discord-token>',
  /*
    supportChannels: list of channels where tickets will be created.
    Each entry may include:
      - channelId: the Discord channel ID
      - selectOptionName: (optional) friendly label shown in the select menu
      - initialMessage: (optional) message posted to a new thread after creation

    settings.selectorAlways (boolean)
      - If true: the /support command will always show the select menu allowing users to pick
        the target support channel regardless of which channel they invoked the command from.
      - If false: (default/legacy) invoking /support inside a configured support channel will
        immediately open the ticket creation modal for that channel.
  */
  supportChannels: [
    {
      channelId: '<channelId>',
      selectOptionName: '<friendly menu label>',
      initialMessage: '<can be blank>',
    },
  ],
  moderatorRoles: ['<roleId>', '<roleId>', '<roleId>'],
  settings: {
    selectorAlways: true,
  },
};

Required permissions and intents

Scopes: application.commands,bot Bot Permissions integer: 2252197098286144 - Presence Intent - Message Content Intent

Deployment

• Start off by cloning down the repository applying your config with the above example. bash $ git clone git@gitlab.com:Zedifus/weesupport.git $ cd weesupport $ vim config/config.js

• Then deploy your (/) commands by copying your bot's client-id & your guild's guild-id into the designated variables on line 11 & 12 of exportCommands.js. Then run the following commands to deploy (/) commands and start bot! bash $ npm run cmdExport # To dispatch (/) commands $ npm start # To start bot

I have also included a docker-compose config. Just simply clone like above, configure and build

$ docker-compose up -d && docker-compose logs -f

Acknowledgements

• TomboFry - For the lightweight logger lib

Roadmap

• Make almost every string/emoji configurable in strings.js

• Ticket question neutrality / easily configurable form questions
  The support ticket form/modal is very Crafty Controller centric at the moment, to deploy for your own usage would require significant editing of supportHandler.js, my plan is to make it so that issue questions are easily configurable, like you would customise strings in the string.js config.

• Easier (/) command deployment Deployment of slash commands is trickier than i'd like because you need to edit variables in exportCommands.js, in the future I'll make this an option in config.js

Contributing

Contributions are always welcome!

I am always seeking to learn and improve, so if you have ideas, feel free to open a MR!

Credit / Donations

I don't want your money, or mind wither you rebrand my code in your projects if you happen to use it, if it's helped you or you have deployed it. All I ask is please just pop a wee star on this repository, and adhere to the below licence.

It'd mean the world to me 🥰

License

GPL-V3.0