aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 7a57d4bc0f145dcfe9ef72692c2682444fa07332 (plain) (blame)
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
# 🎤 `mic-icon`

![GIF of mic-icon](assets/mic-icon.gif)

It's [`volumeicon`](https://github.com/Maato/volumeicon) for microphones! But, it sucks and it's written in an inferior language and it only works on Linux 😅 (sorry, I'm honestly incompetent with other OSs).

In this modern internet dystopia, I often share my screen and disable notifications when presenting. This means that I don't get to see my "Microphone is [STATE]" notifications when sharing (I do tend to mute a fair bit for coughs). Imagine muting and forgetting to unmute as you continue to speak… OOOOH!!! THE MODERN SHAME that we snowflakes can't handle 😭. 

With that spiel said, I just needed something that "aims to be a lightweight mic status indicator that sits in your systray" and here it is… TADA! just like `volumeicon`, it's `mic-icon`!

I really just wrote this for myself and sharing it on the internet 🤷‍♂️. Good luck!

## Dependencies

* any rational recent version of Python 3
    * this thing is so simple, so I'll be surprised if we're facing any version incompatibilities already.
* `pulsectl`
* `pygobject`
* `pactl` command (part of the `pulseAudio` or `pipewire-pulse` packages)
* GTK 3.0 (via your system package manager)
* AppIndicator3 (via your system package manager)

## Installation

virtualenv is the way!

```sh
python -m venv .venv
```

then activate the `venv````sh
source .venv/bin/activate
```

(if you're a fish user, it would be  `source .venv/bin/activate.fish` 😉)

then…

```sh
pip install . 
```

then…

```sh
mic-icon
```

and now you have it! symlink that `./.venv/bin/mic-icon` SUMBITCH somewhere in your `PATH=` and run it on start-up — or however, the heck you want.

![the rock says come bring it](https://media.tenor.com/GkY0BS3F0R4AAAAM/the-rock-just-bring-it.gif)