reformat chat-with-us.md for plain editing

* split long lines at sentences, move markdown links to their own lines
* drop TODOs, direct links for templates pointless, see chatroom list
* only provide enough protocol details for someone already familiar
* standardise links to bridging software and their documentation
This commit is contained in:
Phil Morrell 2021-09-01 23:47:06 +01:00
parent 72e8de5516
commit 9afeab5c3e
Signed by: emorrp1
GPG Key ID: DBCA65091F248E6C
1 changed files with 52 additions and 16 deletions

View File

@ -2,46 +2,82 @@
# Chat with us!
Currently, our main channels of communication are instant messaging rooms hosted on the [Matrix](https://matrix.org/) network. They are also accessible via [Jabber/XMPP](https://joinjabber.org/) and [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) protocols, so that contributors can use their favorite client to join us.
Currently, our main channels of communication are instant messaging rooms hosted on the [Matrix] network.
They are also accessible via [Jabber/XMPP] and [IRC] protocols, so that contributors can use their favorite client to join us.
[Matrix]: https://matrix.org/
[Jabber/XMPP]: https://joinjabber.org/
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
The topic for our main channel is:
> LibreGaming community - general/organizational discussions. Join #libregaming-ROOM for specific working groups: website, translations, sysadmin. Community pad: https://md.roflcopter.fr/libregaming?both
> LibreGaming community - general/organizational discussions.
> Join #libregaming-ROOM for specific working groups: website, translations, sysadmin.
> Community pad: https://md.roflcopter.fr/libregaming?both
## Official chatrooms
- *[organization](https://matrix.to/#/#libregaming-matchmaking:freedombox.emorrp1.name)*: general channel for discussing the LibreGaming project ([xmpp](xmpp:#libregaming-organization#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-organization))
- *[website](https://matrix.to/#/#libregaming-website:freedombox.emorrp1.name)*: website Working Group ([xmpp](xmpp:#libregaming-website#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-website))
- *[sysadmin](https://matrix.to/#/#libregaming-sysadmin:freedombox.emorrp1.name)*: sysadmin Working Group, to keep our services running ([xmpp](xmpp:#libregaming-sysadmin#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-sysadmin))
- *[translations](https://matrix.to/#/#libregaming-translations:freedombox.emorrp1.name)*: translations Working Group, to make our website and other resources available in non-English languages ([xmpp](xmpp:#libregaming-translations#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-translations))
- *[offtopic](https://matrix.to/#/#libregaming-offtopic:freedombox.emorrp1.name)*: for discussions beyond the libregaming project ([xmpp](xmpp:#libregaming-offtopic#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-offtopic))
- *[chamber](https://matrix.to/#/#libregaming-chamber:freedombox.emorrp1.name)*: for bursts of high-volume organisational activity, when a topic gets too long for the main channel ([xmpp](xmpp:#libregaming-chamber#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-chamber))
- *[matchmaking](https://matrix.to/#/#libregaming-matchmaking:freedombox.emorrp1.name)*: matchmaking service/bot to find people to play with ([xmpp](xmpp:#libregaming-matchmaking#freedombox.emorrp1.name@matrix.org?join), [irc](ircs://irc.libera.chat/#libregaming-matchmaking))
- *organization*: general channel for discussing the LibreGaming project
[matrix](https://matrix.to/#/#libregaming-organization:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-organization#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-organization)
- *website*: website Working Group
[matrix](https://matrix.to/#/#libregaming-website:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-website#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-website)
- *sysadmin*: sysadmin Working Group, to keep our services running
[matrix](https://matrix.to/#/#libregaming-sysadmin:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-sysadmin#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-sysadmin)
- *translations*: translations Working Group, to make our website and other resources available in non-English languages
[matrix](https://matrix.to/#/#libregaming-translations:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-translations#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-translations)
- *offtopic*: for discussions beyond the libregaming project
[matrix](https://matrix.to/#/#libregaming-offtopic:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-offtopic#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-offtopic)
- *chamber*: for bursts of high-volume organisational activity, when a topic gets too long for the main channel
[matrix](https://matrix.to/#/#libregaming-chamber:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-chamber#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-chamber)
- *matchmaking*: matchmaking service/bot to find people to play with
[matrix](https://matrix.to/#/#libregaming-matchmaking:freedombox.emorrp1.name)
[xmpp](xmpp:#libregaming-matchmaking#freedombox.emorrp1.name@matrix.org?join)
[irc](ircs://irc.libera.chat/#libregaming-matchmaking)
To join one such room called `ROOM`, configure your client according to the instructions below.
## Matrix
Room name: `#libregaming-ROOM:freedombox.emorrp1.name` (**TODO:** direct link on matrix)
Room name: `#libregaming-ROOM:freedombox.emorrp1.name`
- Create an account [here](https://tchncs.de/matrix), or on any other Matrix server
- [Our communal space](https://matrix.to/#/#libregaming-space:matrix.org)
- **TODO:** More information links about matrix spaces, how to find a client that suits you, and how to join rooms on other networks
- Subspaces: Communities, Games, Engines, Tools, Historical (lower case for ROOM)
- Need to know the hidden room_id for read-only access (and history: Anyone) e.g. [chamber](https://view.matrix.org/room/!uagwTOyQbbWrZgwyPO:freedombox.emorrp1.name/)
- Need to know the hidden room_id for read-only access (and history: Anyone) e.g.
[chamber](https://view.matrix.org/room/!uagwTOyQbbWrZgwyPO:freedombox.emorrp1.name/)
## Jabber/XMPP
Room name: `#libregaming-ROOM#freedombox.emorrp1.name@matrix.org`, using the official matrix.org [matrix-bifrost gateway](https://github.com/matrix-org/matrix-bifrost) ([direct link](xmpp:#libregaming-ROOM#freedombox.emorrp1.name@matrix.org?join))
Room name: `#libregaming-ROOM#freedombox.emorrp1.name@matrix.org`
- Create an account [here](https://tchncs.de/xmpp), or on any other Jabber/XMPP server
- [Matrix conversion](https://github.com/matrix-org/matrix-bifrost/wiki/Address-syntax), [More information](https://joinjabber.org/), [IRC gateway](https://joinjabber.org/tutorials/transports/irc/)
- [More information](https://joinjabber.org/)
- Bridged with [matrix-bifrost](https://github.com/matrix-org/matrix-bifrost)
([Usage details](https://github.com/matrix-org/matrix-bifrost/wiki/Address-syntax))
## IRC
Room name: `#libregaming-ROOM` on the [irc.libera.chat](https://libera.chat/) network, using the official matrix.org [matrix-appservice-irc bridge](https://github.com/matrix-org/matrix-appservice-irc) ([direct link](ircs://irc.libera.chat/#libregaming-ROOM), [webchat](https://web.libera.chat/#libregaming-ROOM))
Room name: `#libregaming-ROOM` on `irc.libera.chat`
- [Create an account](https://libera.chat/guides/registration), though that's optional as guest access is supported
- [More information](https://libera.chat/)
- Various features are not supported by the IRC protocol: for a better user experience, consider using a Matrix or Jabber/XMPP client instead
- <details><summary>Bridge settings</summary>Our Matrix/IRC bridge is configured with the following settings: <code>org.matrix.appservice-irc.config { "lineLimit": 9, "allowUnconnectedMatrixUsers": true }</code></details>
- Bridged with [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc)
([Usage details](https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html))
- <details><summary>Bridge settings</summary>
Our Matrix/IRC bridge is configured with the following settings:
`org.matrix.appservice-irc.config`
`{ "lineLimit": 9, "allowUnconnectedMatrixUsers": true }`
</details>