Amethyst

# Amethyst

[![Discussions](https://img.shields.io/github/discussions/ianyh/Amethyst)](https://github.com/ianyh/Amethyst/discussions)
[![Open Source Helpers](https://www.codetriage.com/ianyh/amethyst/badges/users.svg)](https://www.codetriage.com/ianyh/amethyst)
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

Tiling window manager for macOS along the lines of [xmonad](https://xmonad.org/).

![Windows](https://ianyh.com/amethyst/images/windows.png)

If you want to learn more about tiling window managers and the features of Amethyst there are some great community resources on YouTube.

[Boost your MacOS PRODUCTIVITY with Amethyst | Tiling Window Manager](https://www.youtube.com/watch?v=7Z9-Ry4yGNc)

## Getting Amethyst

Amethyst is available for direct download on the [releases page](https://github.com/ianyh/Amethyst/releases) or using [homebrew cask](https://github.com/Homebrew/homebrew-cask).

```
brew install --cask amethyst
```

Note: that Amethyst now is only supported on macOS 10.15+.

## Using Amethyst

Amethyst must be given permissions to use the accessibility APIs in the Privacy & Security tab, Privacy -> Accessibilty.

<p align="center">
  <img style="text-align: center; border-radius:4px;" width="500px" src="docs/images/accessibility-permission.png" alt="Give Accessibility permission to Amethyst under Privicay and Security." />
</p>

**_Important note_**: You will probably want to disable `Automatically rearrange Spaces based on most recent use` (found under Mission Control in System Preferences). This setting is enabled by default, and will cause your Spaces to swap places based on use. This makes keyboard navigation between Spaces unpredictable.

<p align="center">
  <img style="text-align: center" width="500px" src="docs/images/auto-rearranage.png" />
</p>

or run in a terminal:
```bash
defaults write com.apple.dock workspaces-auto-swoosh -bool NO
killall Dock
```

## Troubleshooting

See [Troubleshooting](docs/troubleshooting.md) for some common issues.

## Configuration

### Keyboard Shortcuts

Amethyst uses two modifier combinations (`mod1` and `mod2`) and can optionally use another two (`mod3` and `mod4`).

| Default Shortcut | Description |
|---|---|
| `mod1` | `option + shift` |
| `mod2` | `ctrl + option + shift` |
| `mod3` | not defined by default |
| `mod4` | not defined by default |

And defines the following commands, mostly a mapping to xmonad key combinations.

| Default Shortcut | Description |
|---|---|
| `mod1 + space` | Cycle layout forward |
| `mod2 + space` | Cycle layout backwards |
| `mod1 + h` | Shrink the main pane |
| `mod1 + l` | Expand the main pane |
| `mod1 + ,` | Increase main pane count |
| `mod1 + .` | Decrease main pane count |
| `mod1 + j` | Move focus counter clockwise |
| `mod1 + k` | Move focus clockwise |
| `mod1 + p` | Move focus to counter clockwise screen |
| `mod1 + n` | Move focus to clockwise screen |
| `mod2 + h` | Swap focused window to