sway-autostart-i3ipc/README.md

42 lines
1,022 B
Markdown

# sway-autostart-i3ipc
A smart but also lazy login autostart manager for i3/Sway.
Will conditionally exec other things defined in a YML dict.
Required i3/Sway config line:
```bash
exec path/to/startup.py
```
## Requirements
### Fedora / EL
```bash
sudo dnf -yq install python3-{i3ipc,pyxdg,pyyaml,systemd}
```
### Debian / Ubuntu
```bash
sudo apt install python3-{i3ipc,systemd,xdg,yaml}
```
## Config sample
```yaml
---
autostarts:
pre: [] # blocking tasks that run every day, before any other section. intended for backups/updates
common: [] # non-blocking tasks that run every day
weekend: [] # blocking tasks for Saturday/Sunday, after 'pre' but before 'common'
work: [] # non-blocking tasks run if Monday through Friday between 8AM - 4PM
```
The config may be chosen with `-c path/to/autostart.yml`.
The default is `XDG_CONFIG_HOME/autostart-i3ipc.yml` _(typically in ~/.config)_
Work day autostarts may be temporarily disabled by creating `~/.vacation`.
When desired again, remove the file.