From bb2d4e6307317b5e593344676ad04b39ef07c542 Mon Sep 17 00:00:00 2001 From: Edward Jones Date: Mon, 14 Aug 2017 18:22:43 +0100 Subject: [PATCH] Add a note about how to install optional charset converter dependencies Fixes part of #252 and #237. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d95835a4..df697e96 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ import config from './config.json'; discordIRC(config); ``` +When installing the library, you may encounter an error relating to the installation of `iconv` or `node-icu-charset-detector`. +These are optional dependencies which allow you to set the target encoding of messages sent to Discord, as detailed below in the README. +Without these dependencies and the relevant setting, messages that aren't sent in UTF-8 may be corrupted when copied to Discord. + ## Configuration First you need to create a Discord bot user, which you can do by following the instructions [here](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token). @@ -94,6 +98,12 @@ The `ircOptions` object is passed directly to irc-upd ([available options](https To retrieve a discord channel ID, write `\#channel` on the relevant server – it should produce something of the form `<#1234567890>`, which you can then use in the `channelMapping` config. +### Encodings + +If you encounter trouble with some characters being corrupted from some clients (particularly umlauted characters, such as `ä` or `ö`), try installing the optional dependencies `iconv` and `node-icu-charset-detector`, then adding `"encoding": "utf-8"` to your `ircOptions` object. + +Further information can be found in [the installation section of irc-upd](https://github.com/Throne3d/node-irc#character-set-detection). + ## Tests Run the tests with: ```bash