Update README.md
Conversion to md broke some things. Trying to make it more readable.
This commit is contained in:
parent
7bf6a5e2bd
commit
48e96efb86
209
README.md
209
README.md
|
@ -20,18 +20,21 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Build dependencies
|
Build dependencies
|
||||||
------------------
|
------------------
|
||||||
- bitlbee and headers >= 3.5
|
#### bitlbee and headers >= 3.5
|
||||||
If using distribution version of bitlbee you will need to install the dev
|
|
||||||
package, usually bitlbee-dev or bitlbee-devel. If bitlbee was built from
|
|
||||||
source don't forget to do `make install-dev`.
|
|
||||||
|
|
||||||
- glib2 and headers => 2.32
|
If using distribution version of bitlbee you will need to install the dev
|
||||||
The library itself is usually installed as a dependency of bitlbee, headers
|
package, usually bitlbee-dev or bitlbee-devel. If bitlbee was built from
|
||||||
need to be installed separately. In Debian, the package containing them is
|
source don't forget to do `make install-dev`.
|
||||||
libglib2.0-dev.
|
|
||||||
|
|
||||||
- autotools (if building from git)
|
#### glib2 and headers => 2.32
|
||||||
A bit of an overkill, but autotools is the build system of choice now, sorry.
|
|
||||||
|
The library itself is usually installed as a dependency of bitlbee, headers
|
||||||
|
need to be installed separately. In Debian, the package containing them is
|
||||||
|
libglib2.0-dev.
|
||||||
|
|
||||||
|
#### autotools (if building from git)
|
||||||
|
|
||||||
|
A bit of an overkill, but autotools is the build system of choice now, sorry.
|
||||||
|
|
||||||
|
|
||||||
Building and Installing
|
Building and Installing
|
||||||
|
@ -48,7 +51,7 @@ After that (or when building from a tarball) you can build as usual:
|
||||||
$ sudo make install
|
$ sudo make install
|
||||||
|
|
||||||
If your bitlbee's plugindir is in non-standard location you can specify it by
|
If your bitlbee's plugindir is in non-standard location you can specify it by
|
||||||
calling ./configure with --with-plugindir=/path/to/plugindir option.
|
calling `./configure` with `--with-plugindir=/path/to/plugindir` option.
|
||||||
|
|
||||||
You can also use the dockerfile from contrib/docker to build a docker container
|
You can also use the dockerfile from contrib/docker to build a docker container
|
||||||
containing bitlbee + bitlbee-discord. Use this command to run the container:
|
containing bitlbee + bitlbee-discord. Use this command to run the container:
|
||||||
|
@ -59,15 +62,15 @@ Usage
|
||||||
-----
|
-----
|
||||||
Plugin adds 'discord' protocol to bitlbee, add your account as usual:
|
Plugin adds 'discord' protocol to bitlbee, add your account as usual:
|
||||||
|
|
||||||
> account add discord <email> <password>
|
> account add discord <email> <password>
|
||||||
> account discord on
|
> account discord on
|
||||||
|
|
||||||
On your first login you might need to authorize bitlbee's ip address
|
On your first login you might need to authorize bitlbee's ip address
|
||||||
(discord will send you an email with a link) or get a captcha-request. In
|
(discord will send you an email with a link) or get a captcha-request. In
|
||||||
latter case you will have to manually set discord login-token to log in:
|
latter case you will have to manually set discord login-token to log in:
|
||||||
|
|
||||||
> account discord off
|
> account discord off
|
||||||
> acc discord set token_cache xxxxxxxx
|
> acc discord set token_cache xxxxxxxx
|
||||||
|
|
||||||
To get your token you'll have to login with your browser and locate it in
|
To get your token you'll have to login with your browser and locate it in
|
||||||
"local storage"
|
"local storage"
|
||||||
|
@ -81,14 +84,15 @@ https://github.com/sm00th/bitlbee-discord/issues/118
|
||||||
You also need to configure discord channels you would like to join/autojoin. To
|
You also need to configure discord channels you would like to join/autojoin. To
|
||||||
do that use bitlbee's 'chat list' functionality (`help chat list` and `help
|
do that use bitlbee's 'chat list' functionality (`help chat list` and `help
|
||||||
chat add`):
|
chat add`):
|
||||||
> chat list discord
|
|
||||||
|
> chat list discord
|
||||||
|
|
||||||
This will show you the list of available channel with indexes that can be used
|
This will show you the list of available channel with indexes that can be used
|
||||||
for adding channels.
|
for adding channels.
|
||||||
|
|
||||||
> chat add discord !1 #mydiscordchannel
|
> chat add discord !1 #mydiscordchannel
|
||||||
> chan #mydiscordchannel set auto_join true
|
> chan #mydiscordchannel set auto_join true
|
||||||
> /join #mydiscordchannel
|
> /join #mydiscordchannel
|
||||||
|
|
||||||
If you set auto_join to true, next time you reconnect there will be no need to
|
If you set auto_join to true, next time you reconnect there will be no need to
|
||||||
join the channel manually.
|
join the channel manually.
|
||||||
|
@ -98,95 +102,114 @@ Options
|
||||||
This section describes options available through "account set" bitlbee command
|
This section describes options available through "account set" bitlbee command
|
||||||
(for help on usage of this command see "help account set").
|
(for help on usage of this command see "help account set").
|
||||||
|
|
||||||
- host (type: string; default: "discordapp.com")
|
#### host (type: string; default: "discordapp.com")
|
||||||
Discord server hostname. Just in case discord changes the hostname or there
|
|
||||||
are some alternatives with compatible API.
|
Discord server hostname. Just in case discord changes the hostname or there
|
||||||
|
are some alternatives with compatible API.
|
||||||
|
|
||||||
- voice_status_notify (type: boolean; default: no)
|
#### voice_status_notify (type: boolean; default: no)
|
||||||
This enables text notifications in your control channel about users
|
|
||||||
changing/leaving voice channels. Can be noisy on big servers.
|
|
||||||
|
|
||||||
- edit_prefix (type: string; default: "EDIT: ")
|
This enables text notifications in your control channel about users
|
||||||
A string that will be prefixed to an edited message to distinguish those
|
changing/leaving voice channels. Can be noisy on big servers.
|
||||||
from normal ones.
|
|
||||||
|
|
||||||
- urlinfo_handle (type: string; default: "urlinfo")
|
#### edit_prefix (type: string; default: "EDIT: ")
|
||||||
User handle that will be used to post url expansion info such as title and
|
|
||||||
description in groupchats.
|
A string that will be prefixed to an edited message to distinguish those
|
||||||
|
from normal ones.
|
||||||
|
|
||||||
- max_backlog (type: integer; default: 50)
|
#### urlinfo_handle (type: string; default: "urlinfo")
|
||||||
Maximum number of backlog messages per channel to fetch on connection.
|
|
||||||
Unlike twitter implementation in bitlbee this won't dump seen messages.
|
|
||||||
Setting this to 0 or negative values disables backlog fetching.
|
|
||||||
|
|
||||||
- send_acks (type: boolean; default: yes)
|
User handle that will be used to post url expansion info such as title and
|
||||||
By default bitlbee-discord will send an "ack" for every message received,
|
description in groupchats.
|
||||||
thus marking everything as "read" on mobile/webapp. Setting this to false
|
|
||||||
will disable all acks from bitlbee-discord.
|
|
||||||
|
|
||||||
- mention_suffix (type: string; default: ":")
|
#### max_backlog (type: integer; default: 50)
|
||||||
Suffix used in a regex to look for username mentions to automatically
|
|
||||||
convert your usual irc-style "nick:" mentions to discord's "<@id>" format.
|
|
||||||
So if you type "nick: hello" in bitlbee, it will be displayed as
|
|
||||||
"@nick hello" in discord. This can be multicharacter and you can even do OR
|
|
||||||
logic here because it is actually used as a part of glib regex. That is
|
|
||||||
setting this to "[:,]" will match both "nick:" and "nick,". But beware
|
|
||||||
overcomplicating this may lead to bitlbee-discord spending a lot of time
|
|
||||||
parsing your outgoing messages. Setting this to "" will disable this
|
|
||||||
function.
|
|
||||||
|
|
||||||
- mention_ignorecase (type: boolean; default: off)
|
Maximum number of backlog messages per channel to fetch on connection.
|
||||||
Ignore case when looking for outgoing mentions. This also affects channel
|
Unlike twitter implementation in bitlbee this won't dump seen messages.
|
||||||
mentions.
|
Setting this to 0 or negative values disables backlog fetching.
|
||||||
|
|
||||||
- incoming_me_translation (type: boolean; default: on)
|
#### send_acks (type: boolean; default: yes)
|
||||||
This option controls whether bitlbee-discord will translate incoming
|
|
||||||
messages that are fully italicized (that is enclosed in '*' characters) to
|
|
||||||
'/me' messages.
|
|
||||||
|
|
||||||
- never_offline (type: boolean; default: off)
|
By default bitlbee-discord will send an "ack" for every message received,
|
||||||
Contacts from this account will never appear as offline and will be marked
|
thus marking everything as "read" on mobile/webapp. Setting this to false
|
||||||
away instead.
|
will disable all acks from bitlbee-discord.
|
||||||
|
|
||||||
- server_prefix_len (type: int; default: 3)
|
#### mention_suffix (type: string; default: ":")
|
||||||
Prefix channel names with this many characters of server name. If set to 0
|
|
||||||
nothing will be prefixed. If set to anything lower than 0 - full server
|
Suffix used in a regex to look for username mentions to automatically
|
||||||
name will be prefixed. Assuming we have a channel "general" on "beecord"
|
convert your usual irc-style "nick:" mentions to discord's "<@id>" format.
|
||||||
server here is what channel name you are going to get with different
|
So if you type "nick: hello" in bitlbee, it will be displayed as
|
||||||
settings:
|
"@nick hello" in discord. This can be multicharacter and you can even do OR
|
||||||
-1 - #beecord.general
|
logic here because it is actually used as a part of glib regex. That is
|
||||||
0 - #general
|
setting this to "[:,]" will match both "nick:" and "nick,". But beware
|
||||||
3 - #bee.general
|
overcomplicating this may lead to bitlbee-discord spending a lot of time
|
||||||
|
parsing your outgoing messages. Setting this to "" will disable this
|
||||||
|
function.
|
||||||
|
|
||||||
- fetch_pinned (type: boolean; default: off)
|
#### mention_ignorecase (type: boolean; default: off)
|
||||||
Fetch pinned messages on channel join.
|
|
||||||
|
Ignore case when looking for outgoing mentions. This also affects channel
|
||||||
|
mentions.
|
||||||
|
|
||||||
- friendship_mode (type: boolean; default: on)
|
#### incoming_me_translation (type: boolean; default: on)
|
||||||
With this option enabled, online/offline status is determined by the
|
|
||||||
friendship relationship with a user in addition to their actual away
|
|
||||||
status, and other users are added to channels.
|
|
||||||
|
|
||||||
- always_afk (type: boolean; default: off)
|
This option controls whether bitlbee-discord will translate incoming
|
||||||
When enabled bitlbee-discord would always report client's status as afk.
|
messages that are fully italicized (that is enclosed in '*' characters) to
|
||||||
This feature is not properly documented in official docs, but it presumably
|
'/me' messages.
|
||||||
can force push notifications to other clients when bitlbee is connected.
|
|
||||||
|
|
||||||
- emoji_urls (type: boolean; default: on)
|
#### never_offline (type: boolean; default: off)
|
||||||
Controls whether bitlbee-discord would display an url to emoji image next
|
|
||||||
to it's text alias.
|
Contacts from this account will never appear as offline and will be marked
|
||||||
|
away instead.
|
||||||
|
|
||||||
- auto_join (type: boolean; default: off)
|
#### server_prefix_len (type: int; default: 3)
|
||||||
Automatically join all of the server's channels so you don't have to add
|
|
||||||
them manually (no "chat add" needed).
|
|
||||||
|
|
||||||
- auto_join_exclude (type: string; default: "")
|
Prefix channel names with this many characters of server name. If set to 0
|
||||||
Comma-separated list of channel patterns to exclude when auto-joining
|
nothing will be prefixed. If set to anything lower than 0 - full server
|
||||||
channels. * matches any text, ? matches a single character. For instance,
|
name will be prefixed. Assuming we have a channel "general" on "beecord"
|
||||||
"Foo.*,Bar.A" will exclude all channels from server "Foo" and channel "A"
|
server here is what channel name you are going to get with different
|
||||||
from server "Bar".
|
settings:
|
||||||
|
|
||||||
- verbose (type: boolean; default: off)
|
-1 - #beecord.general
|
||||||
Show more protocol-related messages in control channel.
|
0 - #general
|
||||||
|
3 - #bee.general
|
||||||
|
|
||||||
|
#### fetch_pinned (type: boolean; default: off)
|
||||||
|
|
||||||
|
Fetch pinned messages on channel join.
|
||||||
|
|
||||||
|
#### friendship_mode (type: boolean; default: on)
|
||||||
|
|
||||||
|
With this option enabled, online/offline status is determined by the
|
||||||
|
friendship relationship with a user in addition to their actual away
|
||||||
|
status, and other users are added to channels.
|
||||||
|
|
||||||
|
#### always_afk (type: boolean; default: off)
|
||||||
|
|
||||||
|
When enabled bitlbee-discord would always report client's status as afk.
|
||||||
|
This feature is not properly documented in official docs, but it presumably
|
||||||
|
can force push notifications to other clients when bitlbee is connected.
|
||||||
|
|
||||||
|
#### emoji_urls (type: boolean; default: on)
|
||||||
|
|
||||||
|
Controls whether bitlbee-discord would display an url to emoji image next
|
||||||
|
to it's text alias.
|
||||||
|
|
||||||
|
#### auto_join (type: boolean; default: off)
|
||||||
|
|
||||||
|
Automatically join all of the server's channels so you don't have to add
|
||||||
|
them manually (no "chat add" needed).
|
||||||
|
|
||||||
|
#### auto_join_exclude (type: string; default: "")
|
||||||
|
|
||||||
|
Comma-separated list of channel patterns to exclude when auto-joining
|
||||||
|
channels. * matches any text, ? matches a single character. For instance,
|
||||||
|
"Foo.*,Bar.A" will exclude all channels from server "Foo" and channel "A"
|
||||||
|
from server "Bar".
|
||||||
|
|
||||||
|
#### verbose (type: boolean; default: off)
|
||||||
|
|
||||||
|
Show more protocol-related messages in control channel.
|
||||||
|
|
||||||
Debugging
|
Debugging
|
||||||
---------
|
---------
|
||||||
|
@ -199,7 +222,7 @@ on your screen run bitlbee by hand in foreground mode:
|
||||||
|
|
||||||
then connect with an irc client as you usually do.
|
then connect with an irc client as you usually do.
|
||||||
|
|
||||||
WARNING: there IS sensitive information in this debug output, such as auth
|
*WARNING*: there IS sensitive information in this debug output, such as auth
|
||||||
tokens, your plaintext password and, obviously, your incoming and outgoing
|
tokens, your plaintext password and, obviously, your incoming and outgoing
|
||||||
messages. Be sure to remove any information you are not willing to share before
|
messages. Be sure to remove any information you are not willing to share before
|
||||||
posting it anywhere.
|
posting it anywhere.
|
||||||
|
@ -212,4 +235,4 @@ Bugs
|
||||||
Please report bugs at github: https://github.com/sm00th/bitlbee-discord/issues
|
Please report bugs at github: https://github.com/sm00th/bitlbee-discord/issues
|
||||||
For questions, bitlbee-discord breakage demonstrations and chitchat you can
|
For questions, bitlbee-discord breakage demonstrations and chitchat you can
|
||||||
join the following discord server: https://discord.gg/0lUXEAZXmvW3ovUC or ping
|
join the following discord server: https://discord.gg/0lUXEAZXmvW3ovUC or ping
|
||||||
trac3r on irc.oftc.net/#bitlbee (irc is preferable).
|
`trac3r` on irc.oftc.net/#bitlbee (irc is preferable).
|
||||||
|
|
Loading…
Reference in New Issue