File: README.md

package info (click to toggle)
gnome-shell-extension-top-icons-plus 27-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 2,948 kB
  • sloc: xml: 40; makefile: 30
file content (113 lines) | stat: -rw-r--r-- 6,355 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# WARNING

> As stated in issue [#91](https://github.com/phocean/TopIcons-plus/issues/91), I have stopped maintaining this project actively.

The Gnome project chose to drop status icons and any kind of legacy tray, making the project useless on the long term and difficult to maintain due to bugs or lack of features that are out of its scope.

In particular, no wayland support can be achieved.

Open such issues not here but to the Gnome project.

Meanwhile, I encourage you to migrate to libappindicator and its [extension](https://github.com/ubuntu/gnome-shell-extension-appindicator), which is supported by most applications nowadays.

> The code here should still work. I will happily merge good pull requests and package releases when necessary.

# TopIcons Plus

## Introduction

Many applications, such as chat clients, downloaders, and some media players, are meant to run long-term in the background even after you close their window. These applications remain accessible by adding an icon to the GNOME Shell Legacy Tray. However, the Legacy Tray is hidden until you push your mouse into the lower-left of the screen and click on the small tab that appears. TopIcons Plus brings all icons back to the top panel, so that it's easier to keep track of apps running in the backround.

Take a look at TopIcons Plus in action. Before installing (standard GNOME Legacy Tray in the bottom left):

![Before](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/before.png)

After installing (icons have moved to the top right):

![After](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/after.png)

You also get some options to control the look and feel. You can leave the icons in full color:

![Tray](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/tray1.png)

Or dynamically convert them to grayscale:

![Tray](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/tray2.png)

Enjoy!


## Installation

TopIcons Plus requires GNOME Shell 3.16 or newer.

### Get it from the extensions website

Point your web browser to the TopIcons Plus page on the [GNOME Shell Extensions website](https://extensions.gnome.org/extension/1031/topicons/). GNOME uses a browser addon, which should have come with your Linux distro, to provide a web interface to the extensions manager on your system. Currently, only Firefox is supported, but support for other browsers is in the works. The first time you visit this website, you should be prompted to enable this browser addon -- [see the FAQs](https://extensions.gnome.org/about/#no-detection) if you have any issues, then go back to the TopIcons Plus page.

All you have to do next is click the switch on the extension page from off to on.

![Toggle Switch](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/toggle-switch.png)

There will be a GNOME Shell pop-up asking you to confirm that you want to download and install this extension. After that, it may take a moment for the extension to set itself up, but *you* are done. Icons will move from the legacy tray to the top panel on their own.

If you want to tweak the icons' look and feel, you can go to the web page for [Installed Extensions](https://extensions.gnome.org/local/). Click on the wrench-and-screwdriver button to open the TopIcons Plus settings, or click the red X button to uninstall.

![Installed Extensions web page](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/installed-extension-web-page.png)

If you install extensions from the GNOME website like this, be sure to revisit this page occasionally to check for updates (look for a green update button).

### Or compile it yourself

Pre-Requisite: You need the *make* utility :

```bash
# Debian, Ubuntu
sudo apt-get install make
# Red Hat, Fedora
sudo dnf install make
```

Download the code to any folder, using git:

```bash
git clone https://github.com/phocean/TopIcons-plus.git
```

Go into the TopIcons Plus project directory and execute the installation script.

```bash
cd TopIcons-plus
make install
```

This will compile the glib schemas and copy all the necessary files to the GNOME Shell extensions directory for your own user account (so you don't need admin privileges to run `make`). By default, TopIcons Plus will live in the directory `~/.local/share/gnome-shell/extensions/TopIcons@phocean.net/`.

If you want to install the extension so that it will be usable system-wide, you'll have to change the `INSTALL_PATH` variable, and run as root.

```bash
sudo make install INSTALL_PATH=/usr/share/gnome-shell/extensions
```

Now, reload GNOME Shell. You can either hit <kbd>Alt</kbd>+<kbd>F2</kbd>, type `r`, and hit enter --- or login/logout.

![Reload Gnome](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/reload.png)

Finally, launch the *gnome-tweak-tool* utility to manage extensions. There, you can enable *TopIcons Plus* and then tweak its look and feel.

![Enable TopIcons](https://raw.githubusercontent.com/phocean/TopIcons-plus/master/screenshots/tweak.png)

## Known issues

GNOME Shell by default now runs on top of [Wayland](https://wayland.freedesktop.org/) by default, as of release 3.22. However, there are still some remaining bugs, as not all applications, particularly non-GNOME apps, have adapted to Wayland yet. These really have nothing to do with TopIcons Plus itself, but we do have a [GitHub Issue to keep track of workarounds](https://github.com/phocean/TopIcons-plus/issues/47) while we wait for the different app developers to catch up with the new graphics backend.

## Credits

TopIcons Plus is a fork of TopIcons. Many thanks go to Adel Gadllah for making the original extension, and also to Mjnaderi for the [Toptray fork](https://github.com/mjnaderi/TopTray).

Also, thanks to all contributors (code and issues), and especially to:

- [nevesnunes](https://github.com/nevesnunes) for the very nice code improvements he brought up ;
- [terrycloth](https://github.com/terrycloth) for his contributions to the installation script and documentation to make it ready for the Fedora packaging ;
- [huttli](https://github.com/huttli) for packaging various forks and changes, and submitting them upstream ;
- and many other good guys that pushed translations and bug fixes !