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
実行してスラッシュ コマンドをセットアップします。
スラッシュ コマンドがすべてのサーバーに表示されるまでに最大 1 時間かかる場合があります。
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=トークン discord-needle ghcr.io/MarcusOtter/discord-needle:latest
デフォルトでは、これにより/configs
の匿名ボリュームが作成されます。場所を変更するには、コマンドに-v /path/to/configs:/configs
を追加します。
docker-compose.yml
ファイルの例もあります。
Needle のスラッシュ コマンドをデプロイする必要があります。ステップ 6 とは別に、通常のセルフホスティング手順に従ってください。
貢献ガイドラインは近日公開予定です ™️
興味があればDiscordに参加してください!
他の方法で Needle をサポートしたい場合は、Needle の開発のスポンサーになることを検討してください。
また、top.gg でボットに投票してレビューすることもできます。
このプログラムはフリー ソフトウェアです。Free Software Foundation によって公開されている GNU Affero General Public License の条件 (ライセンスのバージョン 3、または (任意で) 以降のバージョン) に基づいて再配布したり、変更したりすることができます。
このプログラムは役立つことを期待して配布されていますが、いかなる保証もありません。商品性や特定目的への適合性についての暗黙の保証もありません。詳細については、GNU Affero 一般公衆利用許諾書を参照してください。
このプログラムと一緒に、GNU Affero General Public License のコピーも受け取っているはずです。そうでない場合は、https://www.gnu.org/licenses/ を参照してください。