From 55a98b029f904ea34670cd7647c0b17325752dc5 Mon Sep 17 00:00:00 2001 From: Maze Date: Mon, 24 Jan 2022 00:08:05 +0000 Subject: [PATCH] Describe differences between Moment and Mirage --- docs/MIRAGEDIFF.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/MIRAGEDIFF.md diff --git a/docs/MIRAGEDIFF.md b/docs/MIRAGEDIFF.md new file mode 100644 index 00000000..019ddf23 --- /dev/null +++ b/docs/MIRAGEDIFF.md @@ -0,0 +1,69 @@ +# Differences between Moment and Mirage + +## Maintenance + +Due to access issues, it is unlikely +Mirage +will continue being maintained. You should check the + +date of the last commit to make sure. + +## UI + +Moment adds a new default theme. If you would rather have the default +Mirage theme instead, add this to `~/.config/moment/settings.py`: +``` python +class General: + theme: str = "Midnight.qpl" +``` + +## Features + +There are currently no differences in features, +although Moment does have some bug fixes that Mirage does not. + +## Configuration + +Moment has a different configuration directory +(you will get an option to migrate your Mirage +config automatically on first startup). + +Moment has different default keybindings: +- Ctrl + Q is `Quit` +- `Reply` is Ctrl + R instead of Ctrl + Q +- `Remove` is Ctrl + Shift + R instead of Ctrl + R +- Ctrl + K is `Focus filter` +- `Focus previous message` is Ctrl + I instead of Ctrl + K + +If you wish to have `Focus previous message` and `Focus next message` +adjacent on Ctrl + U and Ctrl + I, +we recommend swapping Ctrl + U and Ctrl + J +by adding this to `~/.config/moment/settings.py`: +``` python +class Keys: + + class Rooms: + latest_unread = ["Ctrl+J"] + + class Messages: + next = ["Ctrl+Down", "Ctrl+U"] +``` + +## Reverting to default Mirage bindings + +If you wish to revert to default Mirage bindings, +add this to `~/.config/moment/settings.py`: +``` python +class Keys: + + quit = [] + + class Rooms: + focus_filter = ["Alt+F"] + latest_unread = ["Ctrl+J"] + + class Messages: + reply = ["Ctrl+Q"] + remove = ["Ctrl+R"] + previous = ["Ctrl+Up", "Ctrl+K"] +```