File: README.md

package info (click to toggle)
gnome-shell-extension-caffeine 44-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,044 kB
  • sloc: javascript: 1,406; xml: 110; makefile: 25; sh: 13
file content (84 lines) | stat: -rw-r--r-- 2,916 bytes parent folder | download 
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
 
# gnome-shell-extension-caffeine

[<img src="https://github.com/eonpatapon/gnome-shell-extension-caffeine/raw/master/resources/get_it_on_gnome_extensions.png" height="100" align="right">](https://extensions.gnome.org/extension/517/caffeine/)

[![License](https://img.shields.io/github/license/eonpatapon/gnome-shell-extension-caffeine)](https://github.com/eonpatapon/gnome-shell-extension-caffeine/blob/master/LICENSE)
[![GitHub release (latest by date)](https://img.shields.io/github/v/tag/eonpatapon/gnome-shell-extension-caffeine)](https://github.com/eonpatapon/gnome-shell-extension-caffeine/releases/latest)

Enable/Disable auto suspend with quick setting toggle.

![Quick Toggle Caffeine](screenshots/screenshot.png)


###  ⚠️  __This extension is barely maintained anymore, new maintainers are welcome!__
&nbsp;

## Version
This extension supports GNOME Shell `3.4` -> `43`

|Branch|Version|Compatible Gnome version|
|---|:---:|---|
| master  | 43 | Gnome 43  |
| gnome-shell-40-42  | 42 | Gnome 40 -> 42  |
| gnome-shell-3.36-3.38: 3.36 | 37 | Gnome 3.36 -> 3.38 |
| gnome-shell-3.32-3.34 | 33 | Gnome 3.32 -> 3.34 |
| gnome-shell-3.10-3.30 | - | Gnome 3.10 -> 3.30 |
| gnome-shell-before-3.10 | - | Gnome 3.4 -> 3.8 |

&nbsp;

## Installation From source

```
make build
make install
```
  - Restart the shell
  - Enable the extension
&nbsp;

## Screenshots & features


### <ins>Scroll Indicator Icon</ins>
![Screenshot](screenshots/screenshot-scroll-up.png)![Screenshot](screenshots/screenshot-scroll-down.png)

You can scroll on the indicator icon to enable / disable auto suspend:

- Scroll up -> Filled cup: Caffeine enabled
- Scroll down -> Empty cup: Caffeine disabled

<ins>__Note__</ins>: the option "Show status indicator" must be set on "always" (see below).
&nbsp;

### <ins>Notifications</ins>
![Screenshot](screenshots/screenshot-notification-enable.png)
![Screenshot](screenshots/screenshot-notification-disable.png)
&nbsp;

### <ins>Timer option</ins>
This option enable Caffeine for a given amount of time (similar to Caffeine in LineageOS).

![Screenshot](screenshots/screenshot-timer-off.png)![Screenshot](screenshots/screenshot-timer-on.png)
&nbsp;

### <ins>Preferences</ins>
![Preferences](screenshots/screenshot-prefs.png)


## CLI

- Get current state:
  ```sh
  gsettings --schemadir ~/.local/share/gnome-shell/extensions/caffeine@patapon.info/schemas/ get org.gnome.shell.extensions.caffeine user-enabled
  ```
- Enable Caffeine:
  ```sh
  gsettings --schemadir ~/.local/share/gnome-shell/extensions/caffeine@patapon.info/schemas/ set org.gnome.shell.extensions.caffeine user-enabled true
  ```
- Disable Caffeine:
  ```sh
  gsettings --schemadir ~/.local/share/gnome-shell/extensions/caffeine@patapon.info/schemas/ set org.gnome.shell.extensions.caffeine user-enabled false
  ```

`--schemadir` — path to the extension schemas directory. It may be different on your system.