matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-steam.md

Setting up Steam bridging (optional)

The playbook can install and configure matrix-steam-bridge for you.

See the project’s documentation to learn what it does and why it might be useful to you.

Adjusting the playbook configuration

To enable the Steam bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

matrix_steam_bridge_enabled: true

Installing

After configuring the playbook, run it with playbook tags as below:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start

The shortcut commands with the just program are also available: just install-all and just setup-all

just install-all is useful for maintaining your setup quickly (2x-5x faster than just setup-all) when its components remain unchanged. If you adjust your vars.yml to remove other components, you’d need to run just setup-all, or these components will still remain installed. Note these shortcuts run the ensure-matrix-users-created tag too.

The tag for just commands for this bridge is matrix-steam-bridge - for example: just install-service matrix-steam-bridge

Usage

To use the bridge, you need to start a chat with Steam bridge bot with the handle @steambot:example.com (where example.com is your base domain, not the matrix. domain).

The bridge supports QR code and password-based login as well as SteamGuard codes via app, SMS, or e-mail. See matrix-steam-bridge documentation for more information about how to configure the bridge.

To login, send login [flow ID] where possible flow IDs are password or qr

Once logged in, send search [name] to search through recognized Steam friends. You can send a user name, display name, or all forms of Steam ID. Send start-chat [identifier] to request the bridge bot to open a chat room with a user.

Chat rooms will automatically be opened as new messages are received.

Send help to the bot to see the available commands.

Notable Configuration Options

• matrix_steam_bridge_network_presence_topic_enabled and matrix_steam_bridge_network_presence_topic_rich_presence_enabled mirror Steam’s Enhanced Rich Presence feature in Matrix. This will display the user’s current game and rich presence if supported by the game. This sets the DM room’s m.topic field to achieve this. Some games (like Deadlock) update the rich presence every minute with a match timer. In some clients, the topic update will cause the DM to be pushed to the top of the conversation list continuously, so this option is disabled by default.