partymode 0.2.0

Keeps your system awake while playing media
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# partymode
Prevents your system from idling/suspending while media is being played.

## Dependencies
- `dbus`
- `systemd`

## Installation
### crates.io

```sh
cargo install partymode
```

## Usage
```
partymode [OPTIONS] <COMMAND>

Commands:
  daemon  Run the partymode daemon
  on      Enable party mode
  off     Disable party mode
  toggle  Toggle party mode
  status  Show the current status
  help    Print this message or the help of the given subcommand(s)

Options:
  -c, --config <PATH>  Provide a custom location for the config file
  -v, --verbose        Enable verbose logging
  -h, --help           Print help
  -V, --version        Print version
```

### Systemd unit
To manage the partymode daemon with systemd, you can create this user service:

```desktop
[Unit]
After=dbus-broker.service
Description="partymode - Keep your system awake while playing media"
Documentation="https://github.com/peppidesu/partymode"

[Service]
Type=simple
ExecStart=/path/to/partymode daemon # change this
Restart=on-failure

[Install]
WantedBy=default.target
```

## Configuration
`partymode` will create the following config at `~/.config/partymode/config.toml` (or the directory specified with `-c`) if it doesn't exist:

```toml
default-enabled = true
poll-interval = 5000

["*"]
always = false
mode = "block"
targets = ["idle"]
```

#### `default-enabled`
Whether to enable partymode on startup or not.

#### `poll-interval`
How often to check for player changes, in ms.

### Rules
Rules allow you to specify inhibit behavior on a per-application basis. A rule looks like this:
```toml
[name]
always = false
mode = "<mode>"
targets = []
```

#### `always`
When true, inhibit regardless of whether partymode is enabled or not.

#### `mode`
Inhibit mode as specified by [systemd-inhibit(1)](https://www.freedesktop.org/software/systemd/man/latest/systemd-inhibit.html#--mode=).

#### `targets`
What to inhibit. Can be one of `"idle"`, `"suspend"` or `"shutdown"`.

#### Rule names
`partymode` will use the last part of the MPRIS bus name (`org.mpris.MediaPlayer2.<name>`) to match against config rules. You can get a list of these with `playerctl`:
```sh
playerctl -l
```

#### Default rule
If parts of a rule are omitted or no matching rule is found, `partymode` resorts to using the default rule (`["*"]`).

## Contribute
Feel free to report issues and PR :)