Skip to content

Commit dd0187e

Browse files
add info about increase all ui size into FAQ for other new user to find it more easily (#30)
1 parent 5a51caa commit dd0187e

File tree

2 files changed

+70
-14
lines changed

2 files changed

+70
-14
lines changed

Diff for: docs/about/faq.md

+70-14
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,58 @@ For each command, replace the spaces with dashes.
7777

7878
For example: `Core: Find Command``core:find-command`
7979

80+
## Lite XL doesn't look right on my monitor!
81+
82+
This is a known issue with Lite XL as it uses [SDL2],
83+
which has issues inferring the correct DPI on different platforms.
84+
Common symptoms are:
85+
86+
### Text too large / small
87+
88+
This issue is caused by Lite XL defaulting to the scale factor of 1.
89+
You can change the default scale with the `scale` plugin,
90+
which comes bundled with all Lite XL installations.
91+
92+
The `scale` plugin support scaling only the code editor or all UI elements.
93+
To change this setting, you can use the following steps:
94+
95+
=== "User Module"
96+
97+
The `scale` plugin reads the mode and default scale in `config.plugins.scale` on startup.
98+
In your user module, add the following lines:
99+
100+
```lua
101+
config.plugins.scale.mode = "ui"
102+
config.plugins.scale.default_scale = 2
103+
```
104+
105+
=== "Settings GUI"
106+
107+
To change the scale, navigate to the "Plugins" tab and expand the "Scale" section.
108+
Select "Everything" for the "Mode" dropdown and choose a default scaling factor
109+
that suits your monitor.
110+
The changes will apply on editor restart.
111+
112+
![scale plugin settings]{ loading=lazy }
113+
114+
=== "Environment Variable"
115+
116+
The `LITE_SCALE` environment variable can be used to set the scaling factor
117+
for testing purposes.
118+
119+
```sh
120+
LITE_SCALE=1.25 lite-xl
121+
```
122+
123+
### Text is blurry
124+
125+
This issue is commonly faced on Windows with displays of different scaling factors,
126+
and the main display has a lower scaling factor than the other.
127+
This is because Lite XL is only [system API aware] instead of per-monitor DPI aware.
128+
129+
Currently, there are no fixes for this issue.
130+
It will be fixed when Lite XL eventually adopts SDL3 and handles DPI changes correctly.
131+
80132
## What version of Lua does Lite XL use?
81133

82134
Lua 5.4, since [v2.1.0], released in late 2022.
@@ -88,17 +140,21 @@ Lite XL used Lua 5.2 before [v2.1.0].
88140
You need to [vibe].
89141

90142

91-
[lite]: https://github.com/rxi/lite
92-
[rxi]: https://github.com/rxi/lite
93-
[FreeType]: https://freetype.org/
94-
[AGG]: https://agg.sourceforge.net/antigrain.com/index.html
95-
[rejected]: https://github.com/rxi/lite/issues/145#issuecomment-643636679
96-
[plugin repository]: https://github.com/lite-xl/lite-xl-plugins
97-
[LPM]: https://github.com/lite-xl/lite-xl-plugin-manager
98-
[here]: ../user-guide/managing-plugins.md
99-
[v2.1.0]: https://github.com/lite-xl/lite-xl/releases/tag/v2.1.0
100-
[LSP]: https://github.com/lite-xl/lite-xl-lsp
101-
[lite-xl-terminal]: https://github.com/adamharrison/lite-xl-terminal
102-
[autowrap]: https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autowrap.lua?raw=1
103-
[Pragtical]: https://pragtical.dev
104-
[vibe]: https://github.com/eugenpt/lite-xl-vibe
143+
[lite]: https://github.com/rxi/lite
144+
[rxi]: https://github.com/rxi/lite
145+
[FreeType]: https://freetype.org/
146+
[AGG]: https://agg.sourceforge.net/antigrain.com/index.html
147+
[rejected]: https://github.com/rxi/lite/issues/145#issuecomment-643636679
148+
[plugin repository]: https://github.com/lite-xl/lite-xl-plugins
149+
[LPM]: https://github.com/lite-xl/lite-xl-plugin-manager
150+
[here]: ../user-guide/managing-plugins.md
151+
[v2.1.0]: https://github.com/lite-xl/lite-xl/releases/tag/v2.1.0
152+
[LSP]: https://github.com/lite-xl/lite-xl-lsp
153+
[lite-xl-terminal]: https://github.com/adamharrison/lite-xl-terminal
154+
[autowrap]: https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/autowrap.lua?raw=1
155+
[Pragtical]: https://pragtical.dev
156+
[vibe]: https://github.com/eugenpt/lite-xl-vibe
157+
[SDL2]: https://github.com/libsdl-org/SDL/tree/SDL2
158+
[Settings GUI]: https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/settings.lua?raw=1
159+
[scale plugin settings]: ../assets/user-guide/settings/plugins/scale.png
160+
[system API aware]: https://learn.microsoft.com/en-us/windows/win32/hidpi/high-dpi-desktop-application-development-on-windows#dpi-awareness-mode

Diff for: docs/assets/user-guide/settings/plugins/scale.png

78 KB
Loading

0 commit comments

Comments
 (0)