matrix-double-puppeting-bridge/README.md
Kumi 7eba27ea9e
feat: Initialize Matrix double puppeting bridge project
Introduced the scaffolding for a Matrix double puppeting bridge, including essential configuration and basic operational logic. The setup encompasses the .gitignore additions to exclude environment and build files, inclusion of LICENSE and README for legal and project outlining, respectively, and foundational project structure in pyproject.toml for package management. Core functionality to relay messages between Matrix and an external service is established, with stubs for extending the bridge's capabilities. This groundwork lays the foundation for further development and experimentation with the Matrix API and double puppeting mechanisms, illustrating a preliminary model for bi-directional communication bridges.
2024-05-16 10:10:19 +02:00

17 lines
No EOL
982 B
Markdown

# Matrix Double Puppeting Bridge
This is a simple demonstration of how to write a Matrix double puppeting bridge using the [mautrix-python](https://docs.mau.fi/python/latest/) library.
At this point, it is not complete. It is a work in progress I am using to learn how to write a Matrix bridge, and one I hope I will be able to fork and use as a starting point for future projects.
## What is a double puppeting bridge?
A double puppeting bridge handles multiple users on both sides of the bridge. Each user on Matrix is represented by an individual account on the remote service, and each user on the remote service is represented by an individual puppet account on Matrix.
## How does it work?
The bridge listens for messages on the Matrix side and sends them to the remote service. It also listens for messages on the remote service and sends them to the Matrix side.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.