2023-01-16 02:18:08 +00:00
# erm
a fork of Darktile
https://github.com/liamg/darktile
2023-04-10 03:37:10 +00:00
original readme below
2021-07-30 22:29:20 +00:00
# Darktile
2023-01-16 02:18:08 +00:00
Darktile is a GPU rendered terminal emulator designed for tiling window managers.
2021-07-30 22:29:20 +00:00
## Features
- GPU rendering
- Unicode support
2021-08-02 19:55:04 +00:00
- Variety of themes available (or build your own!)
2021-07-30 22:29:20 +00:00
- Compiled-in powerline font
2021-08-02 19:55:04 +00:00
- Works with your favourite monospaced TTF/OTF fonts
- Font ligatures (turn it off if you're not a ligature fan)
- Hints: Context-aware overlays e.g. hex colour viewer, octal permission annotation
2021-07-30 22:29:20 +00:00
- Take screenshots with a single key-binding
2021-08-02 19:55:04 +00:00
- Sixels
- Window transparency (0-100%)
- Customisable cursor (most popular image formats supported)
< p align = "center" >
< img src = "cursor.gif" >
< / p >
2021-07-30 22:29:20 +00:00
## Installation
Install dependencies:
- `xorg-dev`
- `libgl1-mesa-dev`
2021-07-31 13:38:41 +00:00
Grab a binary from the [latest release ](https://github.com/liamg/darktile/releases/latest ), `chmod +x` it and place it in your `$PATH` .
If you're too lazy to do the above and you like to live life on the edge, you can pipe this script to sudo:
```bash
curl -s "https://raw.githubusercontent.com/liamg/darktile/main/scripts/install.sh" | sudo bash
```
2021-07-30 22:29:20 +00:00
## Configuration
2023-01-16 02:18:08 +00:00
Configuration files should be created in `$XDG_CONFIG_HOME/darktile/` if the variable is defined, otherwise in `$HOME/.config/darktile/` .
2021-07-30 22:29:20 +00:00
If you wish, you can create an example config file as a starting point using `darktile --rewrite-config` .
Darktile will use sensible defaults if no config/theme files are available. The same applies when you omit settings from config/theme files, meaning it is perfectly valid to start with empty config/theme files and add to them as required to override the default behaviour.
### Config File
Found in the config directory (see above) inside `config.yaml` .
```yaml
2021-08-02 19:55:04 +00:00
opacity: 1.0 # Window opacity: 0.0 is fully transparent, 1.0 is fully opaque
2021-07-30 22:29:20 +00:00
font:
2021-08-02 19:55:04 +00:00
family: "" # Font family. Find possible values for this by running 'darktile list-fonts'
size: 16 # Font size
dpi: 72 # DPI
ligatures: true # Enable font ligatures e.g. render '≡' instead of '==='
cursor:
image: "" # Path to an image to render as your cursor (defaults to standard rectangular cursor)
2021-07-30 22:29:20 +00:00
```
### Example Theme
Found in the config directory (see above) inside `theme.yaml` . You can replace this file with a symlink or any theme file from [darktile-themes ](https://github.com/liamg/darktile-themes ).
```yaml
black: '#1d1f21'
red: '#cc6666'
green: '#b5bd68'
yellow: '#f0c674'
blue: '#81a2be'
magenta: '#b294bb'
cyan: '#8abeb7'
white: '#c5c8c6'
brightblack: '#666666'
brightred: '#d54e53'
brightgreen: '#b9ca4a'
brightyellow: '#e7c547'
brightblue: '#7aa6da'
brightmagenta: '#c397d8'
brightcyan: '#70c0b1'
brightwhite: '#eaeaea'
background: '#1d1f21'
foreground: '#c5c8c6'
selectionbackground: '#aa8800'
selectionforeground: '#ffffff'
cursorforeground: '#1d1f21'
cursorbackground: '#c5c8c6'
```
## Key Bindings
| Action | Binding |
|-----------------------------|---------|
| Copy | `ctrl + shift + C`
| Paste | `ctrl + shift + V`
| Decrease font size | `ctrl + -`
| Increase font size | `ctrl + =`
| Take screenshot | `ctrl + shift + [`
| Open URL | `ctrl + click`
