robin/mx-puppet-steam
1
0
Fork 0
mirror of https://github.com/icewind1991/mx-puppet-steam.git synced 2026-06-03 17:44:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

extend readme with setup instructions

Browse source
This commit is contained in:
Robin Appelman 2021-01-26 22:22:19 +01:00
commit b61425d836
1 changed files with 51 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,6 +1,10 @@
# mx-puppet-steam # mx-puppet-steam
Matrix <-> Steam puppeting bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge) Matrix <-> Steam puppeting bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
This bridge uses puppeting to bridge your steam messages into a matrix server, this means that the bridge logs into your steam
account using the same api as the regular steam account and forwards any incoming steam message to a matrix chatroom and any
message you send in the matrix chatroom back to steam.
## Status ## Status
@ -18,6 +22,45 @@ Matrix <-> Steam puppeting bridge based on [mx-puppet-bridge](https://github.com
- [ ] sending embedded images to steam in group chats - [ ] sending embedded images to steam in group chats
- [x] steam -> matrix emotes - [x] steam -> matrix emotes
## Setup
You need at least node 12 to be able to run this!
Clone the repo and install the dependencies:
```
git clone https://github.com/icewind1991/mx-puppet-steam
cd mx-puppet-steam
npm install
```
Copy and edit the configuration file to your liking:
```
cp sample.config.yaml config.yaml
... edit config.yaml ...
```
Generate an appservice registration file. Optional parameters are shown in
brackets with default values:
```
npm run start -- -r [-c config.yaml] [-f steam-registration.yaml]
```
Then add the path to the registration file to your synapse `homeserver.yaml`
under `app_service_config_files`, and restart synapse.
Finally, run the bridge:
```
npm run start
```
### Docker
If you prefer to use a docker based setup an image is available at [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam).
## Linking ## Linking
Start a chat with @_steampuppet_bot:yourserver.com Start a chat with @_steampuppet_bot:yourserver.com
@ -38,3 +81,10 @@ you'll need to enable the experimental support in synapse for pushing these even
``` ```
in your registration file. in your registration file.
## Credits
This project would not be possible without the great work of (among others) the following projects:
- [mx-puppet-steam](https://github.com/Sorunome/mx-puppet-bridge) by Sorunome
- [node-steam-user](https://github.com/DoctorMcKay/node-steam-user/) by DoctorMcKay