irc-skill/README.md
merspieler 7a9a9f62e8 Updated README.md
Signed-off-by: merspieler <merspieler@users.noreply.github.com>
2018-03-16 10:40:00 +01:00

1.7 KiB

irc-skill

Basic IRC client

Description

Mycroft skill that lets you use IRC via voice commands.

This skill is still under active development.

Requirements

Examples

Normal use

Currently available commands

  • "connect to irc"
  • "join irc channel"
  • "send irc message"
  • "part from irc channel"
  • "disconnect from irc server"

Note settings are set in the settings.json file. Right now it's only possible to join one server and one channel at a time.

Configuration

Configuration via voice isn't supported yet

Supported configuration options in the settings.json file:

  • Server
    • server: The adress of the server.
    • port: The used port.
    • ssl: If SSL should be used (can be True or False)
    • server-password: The password for the server. Note This is only needed for password protected servers. For user password, see below.
  • Proxy
    • proxy: The proxy adress. If empty, no proxy is used.
    • proxy-port: The port of the proxy.
    • proxy-user: The user to authentificate with. Only needed if athentification is required for the proxy.
    • proxy-passwd: The password to authentificate with.
  • User
    • user: The username.
    • password: Password to use when the username is registered.
  • Channel
    • channel: The channel to join.
    • channel-password: The channel password if required. Note This feature isn't implemented yet.

Use this only for debuging purpose on the console

  • "Enable irc debug" Enables debug mode. This will print useful information for debugging and ever message recived. This includes messages like the PING message.
  • "Disable irc debug" Disables debug mode and goes back to normal output.

Credits