Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mirukana/mirage
A fancy, customizable, keyboard-operable Qt/QML & Python Matrix chat client for encrypted and decentralized communication.
https://github.com/mirukana/mirage
chat client desktop matrix matrix-client python qml qt
Last synced: 19 days ago
JSON representation
A fancy, customizable, keyboard-operable Qt/QML & Python Matrix chat client for encrypted and decentralized communication.
- Host: GitHub
- URL: https://github.com/mirukana/mirage
- Owner: mirukana
- License: lgpl-3.0
- Created: 2020-03-21T22:32:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-05T13:36:57.000Z (about 1 year ago)
- Last Synced: 2024-11-15T13:56:07.345Z (27 days ago)
- Topics: chat, client, desktop, matrix, matrix-client, python, qml, qt
- Language: QML
- Homepage:
- Size: 26.8 MB
- Stars: 412
- Watchers: 18
- Forks: 40
- Open Issues: 127
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
- awesome-starred - mirukana/mirage - A fancy, customizable, keyboard-operable Qt/QML & Python Matrix chat client for encrypted and decentralized communication. (qt)
README
# Mirage
[![Latest release](https://img.shields.io/github/v/release/mirukana/mirage)](https://github.com/mirukana/mirage/releases)
[![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio)
[![#mirage-client:matrix.org](https://img.shields.io/matrix/mirage-client:matrix.org?color=blueviolet)](https://matrix.to/#/#mirage-client:matrix.org)[Features](#currently-implemented-features) ⬥
[Installation](docs/INSTALL.md) ⬥
[Configuration](docs/CONFIG.md) ⬥
[Theming](docs/THEMING.md) ⬥
[Contributing](docs/CONTRIBUTING.md) ⬥
[Screenshots](#screenshots)A fancy, customizable, keyboard-operable [Matrix](https://matrix.org/) chat
client for encrypted and decentralized communication.
Written in Qt/QML and Python, **currently in alpha**.![Chat screenshot](docs/screenshots/01-chat.png?raw=true)
## Currently Implemented Features
### General
- **Fluid, responsive interface** that adapts to any window size
- Toggleable **compact mode**
- Customizable **keyboard shortcuts** for everything, including
switching rooms, navigating messages, sending/opening files...
- Versatile **theming system**, properties can refer to each other and have
any valid ECMAScript 7 expression as values
- Comes by default with **dark** and **transparent themes**
- Desktop **notifications**, sounds and window alerts
- Support for HTTP and SOCKS5 proxies including TOR### Accounts
- Built-in public homeservers list
- **Multiple accounts** in one client
- **SSO** and password authentication
- Set your display name and profile picture
- Import/export **E2E** key files
- Inspect, rename, manually verify and sign out one or multiple **sessions**
- Sessions for accounts within the same client automatically verify each others
- Set your account's **presence** to online, unavailable, invisible or offline
- Set custom **status messages**
- Automatically set your status to unavailable after a period of inactivity
- Advanced **push rules** editor### Rooms
- Create, join, leave and forget rooms
- Send, accept and refuse invites
- Edit the room's name, topic, invite requirement, guest access and enable E2E
- Kick, ban and set the power level of users- Pin rooms to the top of the list
- Unread message and highlight counters
- Sending **read receipts** to mark rooms as read
- Seeing who has read a message and when
- Inspect and manually **verify** other users's **E2E sessions**
- See other users's **presence, status message and last seen time**
- **Typing notifications**### Messages
- Send and receive **E2E encrypted messages**
- Send and receive emote messages (e.g. `/me reads attentively`)
- Receive notice (bot) messages
- Send **markdown** formatted messages
- Additional syntax for **coloring text**, e.g. `(Some text...)` -
[SVG/CSS color names](https://www.december.com/html/spec/colorsvg.html),
`#RGB`, `#RRGGBB` and `#AARRGGBB` hex codes can be used- Send and receive normal or **E2E encrypted files**
- Client-side Matrix & HTTP URL **image previews**, including animated GIF
- Upload images by pasting or drag-and-drop
- Full-size image viewer- User ID, display names, room ID and room aliases **mentions**
- **Autocompletion** for usernames and user ID
- Individual and mass **message removal**
- Sending **rich replies**## Documentation
- [Installation](docs/INSTALL.md)
- [Configuration](docs/CONFIG.md)
- [Theming](docs/THEMING.md)
- [Contributing](docs/CONTRIBUTING.md)## Screenshots
![Sign-in](docs/screenshots/02-sign-in.png)
![Account settings](docs/screenshots/03-account-settings.png)
![Room creation](docs/screenshots/04-create-room.png)
![Chat](docs/screenshots/01-chat.png?raw=true)
![Main pane in small window](docs/screenshots/05-main-pane-small.png)
![Chat in small window](docs/screenshots/06-chat-small.png)
![Room pane in small window](docs/screenshots/07-room-pane-small.png)