shore-matrix 0.1.5

Matrix bridge for the Silvershore chat daemon.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# shore-matrix

Matrix bridge for the [Shore](https://github.com/mythofmeat/shore-core)
chat daemon. Talks to `shore-daemon` over the Shore Wire Protocol (SWP) and
exposes characters as Matrix users on an embedded homeserver.

Features:

- E2E-encrypted Matrix bridging via
  [`matrix-rust-sdk`](https://github.com/matrix-org/matrix-rust-sdk).
- Per-character Matrix accounts with avatars + display names.
- Embedded-homeserver provisioning (continuwuity / conduwuit / tuwunel).
- Health checks and reconnection.

## Build

```sh
cargo build --release
```

The resulting binary is `target/release/shore-matrix`.

## Run

Reads connection settings from `~/.config/shore/client.toml` and Matrix-specific
configuration from environment variables / CLI flags. See
[Shore](https://github.com/mythofmeat/shore-core) for daemon-side
configuration.

## License

Dual-licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE-2.0](LICENSE-APACHE-2.0))
- MIT License ([LICENSE-MIT](LICENSE-MIT))

at your option.