在前端开发中，我们经常会使用一些开源的工具和库来提高我们的开发效率和代码质量，npm 包就是其中之一。本篇文章将介绍一个使用 npm 包 nodebb-widget-teamspeak-vrk 的教程，它能够在 NodeBB 社区中展示 Teamspeak 服务器的在线用户。
什么是 npm 包
npm 是 Node.js 包管理器，它允许开发者在自己的项目中使用各种各样的库和工具，这些库和工具被打包成了 npm 包，并且都托管在 npm registry 中。使用 npm 包可以快速地完成各种开发任务，例如在项目中引入 jQuery、Bootstrap 等常用的库，或者引入特定功能的模块。
什么是 NodeBB
NodeBB 是一个开源的 Node.js 论坛软件，可以快速地建立一个社区网站，其扩展性非常好，可以通过插件实现各种功能。在社区中展示在线用户是一个比较常见的需求，Teamspeak 是一款游戏语音聊天软件，很多游戏社区都会使用它，那么如何在 NodeBB 社区中显示 Teamspeak 服务器的在线用户呢？使用 npm 包 nodebb-widget-teamspeak-vrk 就可以快速实现。
nodebb-widget-teamspeak-vrk 使用教程
1. 安装 npm 包
在使用 nodebb-widget-teamspeak-vrk 之前，需要先在项目中安装该 npm 包。在命令行中进入项目的根目录，运行以下命令：
npm install nodebb-widget-teamspeak-vrk
2. 配置 Teamspeak 服务器信息
在使用 nodebb-widget-teamspeak-vrk 之前，需要先配置 Teamspeak 服务器的信息。在 NodeBB 社区的后台管理页面中，选择 Plugins -> VRK Teamspeak，填写 Teamspeak 服务器的地址、Query 端口、查询间隔和服务器分组信息。其中查询间隔是指每隔多长时间查询一次在线用户，默认值为 10 秒。
3. 添加浮动窗口
在添加浮动窗口之前，需要先确认 NodeBB 社区的版本是否支持使用浮动窗口。在 NodeBB 的后台管理页面中，选择 Extend -> Widgets，查看是否有 “Global Sidebar” 选项。如果没有，需要在代码中添加浮动窗口的支持，具体方法可以参考 NodeBB 的官方文档。
在添加浮动窗口之后，在 “Global Sidebar” 区域中添加 VRK Teamspeak Widget 即可。
示例代码
安装
npm install nodebb-widget-teamspeak-vrk
配置
在 NodeBB 的后台管理页面中，选择 Plugins -> VRK Teamspeak，填写 Teamspeak 服务器的地址、Query 端口、查询间隔和服务器分组信息。
添加浮动窗口
在 “Global Sidebar” 区域中添加 VRK Teamspeak Widget 即可。
总结
使用 npm 包 nodebb-widget-teamspeak-vrk 可以帮助我们快速实现在 NodeBB 社区中展示 Teamspeak 服务器的在线用户的功能。在使用时需要注意配置 Teamspeak 服务器的信息，并添加浮动窗口。希望这篇文章对你有所帮助，谢谢！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055e7b81e8991b448dbd69