mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-11-18 05:05:00 +00:00
bf5373479b
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# Setting up MX Puppet Steam (optional)
|
|
|
|
The playbook can install and configure
|
|
[mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you.
|
|
|
|
See the project page to learn what it does and why it might be useful to you.
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
|
|
|
|
```yaml
|
|
matrix_mx_puppet_steam_enabled: true
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
Once the bot is enabled you need to start a chat with `Steam Puppet Bridge` with
|
|
the handle `@_steampuppet_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base
|
|
domain, not the `matrix.` domain).
|
|
|
|
Three authentication methods are available, Legacy Token, OAuth and xoxc token.
|
|
See mx-puppet-steam [documentation](https://github.com/icewind1991/mx-puppet-steam)
|
|
for more information about how to configure the bridge.
|
|
|
|
Once logged in, send `list` to the bot user to list the available rooms.
|
|
|
|
Clicking rooms in the list will result in you receiving an invitation to the
|
|
bridged room.
|
|
|
|
Also send `help` to the bot to see the commands available.
|