Caution
This project is in early development. APIs may change without notice — use at your own risk.
A client-side Java library for the Matrix protocol.
This library aims to allow authors to build any kind of Matrix program such as a bot or a desktop client, the library handles all matters of serialization, validation and authentication.
MatrixAuth auth = new MatrixAuth(URI.create("https://kde.org")); // Set the URI of your Matrix server.
DiscoveryResponse response = auth.fetchWellKnown(); // Fetch well known for future operations
Tokens token = auth.login(CLIENT_NAME, PORT, DEVICE_ID); // Set configuration parameters
// After doing the login with the server in your browser, you will be returned the tokens...
MatrixClient client = MatrixClient.create(response, token.authToken()); // Use any service you want!
| Service | Capabilities | Status |
|---|---|---|
| Rooms | Banning, kicking, room summary, room search | Supported |
| Events | Sending messages, reading room events, /sync |
Partial |
| User Data | Profile search, profile modification | Supported |
| Filtering | Creating and retrieving filters | Supported |
| Auth | OpenIDConnect handshake | Supported |
(None currently!)
- Java 23+
- Tests use WireMock for HTTP stubbing and JUnit 5 as the test framework.
- Each module has its own test file; all tests must pass before merging.
To run the test suite:
./mvnw test- Jackson 3.x — JSON serialization/deserialization
See LICENSE