2020-04-03 01:39:21 +11:00
|
|
|
# Mirage
|
|
|
|
|
|
|
|
|
|
[](https://github.com/mirukana/mirage/releases)
|
2020-07-20 15:38:10 +10:00
|
|
|
[](https://github.com/poljar/matrix-nio)
|
|
|
|
|
[](https://matrix.to/#/#mirage-client:matrix.org)
|
2019-07-03 03:59:52 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
[Features](#currently-implemented-features) ⬥
|
2020-11-12 21:14:14 +11:00
|
|
|
[Installation](docs/INSTALL.md) ⬥
|
2021-01-04 16:06:36 +11:00
|
|
|
[Configuration](docs/CONFIG.md) ⬥
|
|
|
|
|
[Theming](docs/THEMING.md) ⬥
|
2020-11-13 01:41:58 +11:00
|
|
|
[Contributing](docs/CONTRIBUTING.md) ⬥
|
2020-03-20 10:42:49 +11:00
|
|
|
[Screenshots](#more-screenshots)
|
2019-09-13 08:10:21 +10:00
|
|
|
|
2020-03-22 05:24:43 +11:00
|
|
|
A fancy, customizable, keyboard-operable [Matrix](https://matrix.org/) chat
|
|
|
|
|
client for encrypted and decentralized communication.
|
2020-07-20 15:38:10 +10:00
|
|
|
Written in Qt/QML and Python, **currently in alpha**.
|
2019-07-03 03:59:52 +10:00
|
|
|
|
2020-11-12 21:07:19 +11:00
|
|
|
|
2019-07-03 03:59:52 +10:00
|
|
|
|
2020-03-20 10:42:49 +11:00
|
|
|
## Currently Implemented Features
|
2019-07-18 22:10:36 +10:00
|
|
|
|
2020-06-26 22:33:22 +10:00
|
|
|
### Interface
|
2019-07-26 09:19:39 +10:00
|
|
|
|
2020-07-20 15:38:10 +10:00
|
|
|
- **Fluid, responsive interface** that adapts to any window size
|
2020-03-24 09:15:51 +11:00
|
|
|
- Toggleable **compact mode**
|
2020-07-20 15:38:10 +10:00
|
|
|
- Customizable **keyboard shortcuts** for everything, including
|
|
|
|
|
switching rooms, navigating messages, sending/opening files...
|
2020-03-22 08:42:45 +11:00
|
|
|
- Versatile **theming system**, properties can refer to each other and have
|
|
|
|
|
any valid ECMAScript 7 expression as values
|
2020-03-22 05:24:43 +11:00
|
|
|
- Comes by default with **dark** and **transparent themes**
|
2019-08-30 14:07:05 +10:00
|
|
|
|
2020-06-26 22:33:22 +10:00
|
|
|
### Accounts
|
2019-08-30 14:07:05 +10:00
|
|
|
|
2020-06-26 22:33:22 +10:00
|
|
|
- **Multiple accounts** in one client
|
2020-08-23 23:16:27 +10:00
|
|
|
- Built-in public homeservers list
|
|
|
|
|
- **SSO** and password authentication
|
2020-03-20 10:13:08 +11:00
|
|
|
- Set your display name and profile picture
|
|
|
|
|
- Import/export **E2E** key files
|
2020-07-18 04:26:12 +10:00
|
|
|
- Inspect, rename, manually verify and sign out one or multiple **sessions**
|
2020-07-18 04:23:47 +10:00
|
|
|
- Sessions for accounts within the same client automatically verify each others
|
2020-07-18 04:26:12 +10:00
|
|
|
- Set your account's **presence** to online, unavailable, invisible or offline
|
|
|
|
|
- Set custom **status messages**
|
2020-07-18 04:23:47 +10:00
|
|
|
- Automatically set your status to unavailable after a period of inactivity
|
2019-07-18 22:10:36 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
### Rooms
|
2019-07-03 03:59:52 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
- Create, join, leave and forget rooms
|
|
|
|
|
- Send, accept and refuse invites
|
2020-06-06 00:35:42 +10:00
|
|
|
- Edit the room's name, topic, invite requirement, guest access and enable E2E
|
2020-07-18 04:23:47 +10:00
|
|
|
- Kick, ban and set the power level of users
|
|
|
|
|
|
2020-06-02 00:03:38 +10:00
|
|
|
- Unread message and highlight counters
|
2020-06-06 00:35:42 +10:00
|
|
|
- Sending **read receipts** to mark rooms as read
|
2020-07-18 04:26:12 +10:00
|
|
|
- Inspect and manually **verify** other users's **E2E sessions**
|
|
|
|
|
- See other users's **presence, status message and last seen time**
|
|
|
|
|
- **Typing notifications**
|
2019-07-03 03:59:52 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
### Messages
|
2019-07-18 22:10:36 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
- Send and receive **E2E encrypted messages**
|
|
|
|
|
- Send and receive emote messages (e.g. `/me reads attentively`)
|
|
|
|
|
- Receive notice (bot) messages
|
|
|
|
|
- Send **markdown** formatted messages
|
2020-03-22 08:42:45 +11:00
|
|
|
- Additional syntax for **coloring text**, e.g. `<red>(Some text...)` -
|
2020-03-20 10:13:08 +11:00
|
|
|
[SVG/CSS color names](https://www.december.com/html/spec/colorsvg.html),
|
2020-11-17 05:35:44 +11:00
|
|
|
`#RGB`, `#RRGGBB` and `#AARRGGBB` hex codes can be used
|
2020-07-18 04:23:47 +10:00
|
|
|
|
2020-03-20 10:13:08 +11:00
|
|
|
- Send and receive normal or **E2E encrypted files**
|
|
|
|
|
- Client-side Matrix & HTTP URL **image previews**, including animated GIF
|
2020-07-18 04:23:47 +10:00
|
|
|
- Upload images by pasting
|
2020-08-23 23:16:27 +10:00
|
|
|
- Full-size image viewer
|
2020-07-18 04:23:47 +10:00
|
|
|
|
2020-03-24 06:13:03 +11:00
|
|
|
- User ID, display names, room ID and room aliases **mentions**
|
2020-08-23 23:16:27 +10:00
|
|
|
- **Autocompletion** for usernames and user ID
|
2020-04-03 23:50:10 +11:00
|
|
|
- Individual and mass **message removal**
|
2020-05-22 23:16:47 +10:00
|
|
|
- Sending **rich replies**
|
2019-07-18 22:10:36 +10:00
|
|
|
|
2021-01-04 16:06:36 +11:00
|
|
|
## Documentation
|
2019-07-18 22:10:36 +10:00
|
|
|
|
2021-01-04 16:06:36 +11:00
|
|
|
- [Installation](docs/INSTALL.md)
|
|
|
|
|
- [Configuration](docs/CONFIG.md)
|
|
|
|
|
- [Theming](docs/THEMING.md)
|
|
|
|
|
- [Contributing](docs/CONTRIBUTING.md)
|
2020-11-13 01:41:58 +11:00
|
|
|
|
2020-03-20 10:42:49 +11:00
|
|
|
## Screenshots
|
2020-03-20 10:13:08 +11:00
|
|
|
|
2020-11-12 21:07:19 +11:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
