2020-07-01 11:46:58 +00:00
# Setting up MX Puppet Steam (optional)
The playbook can install and configure
2020-07-04 11:20:02 +00:00
[mx-puppet-steam ](https://github.com/icewind1991/mx-puppet-steam ) for you.
2020-07-01 11:46:58 +00:00
See the project page to learn what it does and why it might be useful to you.
2024-10-12 11:48:24 +00:00
## Adjusting the playbook configuration
2020-07-01 11:46:58 +00:00
2024-10-17 13:17:56 +00:00
To enable the [Steam ](https://steampowered.com/ ) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2020-07-01 11:46:58 +00:00
```yaml
matrix_mx_puppet_steam_enabled: true
```
2024-10-12 18:03:46 +00:00
## Installing
After configuring the playbook, run the [installation ](installing.md ) command: `just install-all` or `just setup-all`
2020-07-01 11:46:58 +00:00
## Usage
Once the bot is enabled you need to start a chat with `Steam Puppet Bridge` with
2024-10-17 13:23:06 +00:00
the handle `@_steampuppet_bot:example.com` (where `example.com` is your base
2020-07-01 11:46:58 +00:00
domain, not the `matrix.` domain).
Three authentication methods are available, Legacy Token, OAuth and xoxc token.
2020-07-04 11:20:02 +00:00
See mx-puppet-steam [documentation ](https://github.com/icewind1991/mx-puppet-steam )
2020-07-01 11:46:58 +00:00
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.
