Wechaty Puppet Gitter

Gitter is an open-source instant messaging and chat room system for developers and users of GitLab and GitHub repositories.
‐ WikiPedia

Wechaty Puppet for Gitter: https://gitter.im

Feature

1. Receive and send text messages in Gitter.im rooms.

USAGE

The wechaty-puppet-gitter needs a TOKEN and only one token from gitter so that it can connect to the gitter.im service.

Learn more about the TOKEN from gitter.im at https://developer.gitter.im/apps

You can pass the token to this puppet by putting it into options, or by setting the environment variable WECHATY_PUPPET_GITTER_TOKEN.

Puppet Gitter

import { Wechaty }   from 'wechaty'
import { PuppetGitter } from 'wechaty-puppet-gitter'

/**
 * Personal Access Token: this token can be used to access the Gitter API.
 *  https://developer.gitter.im/apps
 */
const puppet  = new PuppetGitter({ token: 'your_gitter_token' })
const wechaty = new Wechaty({ puppet })

await wechaty.start()

Environment Variable: WECHATY_PUPPET_GITTER_TOKEN

The wechaty-puppet-gitter will search the environment variable named WECHATY_PUPPET_GITTER_TOKEN to get the token if you do not set it in the options.

Resources

1. Gitter.im Developer Documents

GitHub Projects

1. IRC ⚡ Gitter, https://irc.gitter.im
2. Bot that synchronises messages from gitter and irc
3. Add a Integration feature for IRC (two-way sync between gitter room and a designated IRC channel)
4. Slack API: Enabling interactions with bots
5. Matrix <-> Gitter bridge

HISTORY

master v1.0 Release

Release v1.0

1. v0.7 (Oct 2021): Upgrade to Puppet v0.51 API
2. v0.5 (Sep 2021): ES Modules support

v0.4 (Aug 27, 2020)

1. Support send/receive image (#2)

v0.2 (Aug 21, 2020)

Initial version.

PuppetGitter is a Gitter Puppet for https://gitter.im

AUTHOR

Huan LI <zixia@zixia.net>

COPYRIGHT & LICENSE

• Code & Docs © 2020-now Huan LI <zixia@zixia.net>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons