getting started
1.0.0
Wechaty は、チャットボット メーカー向けの会話型 RPA(ロボティック プロセス オートメーション) SDK(ソフトウェア開発キット)です。使いやすい API を備えてうまく設計されています。 Linux、OSX、Win32、Docker を含むすべてのオペレーティング システムと、WeChat、WeCom、Whatsapp、Lark、Gitter などの多くの IM (インスタント メッセージング サービス) をサポートします。
開発者は、Wechaty を使用してボットを簡単に構築し、メッセージの送受信、ルームの作成と招待状の送信を効果的に管理し、友人に連絡し、ユーザーとボットの間に人工知能を楽しく追加することができます。
あなたが Wechaty のまったくの初心者である場合、このプロジェクトは最適な出発点です。いくつかの手順でクラウド IDE 上で実行することも、以下のセクションで説明するようにマシン上のローカル セットアップ上で実行することもできます。
問題が発生したり、質問がある場合は、Discord コミュニティ (https://discord.gg/7q8NBZbQzt) でお問い合わせください。
注意: Wechaty の現在アクティブなバージョンは v1.x であり、ほとんどの v0.x モジュールと互換性がありません。
[email protected] - Wechaty v0.x を使用するには、Wechaty Getting Started v0.x ブランチにアクセスしてください。dingメッセージを受信すると、 dongメッセージで応答します。
上記は、WeChat、WhatsApp、および WeCom を使用した ding-dong-bot の導入の簡単な実行手順です。
Wechaty を使い始める最も早い方法は、クラウド ベースの IDE を使用して Wechaty Getting Started プロジェクトを実行することです。 Gitpod または Google Cloud Shell を使用できます。
まったくの初心者の場合は、Gitpod をお勧めします。
Gitpod は、自動化され、すぐにコードを作成できる開発環境のためのオンラインのオープンソース プラットフォームです。下のボタンをクリックすると、gitpod 上の Wechaty Getting Started ding-dong BOT プロジェクトの完全なセットアップにアクセスできます。これまでに gitpod を使用したことがない場合は、gitHub アカウントを使用してログインする必要があります。
Gitpod ❤️ Wechaty について詳しくは、私たちのブログからご覧いただけます: ブラウザを離れることなく始めましょう: Wechaty ❤️ Gitpod、@huan、2021 年 2 月 6 日
Google Cloud Shell は、ブラウザを使用してどこからでもアクセスできるオンラインの開発および運用環境です。下のボタンをクリックすると、Google Cloud Shell でこのプロジェクトを実行できます。
open-in-cloud-shell 経由で生成
Google Cloud Shell エディターを開くと、右側のパネルにチュートリアルが表示され、Wechaty について詳しく学ぶことができます。
Google Cloud Shell でこのプロジェクトを実行する方法の詳細については、Google Cloud Shell のブログ「Wechaty 用 Google Cloud Shell チュートリアル」、@huan、2021 年 2 月 20 日をご覧ください。
このプロジェクトをローカル マシンで実行するには、次のことを行う必要があります。
マシンに Node.js v16 以降がインストールされていること。ターミナルでコマンドnode -v実行すると、 Node.jsインストールされているかどうかを確認できます。それをお持ちの場合は、 v16.13.0のように、ターミナルにバージョンが表示されるはずです。ご使用のバージョンはv16.13.0とは異なる可能性があります。インストールされていない場合、またはバージョンが 16 未満の場合は、以下のリンクに従って最新バージョンをインストールする必要があります。
他のプラットフォーム用の Node.js は、https://nodejs.org/en/download/package-manager/ で見つけることができます。
Web 以外の RPA プロトコルを使用する場合は、Wechaty Puppet Service TOKEN が必要です
このリポジトリのクローンをローカル マシンに作成し、以下のコマンドを実行してwechaty-getting-startedディレクトリに切り替える必要があります。
git clone https://github.com/wechaty/getting-started.git
cd getting-started以下のコマンドを実行して依存関係をインストールする必要があります。
npm installLinux ではexport使用して環境変数を設定し、Windows ではsetを使用できます。このコマンドの実行中にエラーが発生した場合は、手順 4 のトラブルシューティングのヒントを確認してください。
export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts set WECHATY_LOG=verbose
set WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts準備は完了です!
上記の手順を実行中に問題が発生した場合は、以下のオプションを試してください。 gitter チャットルームで質問することもできます。
Windows を使用している場合は、windows-build-tool も必要になる場合があります。
npm install windows-build-tools入門例では、 WECHATY_PUPPETが設定されていない場合、ding-dong BOT は wechaty-puppet-wechat4u を使用しますが、これは初心者の便宜のためです。
デフォルトでは、Wechaty はボットへのログインに Puppet サービスを使用します。 Whatsapp Web プロトコル (wechaty-puppet-whatsapp) などの他の Puppet プロバイダーを使用できます。
別のプロトコルに Wechaty Puppet プロバイダーを使用する場合は、 WECHATY_PUPPET環境変数を設定して、Puppet サービス プロバイダー名 (NPM 名と同じ) を指定する必要があります。
私たちのコミュニティからの多大な貢献のおかげで、Wechaty で使用できる Wechaty Puppet が数多くあります。彼らは、Web、Pad、Mac、Windows などのプロトコルを使用するのに役立ちました。
| プロトコル | 故宮 |
|---|---|
| パペットサービス | wechaty-puppet-service |
| Whatsapp ウェブ | wechaty-puppet-whatsapp |
| WeChatウェブ | wechaty-puppet-wechat |
| WeChatパッド | wechaty-puppet-padlocal |
Wechaty Puppet サービス プロバイダーの詳細については、当社の Web サイトにアクセスしてください。
たとえば、 padlocal Puppet を使用する場合は、 npm start実行する前にWECHATY_PUPPET=wechaty-puppet-padlocal設定する必要があります。 wechaty-puppet-padlocalの TOKEN も必要であり、 WECHATY_PUPPET_PADLOCAL_TOKEN環境変数に設定する必要があります。 PadLocal TOKENはこちらからお申込みいただけます。以下のコード スニペットは、Linux/MacOS および Windows で上で説明した内容を示しています。
export WECHATY_PUPPET=wechaty-puppet-padlocal
export WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start set WECHATY_PUPPET=wechaty-puppet-padlocal
set WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm startWindows への Wechaty のインストールについて詳しくは、このブログ投稿をご覧ください。
上記は 10 分間のビデオチュートリアルです。 Wechaty のバージョン 0.14 またはそれ以前のバージョンを使用しているため、これも古いです。 Wechaty を初めて使用する場合は、これを始めるのに適した方法です。
注: さらにサンプルを試す前に、このリポジトリにある wechaty 入門プロジェクトを必ず試してください。
https://github.com/wechaty/docker-wechaty-getting-started
https://github.com/wechaty/heroku-wechaty-getting-started
https://wechaty.github.io
2017 年以降に登録された WeChat アカウントは、Web API 経由でログインできなくなります。詳細については、wechaty/wechaty#872 をご覧ください。
解決策: Web API 以外の Wechaty サポート プロトコル (pad など) を使用できます。詳細については、wechaty/wechaty#1296 をご覧ください。
Puppetとは何ですかWechaty の Puppet という用語は、プロトコル プラグインを実装するための抽象クラスです。プラグインは、Wechaty が Wechat を制御するのに役立つコンポーネントであり、それがパペットと呼ばれる理由です。
プラグインの名前はPuppetXXXです。たとえば、PuppetWeChat は Google puppeteer を使用して Chrome ブラウザ経由で WeChat Web API を制御し、PuppetPadchat は WebSocket プロトコルを使用してプロトコル サーバーに接続し、iPad Wechat プログラムを制御します。詳細については、wiki の Puppet を参照してください。
Wechaty Puppet の詳細については、Wechaty Puppet のドキュメントをご覧ください。
CQRS Wechaty の例を追加します。
ブランチ: v1.11: Wechaty の v1.11 をリリースします。
Google Cloud Shell を使用して簡単にセットアップしましょう。
Gitpod を使って簡単にセットアップしましょう!
初期バージョン
@wechaty/貢献者
