Needle 是一个Discord 机器人,它通过自动创建 Discord 线程来帮助您整理服务器。
在服务器中开始使用 Needle 的最简单方法是使用托管实例。单击此处邀请 Needle 加入您的 Discord 服务器!如果您有任何疑问,请随时加入支持服务器并查看常见问题。
Needle 的托管实例是可定制的,对于大多数用户来说应该足够了。但是,如果您有特殊要求并想要修改 Needle 的功能,则必须分叉存储库并自行托管您自己的实例。这需要编程知识,并且仅适用于高级用户 - 对此的支持将是有限的。
Needle 需要 Node.js 版本16.9.0
或更高版本的环境,以及每个服务器配置文件的持久存储 - 共享主机(如 Replit 和 Heroku)将无法工作。
克隆或下载最新版本的 Needle (分支: stable
)。
将.env.example
复制到.env
并填写机器人的令牌和应用程序 ID。
运行npm install
以安装 Needle 的依赖项。
运行npm run build
来编译 Needle 的代码。
运行npm run deploy
来设置斜杠命令。
斜杠命令最多可能需要一小时才能在所有服务器中显示。
运行npm start
来启动 Needle ?
Needle 需要以下权限才能运行,以及applications.commands
和bot
范围。
查看频道
发送消息
在线程中发送消息
创建公共线程
读取消息历史记录
您可以使用此链接邀请您的自托管版本的 Needle,并将<APP ID>
替换为您的机器人的应用程序 ID:
https://discord.com/oauth2/authorize?client_id=<APP ID>&permissions=309237713920&scope=bot%20applications.commands
Needle 有一个官方 Docker 镜像。版本按次要版本和补丁版本标记(例如2.0.0
和2.0
),最新版本标记为latest
。分支按其名称进行标记。要运行该映像,请编写以下命令,并将token
替换为您的机器人的令牌:
docker run -d --name Needle --env DISCORD_API_TOKEN=令牌不和谐针 ghcr.io/MarcusOtter/discord-needle:latest
默认情况下,这将为/configs
创建一个匿名卷。要更改位置,请将-v /path/to/configs:/configs
添加到命令中。
还有一个示例docker-compose.yml
文件。
您仍然需要部署 Needle 的斜杠命令 - 除了步骤 6 之外,请遵循常规自托管说明。
贡献指南即将推出™️
如果有兴趣,请加入 Discord!
如果您想以其他方式支持 Needle,请考虑赞助 Needle 的开发。
您还可以在 top.gg 上投票并评论该机器人。
该程序是免费软件:您可以根据自由软件基金会发布的 GNU Affero 通用公共许可证(许可证的第 3 版)或(由您选择)任何更高版本的条款重新分发和/或修改它。
分发此程序的目的是希望它有用,但不提供任何保证;甚至没有适销性或特定用途适用性的默示保证。有关更多详细信息,请参阅 GNU Affero 通用公共许可证。
您应该随该程序一起收到 GNU Affero 通用公共许可证的副本。如果没有,请参阅 https://www.gnu.org/licenses/。