aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2021-09-04 02:31:10 +0200
committerdec05eba <dec05eba@protonmail.com>2021-09-04 02:31:10 +0200
commitfa815c3eee27cdae69b2e765b03de62a13f6379d (patch)
tree4244ae7b62e2c94d749f0b199dd620bdd251dad0 /README.md
parentdd4573e05cdfa2d9b99ef7a49c99e27c201da3e9 (diff)
Make font sizes customizable with a config file, see example-config.json. Remove environment variables
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/README.md b/README.md
index 5db0713..cafd61b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# QuickMedia
-A dmenu-inspired native client for web services.
+A rofi inspired native client for web services.
Currently supported web services: `youtube`, `soundcloud`, `nyaa.si`, `manganelo`, `manganelos`, `mangatown`, `mangakatana`, `mangadex`, `readm`, `onimanga`, `4chan`, `matrix`, `saucenao`, `hotexamples`, `anilist` and _others_.\
Config data, including manga progress is stored under `$XDG_CONFIG_HOME/quickmedia` or `$HOME/.config/quickmedia`.\
Cache is stored under `$XDG_CACHE_HOME/quickmedia` or `$HOME/.cache/quickmedia`.
@@ -148,18 +148,16 @@ Type text and then wait and QuickMedia will automatically search.\
`/leave`: Leave the current room.\
`/me [text]`: Send a message of type "m.emote".\
`/react [text]`: React to the selected message (also works if you are replying to a message).
+## Config
+Config is loaded from `$XDG_CACHE_HOME/quickmedia/config.json` if it exists. See [example-config.json](example-config.json) for an example config. All fields in the config file are optional.
## Environment variables
-Set `QM_THEME` to one of the following: `default, nord` to change the theme.\
-Set `QM_SCALE` to scale UI.\
-Set `QM_FONT_SCALE` to scale fonts.\
-Set `QM_USE_SYSTEM_FONTS` to `1` to use system fonts instead of noto fonts.
If `xdg-open` is not installed then the `BROWSER` environment variable is used to open links in a browser.\
Set `QM_PHONE_FACTOR=1` to disable the room list side panel in matrix.
## UI scaling
-Either set the `QM_SCALE` or `GDK_SCALE` environment variable or add `Xft.dpi` to `$HOME/.Xresources` (`xrdb` which is part of the `xorg-xrdb` package needs to be installed).\
+Set `GDK_SCALE` environment variable or add `Xft.dpi` to `$HOME/.Xresources` (`xrdb` which is part of the `xorg-xrdb` package needs to be installed).\
For example a value of 96 for the `Xft.dpi` means 1.0 scaling and 144 (96*1.5) means 1.5 scaling.\
Note that at the moment, images do also not scale above their original size.\
-Set `QM_THEME` to scale fonts.
+Scaling can also be set in `$XDG_CACHE_HOME/quickmedia/config.json`, which will override `GDK_SCALE` and `$HOME/.Xresources`.
## Tabs
[tabbed](https://tools.suckless.org/tabbed/) can be used to put quickmedia windows into tabs. After installing `tabbed`, run `tabbed -c -k quickmedia launcher -e`.
## License