ioBroker.discord

Tests:

Discord adapter for ioBroker

ioBroker Discord bot integration

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

Documentation

A detailed documentation is available in the docs directory of the repository:

• English documentation
• Deutsche Dokumentation

Requirements

• Node.js >= 18
• js-controller >= 4.0
• admin >= 5.3

Features

• ioBroker states for all servers of the bot to receive and send messages
• ioBroker states for all users seen by the bot to receive and send direct messages
• Simplified Discord server join and leave for the bot
• Set the bot status including actions
• Optional observe user presence status
• Optional observe server member voice status
• Server member voice actions (mute, deafen, disconnect)
• Handle all messages or only messages with bot mentions on server channels
• Handle direct messages
• Optional automatic react with a emoji on mentions
• .json states for channel, user and message data
• Send messages, files, reactions (emojis), reply messages, or custom json-formated message contents
• List server and channel members including member roles
• Support for Discord slash commands to get and set state values
• Support for user defined Discord slash commands to be handled by custom scripts
• Support for text2command (has to be enabled for each .message state where it should be used)
• Send, edit and delete messages, add and await message reactions using Scripts
• Optional raw states to allow more flexibility in custom scripts
• Support for Blockly with custom blocks to send and edit messages and to handle custom slash commands
• Basic support for interactions unknown to the adapter (custom Javascript required to handle them)

Changelog

2.4.0 (2024-07-10)

• (crycode-de) Added basic support for interactions unknown to the adapter (custom scripts required for handling)
• (crycode-de) Raw interaction JSON is now written to the state after the interaction is initially handled to prevent some race conditions
• (crycode-de) Updated dependencies

2.3.1 (2024-06-29)

• (crycode-de) Fixed Blockly for the latest JavaScript adapter changes
• (crycode-de) Updated dependencies

2.3.0 (2024-05-14)

• (crycode-de) 💥 Node.js 18+ is now required!
• (crycode-de) Added support for custom bot activities
• (crycode-de) Fixed Issue with embed colors not accepting hex color codes
• (crycode-de) Fixed user activities for users with custom activities (see #60)
• (crycode-de) Updated dependencies

2.2.1 (2024-04-13)

• (crycode-de) Fixed blockly target detection if user is provided by a variable (You may need to move a block to update the generated code)
• (crycode-de) Updated dependencies

2.2.0 (2023-11-07)

• (crycode-de) Optimized error handling - Network related errors should now be handled completely without adapter restarts and better logging
• (crycode-de) Fixed small issues in config UI
• (crycode-de) Updated dependencies

2.1.2 (2023-09-04)

• (crycode-de) Fixed response to notification-manager adapter

2.1.1 (2023-08-27)

• (crycode-de) Updated dependencies
• Updated translations

2.1.0 (2023-07-12)

• (crycode-de) Added support for unique user names
• (crycode-de) Detect possible DNS errors during login to prevent restart loops
• (crycode-de) Better handling for login errors, first 4 errors are now logged just as info

2.0.0 (2023-06-11)

• (crycode-de) Updated discord.js to v14
• (crycode-de) 💥 Breaking: Activity types and channel types are now in title case. Example: PLAYING is now Playing, GUILD_TEXT is now GuildText.
• (crycode-de) 💥 Breaking: In raw states all type field values are now numbers representing the internal enum values of the types.
• (crycode-de) Add support for messages from the notification-manager adapter
• (crycode-de) Updated dependencies
• (crycode-de) Added Ukrainian translations
• Updated translations

1.1.6 (2022-07-28)

• (crycode-de) Fixed voice channel member count/list

1.1.5 (2022-07-27)

• (crycode-de) Made token validation less strict

1.1.4 (2022-07-14)

• (crycode-de) Fixed crash if custom command choices name was empty

1.1.3 (2022-07-01)

• (crycode-de) Dependency updates

1.1.2 (2022-06-23)

• (crycode-de) Fixed adapter termination on discord errors to let the js-controller restart the adapter

1.1.1 (2022-06-08)

• (crycode-de) Added support for text messages in voice channels
• (crycode-de) Added support for custom slash commands
• (crycode-de) Added Blockly support with special custom blocks
• (crycode-de) Send error replies on slash commands as ephemeral
• (crycode-de) Added config option to send all slash command replies as ephemeral
• (crycode-de) Register get/set commands only if states are configured for this
• (crycode-de) Choices for commands are now handled as autocomplete which allows more choices, is more dynamic and shows the choices only to authorized users
• (crycode-de) Added command options to raw.interactionJson json content
• (crycode-de) Fixed command name checks
• (crycode-de) Fixed some crashes / stuck conditions when network is not available
• (crycode-de) Fixed several small bugs

1.0.2 (2022-05-16)

• (crycode-de) Fixed some small issues found on adapter review

1.0.1 (2022-05-15)

• (crycode-de) Added possibility to let the bot leave a Discord server
• (crycode-de) Fixed crash on server updates

1.0.0 (2022-05-13)

• (crycode-de) First release

License

MIT License

Copyright (c) 2022-2024 Peter Müller peter@crycode.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.