前端技术文章：npm 包 nodebb-plugin-knuddels 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

NodeBB 是一个开源的论坛平台，可用于构建社区和讨论板块。其中，knuddels 是一个 NodeBB 插件，用于添加 Knuddels 在线聊天室的集成。通过安装并配置此插件，您可以在您的 NodeBB 论坛中添加一个实时的在线聊天室，以方便和您的用户之间的沟通和交流。

安装步骤

安装 NodeBB：在您的服务器上安装 NodeBB 并进行设置、配置。
安装 NodeBB 插件：使用 NodeBB 的自带 ACP 界面或者使用 npm 安装 nodebb-plugin-knuddels 插件。
连接 Knuddels 账号：使用 NodeBB 插件的配置选项连接您的 Knuddels 账号，在 Knuddels 账号设置中生成相关的 API key 并经过授权即可使用。

配置选项

Knuddels Account ID: 您所要连接的 Knuddels 账号 ID。
Knuddels API Key: 您所要使用的 Knuddels API 密钥，需要在 Knuddels 账号设置中对应生成。
主界面: 在论坛首页上显示聊天室。
顶部悬浮: 让聊天室视图占用整个空间并显示为所有页面的顶部悬浮条。
侧边栏: 在侧边栏位置添加聊天室。

API 接口

使用 nodebb-plugin-knuddels 之后，您可以使用以下 API 接口与 Knuddels 进行交互：

在服务器端将消息发送到房间

socket.emit('plugins.knuddels.sendRoomMessage', {
    room: 'your_room_id',
    message: 'Your message here',
});

在用户进入房间时向其发送欢迎消息

socket.on('plugins.knuddels.joinRoom', function (data) {
    socket.emit('plugins.knuddels.sendRoomMessage', {
        room: data.room,
        message: 'Welcome ' + data.username + '!',
    });
});

当用户离开房间时向房间发送信息

socket.on('plugins.knuddels.leaveRoom', function (data) {
    socket.emit('plugins.knuddels.sendRoomMessage', {
        room: data.room,
        message: data.username + ' has left the room.',
    });
});

常见问题

如何创建一个 Knuddels 账号？

可以在 Knuddels 的官方网站上注册一个新账号，按照流程填写相关信息并创建即可。

想要查看更详细的 API 接口，应该怎么做？

您可以前往 node_modules/nodebb-plugin-knuddels/public/js/knuddels.js 文件来查看 Knuddels API 的完整代码和使用方法。

聊天室的样式和位置能否自定义？

通过修改 knuddels.css 文件，可以方便地自定义聊天室的样式和位置。

结束语

在本文中，我们介绍了一个非常实用的 NodeBB 插件 nodebb-plugin-knuddels，它可用于向您的 NodeBB 论坛添加一个实时的在线聊天室。我们了解了该插件的安装和配置步骤，并介绍了一些与 Knuddels API 交互的常见用法。如果您有任何疑问或者需要进一步详细的信息，欢迎留言讨论!

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005587e81e8991b448d5c15