demus/gnome-shell-extensions-gravatar
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation to reflect Libravatar is supported.

Browse Source
This commit is contained in:
Daniel Sheeler
2024-12-30 20:09:19 -06:00
parent 0a233ea194
commit 3034613570
2 changed files with 38 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+37 -20
View File
@@ -2,7 +2,7 @@
<a href="https://extensions.gnome.org/extension/6922/gravatar/"><img src="https://img.shields.io/badge/Download-extensions.gnome.org-4a86cf.svg?logo=gnome&style=plastic" /></a>
A GNOME Shell extension to synchronize your user icon with Gravatar.
A GNOME Shell extension to synchronize your user icon with an avatar service, one of Gravatar or Libravatar.
## Prerequisites
* `gnome-shell`
@@ -35,18 +35,30 @@ make
make uninstall
```
## Usage
#### Triggering a Download from Gravatar
Every time the extension is enabled (for example at login), the extension downloads your user icon from Gravatar. When the `email` setting is changed, the extension also performs a download.
### Triggering a Download from Avatar Service
The extension downloads your avatar in various circumstances.
The extension provides a third option to trigger a download which is by pressing a user-defined keybinding. This enables the user to, for example, update their user icon after an update on Gravatar. The prefs widget provides an interface to change the keybinding. The default is `<Ctrl><Super>g`.
#### Starting the Extension
Every time the extension is enabled (for example at login), the extension downloads your user icon from the avatar service.
## Settings
Settings can be configured from the `gnome-shell-extension-prefs` tool or from the command line via `dconf`. Settings marked with `*` can only be changed by using `dconf`.
#### Settings Changes
When either the `email` or the `service` setting changes, the extension also performs a download.
#### Debug Mode: _(default: `false`)_
#### Keyboard Shortcut
The extension provides another option to trigger a download: by pressing a user-defined keybinding. This enables the user to, for example, update their user icon after an update on the avatar service. The prefs widget provides an interface to change the keybinding. The default is `<Ctrl><Super>g`.
### Settings
Settings can be configured from the preferences gui:
```bash
dconf write /org/gnome/shell/extensions/gravatar/debug "'<BOOL>'"
gnome-extensions prefs gravatar@dsheeler.net
```
or from the command line via `dconf`. Settings marked with `*` can only be changed by using `dconf`.
#### Service: _(default: `gravatar`)_
```bash
dconf write /org/gnome/shell/extensions/gravatar/service "'<SERVICE_NAME>'"
```
Where `<SERVICE_NAME>` is one of `gravatar` or `libravatar`.
#### Email Address: _(default: `null`)_
```bash
@@ -58,33 +70,38 @@ dconf write /org/gnome/shell/extensions/gravatar/email "'<EMAIL>'"
dconf write /org/gnome/shell/extensions/gravatar/gravatar-ondemand-keybinding '["<KEYBINDING_STRING>"]'
```
#### *Icon Size: _(default: `192`)_
* **1 - 2048 pixel square** _(See: [gravatar.com](https://en.gravatar.com/site/implement/images/#size))_
```bash
dconf write /org/gnome/shell/extensions/gravatar/icon-size <SIZE>
```
#### Desktop Notification on Update: _(default: `false`)_
```bash
dconf write /org/gnome/shell/extensions/gravatar/notifications "'<BOOL>'"
```
#### Debug Mode: _(default: `false`)_
```bash
dconf write /org/gnome/shell/extensions/gravatar/debug "'<BOOL>'"
```
#### * Icon Size: _(default: `192`)_
**1 - 2048 pixel square** _(See: [gravatar.com](https://en.gravatar.com/site/implement/images/#size))_
```bash
dconf write /org/gnome/shell/extensions/gravatar/icon-size <SIZE>
```
## Bug Reporting
Bugs should be reported via the [GitHub Issue Tracker](https://github.com/dsheeler/gnome-shell-extensions-gravatar/issues)
#### Logs
##### Extension
### Logs
#### Extension
```bash
journalctl /usr/bin/gnome-shell -f
```
##### Prefs Widget
#### Prefs Widget
```bash
gnome-shell-extension-prefs gravatar@gnome-shell-extensions.dsheeler.net
journalctl /usr/bin/gjs -f
```
## Credits
This project is a fork of Daniel Demus' fork of the original Gravatar extension by Jon Rouleau.
metadata.json
+1 -1
View File
@@ -6,7 +6,7 @@
},
"uuid": "gravatar@dsheeler.net",
"name": "Gravatar",
"description": "Synchronize GNOME Shell user icon with Gravatar.\nThis extension is not affiliated, funded, or in any way associated with Automattic and Gravatar.",
"description": "Synchronize GNOME Shell user icon with an avatar service, one of Gravatar or Libravatar.\nThis extension is not affiliated, funded, or in any way associated with Automattic or Gravatar.",
"url": "https://github.com/dsheeler/gnome-shell-extensions-gravatar",
"settings-schema": "org.gnome.shell.extensions.gravatar",
"gettext-domain": "gnome-shell-extensions-gravatar",