Connections

Important links

Your connection list is stored in a file named connections.yml. It's a YAML file that should be in the same folder as your config file (creates itself after a successful start). Example format:

connections.yml
example:
- type: discord
id: '1234'
- type: messenger
id: '5678'

Each connection entry consists of "endpoint" blocks, which usually have 2 properties: type (discord/messenger) and id, both required when creating a connection. You can add as many endpoints to one connections as you want. Additionally, an endpoint can have a readonly property, which when set to true can make that endpoint read-only

On every launch Miscord will parse connections.yml to get a list of connections and will notify you if something's wrong. For each connection endpoint there will be added a name, so it will be more readable.

You can also configure connections with commands. The example above can be recreated using following commands:

@Miscord add connection-name
@Miscord link connection-name discord 1234
@Miscord link connection-name messenger 5678

Example connections file (used live on Miscord's Discord server in #testingFacebook banned my accounts) :

connections.yml
__comment: >-
This is your connections.yml file. More info at
https://github.com/miscord/miscord/wiki/Connections.yml
testing:
- type: discord
id: '433683136115900421'
- type: messenger
id: '1616656375118166'
dev:
- type: discord
id: '461611312196091321'
- type: messenger
id: '1709943095783086'
- type: messenger
id: '1458225837612649'
readonly: true

Command representation:

@Miscord add testing
@Miscord link testing discord 433683136115900421
@Miscord link testing messenger 1616656375118166
@Miscord add dev
@Miscord link dev discord 461611312196091321
@Miscord link dev messenger 1709943095783086
@Miscord link dev messenger 1458225837612649
@Miscord readonly dev 1458225837612649 true