unvtray 0.2.0

Unvanquished Tray

Unvanquished Tray

A minimalistic Unvanquished server browser that runs in your system tray. The icon shows the player count of the most populated server. A left click on the icon connects to this server (on supported platforms) while a right click opens a server list in a context menu. Clicking on a server will launch the game and connect to it.

Installation

via pip

pip install --user unvtray

on Arch Linux

$YOUR_AUR_HELPER -S unvtray

from source

git clone https://github.com/Unvanquished/unvanquished-tray-browser.git
cd unvanquished-tray-browser
python -m pip install --user build  # possibly already installed
python -m build
python -m pip install --user dist/*.whl

Running

To run Unvanquished Tray in the foreground, execute:

unvtray

or, if the above does not work (e.g. when ~/.local/bin is not in your PATH on Unix-like platforms):

python -m unvtray

Autostart

on GNU/Linux

To either of the above commands, append & as necessary (for running in the background) and add it to your display server startup file (e.g. ~/.xinitrc if starting Xorg manually or ~/.xprofile if using a display manager), or to your desktop environment or window manager configuration (e.g. .i3/config for i3). See the Arch Linux wiki for more options.

Troubleshooting

The game does not launch when selecting a server from the context menu

on GNU/Linux

Make sure xdg-utils are installed and that your distribution of Unvanquished comes with a .desktop file that describes the unv:// URI scheme. For example, the official updater and the official flatpak (all platforms) as well as the AUR package (Arch Linux) should install a .desktop file alongside the game.

on other platforms

Launching the game may not be implemented properly for other platforms; please comment in Unvanquished/unvanquished-tray-browser#2 if you are affected.

Launching the game on a different monitor than the tray icon is on

using i3

Add the following to your configuration:

for_window [class="daemon"] move container to output YOUR_MAIN_MONITOR

Additionally, for i3 it is recommended to disable fullscreen and enable borderless window in the game's settings and to add the following to your configuration:

for_window [class="daemon"] fullscreen

A similar solution may improve fullscreen behavior also with other tiling window managers.

Code and asset licenses

• The source code is licensed under GPLv3 or later.

• The included font is unmodified from the GNU FreeFont family and is licensed under GPLv3 or later.

• The original Unvanquished icon and the derived unvtray icons are licensed under CC BY-SA 2.5; you may attribute all to "Unvanquished Development."