| Name | unvtray JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | |
| Summary | Unvanquished Tray |
| upload_time | 2023-04-16 05:26:49 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.3 |
| license | GPL-3.0-or-later |
| keywords |
unvanquished
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Unvanquished Tray
[](https://pypi.org/project/unvtray/)
[](https://aur.archlinux.org/packages/unvtray)
[](https://github.com/psf/black)
<p align="center">
<img src="package/icons/128x128/unvtray.png" />
</p>
A minimalistic [Unvanquished](https://unvanquished.net/) 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
```shell
pip install --user unvtray
```
#### on Arch Linux
```shell
$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](https://wiki.archlinux.org/title/autostarting#On_Xorg_startup) 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](https://github.com/Unvanquished/updater/releases/) and the [official
flatpak](https://flathub.org/apps/details/net.unvanquished.Unvanquished) (all
platforms) as well as the [AUR
package](https://aur.archlinux.org/packages/unvanquished) (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](LICENSE.txt).
- The [included font](unvtray/assets/FreeMonoBold.otf) is unmodified from the
[GNU FreeFont family](https://www.gnu.org/software/freefont/) and is licensed
under [GPLv3 or later](LICENSE.txt).
- The original [Unvanquished icon](unvtray/assets/unvanquished.png) and the
derived [unvtray icons](package/icons) are licensed under [CC BY-SA
2.5](https://creativecommons.org/licenses/by-sa/2.5/); you may attribute all
to "Unvanquished Development."
Raw data
{
"_id": null,
"home_page": "",
"name": "unvtray",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.3",
"maintainer_email": "",
"keywords": "unvanquished",
"author": "",
"author_email": "Maximilian Stahlberg <viech@unvanquished.net>",
"download_url": "https://files.pythonhosted.org/packages/e9/f1/4b7055f9ef2811dab01bf28c53fd732b763a15fc314b5aa4a27229201a2f/unvtray-0.2.1.tar.gz",
"platform": null,
"description": "# Unvanquished Tray\n\n[](https://pypi.org/project/unvtray/)\n[](https://aur.archlinux.org/packages/unvtray)\n[](https://github.com/psf/black)\n\n<p align=\"center\">\n <img src=\"package/icons/128x128/unvtray.png\" />\n</p>\n\nA minimalistic [Unvanquished](https://unvanquished.net/) server browser that\nruns in your system tray. The icon shows the player count of the most populated\nserver. A left click on the icon connects to this server (on supported\nplatforms) while a right click opens a server list in a context menu. Clicking\non a server will launch the game and connect to it.\n\n## Installation\n\n#### via pip\n\n```shell\npip install --user unvtray\n```\n\n#### on Arch Linux\n\n```shell\n$YOUR_AUR_HELPER -S unvtray\n```\n\n#### from source\n\n```\ngit clone https://github.com/Unvanquished/unvanquished-tray-browser.git\ncd unvanquished-tray-browser\npython -m pip install --user build # possibly already installed\npython -m build\npython -m pip install --user dist/*.whl\n```\n\n## Running\n\nTo run Unvanquished Tray in the foreground, execute:\n\n```\nunvtray\n```\n\nor, if the above does not work (e.g. when `~/.local/bin` is not in your `PATH`\non Unix-like platforms):\n\n```\npython -m unvtray\n```\n\n### Autostart\n\n#### on GNU/Linux\n\nTo either of the above commands, append `&` as necessary (for running in the\nbackground) and add it to your display server startup file (e.g. `~/.xinitrc`\nif starting Xorg manually or `~/.xprofile` if using a display manager), or to\nyour desktop environment or window manager configuration (e.g. `.i3/config` for\ni3). See the [Arch Linux\nwiki](https://wiki.archlinux.org/title/autostarting#On_Xorg_startup) for more\noptions.\n\n## Troubleshooting\n\n### The game does not launch when selecting a server from the context menu\n\n#### on GNU/Linux\n\nMake sure `xdg-utils` are installed and that your distribution of Unvanquished\ncomes with a `.desktop` file that describes the `unv://` URI scheme. For\nexample, the [official\nupdater](https://github.com/Unvanquished/updater/releases/) and the [official\nflatpak](https://flathub.org/apps/details/net.unvanquished.Unvanquished) (all\nplatforms) as well as the [AUR\npackage](https://aur.archlinux.org/packages/unvanquished) (Arch Linux) should\ninstall a `.desktop` file alongside the game.\n\n#### on other platforms\n\nLaunching the game may not be implemented properly for other platforms; please\ncomment in Unvanquished/unvanquished-tray-browser#2 if you are affected.\n\n### Launching the game on a different monitor than the tray icon is on\n\n#### using i3\n\nAdd the following to your configuration:\n\n```\nfor_window [class=\"daemon\"] move container to output YOUR_MAIN_MONITOR\n```\n\nAdditionally, for i3 it is recommended to disable _fullscreen_ and enable\n_borderless window_ in the game's settings and to add the following to your\nconfiguration:\n\n```\nfor_window [class=\"daemon\"] fullscreen\n```\n\nA similar solution may improve fullscreen behavior also with other tiling\nwindow managers.\n\n## Code and asset licenses\n\n- The source code is licensed under [GPLv3 or later](LICENSE.txt).\n\n- The [included font](unvtray/assets/FreeMonoBold.otf) is unmodified from the\n [GNU FreeFont family](https://www.gnu.org/software/freefont/) and is licensed\n under [GPLv3 or later](LICENSE.txt).\n\n- The original [Unvanquished icon](unvtray/assets/unvanquished.png) and the\n derived [unvtray icons](package/icons) are licensed under [CC BY-SA\n 2.5](https://creativecommons.org/licenses/by-sa/2.5/); you may attribute all\n to \"Unvanquished Development.\"\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Unvanquished Tray",
"version": "0.2.1",
"split_keywords": [
"unvanquished"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1108ea8415bd7b8bbc36d8079811b65a79aa0df75d54db18c7263543c1b7a95",
"md5": "5538846e531fc3e447c1d61f66c0181c",
"sha256": "69c6593c758053751ee92efa10c5684b221e4c4a749ca7b133aceccb926ce549"
},
"downloads": -1,
"filename": "unvtray-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5538846e531fc3e447c1d61f66c0181c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.3",
"size": 374002,
"upload_time": "2023-04-16T05:26:47",
"upload_time_iso_8601": "2023-04-16T05:26:47.806283Z",
"url": "https://files.pythonhosted.org/packages/a1/10/8ea8415bd7b8bbc36d8079811b65a79aa0df75d54db18c7263543c1b7a95/unvtray-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9f14b7055f9ef2811dab01bf28c53fd732b763a15fc314b5aa4a27229201a2f",
"md5": "0a44d4e6342ce2c207703c18af34336b",
"sha256": "6ae32e04908239dee4100f6c7093f576708c3ad6f055d12a1aded72cd0f91601"
},
"downloads": -1,
"filename": "unvtray-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "0a44d4e6342ce2c207703c18af34336b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.3",
"size": 626176,
"upload_time": "2023-04-16T05:26:49",
"upload_time_iso_8601": "2023-04-16T05:26:49.266183Z",
"url": "https://files.pythonhosted.org/packages/e9/f1/4b7055f9ef2811dab01bf28c53fd732b763a15fc314b5aa4a27229201a2f/unvtray-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-16 05:26:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "unvtray"
}
