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
1
example:
2
- type: discord
3
id: '1234'
4
- type: messenger
5
id: '5678'
Copied!
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:
1
@Miscord add connection-name
2
@Miscord link connection-name discord 1234
3
@Miscord link connection-name messenger 5678
Copied!
Example connections file (used live on Miscord's Discord server in #testingFacebook banned my accounts) :
connections.yml
1
__comment: >-
2
This is your connections.yml file. More info at
3
https://github.com/miscord/miscord/wiki/Connections.yml
4
testing:
5
- type: discord
6
id: '433683136115900421'
7
- type: messenger
8
id: '1616656375118166'
9
dev:
10
- type: discord
11
id: '461611312196091321'
12
- type: messenger
13
id: '1709943095783086'
14
- type: messenger
15
id: '1458225837612649'
16
readonly: true
Copied!
Command representation:
1
@Miscord add testing
2
@Miscord link testing discord 433683136115900421
3
@Miscord link testing messenger 1616656375118166
Copied!
1
@Miscord add dev
2
@Miscord link dev discord 461611312196091321
3
@Miscord link dev messenger 1709943095783086
4
@Miscord link dev messenger 1458225837612649
5
@Miscord readonly dev 1458225837612649 true
Copied!
Last modified 2yr ago
Copy link