GitHub/matterbridge
3
0
Fork 0
mirror of https://github.com/42wim/matterbridge.git synced 2025-07-05 04:57:28 +02:00
Code Issues Projects Releases Wiki Activity

Updated Gateway: developing new one (markdown)

Krzysiek Madejski 2019-02-13 16:38:41 +01:00
parent aa31bde40d
commit e8f0743edc
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Gateway:-developing-new-one.md

@ -10,7 +10,6 @@ How to develop a new gateway/bridge?
- `yourbridge.go` with main struct and implementation of the `Bridger` interface - `yourbridge.go` with main struct and implementation of the `Bridger` interface
- `handlers.go` with handling messages incoming to Bridge - `handlers.go` with handling messages incoming to Bridge
- `helpers.go` for all the misc fucntions and helpers - `helpers.go` for all the misc fucntions and helpers
- [ ] While sending the message to the bridge make sure that you set the `config.Message.Channel` field to channel as it is mentioned in the config file.
- [ ] Minimal set of features is sending and receiving text messages working. - [ ] Minimal set of features is sending and receiving text messages working.
- [ ] Documentation - [ ] Documentation
- [ ] Add a [sample configuration](https://github.com/42wim/matterbridge/commit/6372d599b1ca2497aa49142d10496f345041b678#diff-0fcc5f77f08a4f4106d2da34c4dcd133) of your bridge to `matterbridge.toml.sample` and explain all the custom options - [ ] Add a [sample configuration](https://github.com/42wim/matterbridge/commit/6372d599b1ca2497aa49142d10496f345041b678#diff-0fcc5f77f08a4f4106d2da34c4dcd133) of your bridge to `matterbridge.toml.sample` and explain all the custom options
@ -51,4 +50,21 @@ Handle messages
- [ ] audio - [ ] audio
- [ ] video - [ ] video
- [ ] contacts? - [ ] contacts?
- [ ] any other? - [ ] any other?
## FAQ
**How can I set the default RemoteNickFormat for a protocol so users don't have to do it in a config file?**
@42wim?
**Why on Slack I see bot name instead of remote username?**
Check if you:
- [ ] did set `Message.Username` on the message being relayed
- [ ] did set `RemoteNickFormat` in config file
**Sending message to the bridge don't work**
- [ ] Channels must match. While sending the message to the bridge make sure that you set the `config.Message.Channel` field to channel as it is mentioned in the config file.