<h1 align="center" - click me!>
Pywalfox
Introducing Pywalfox, an add-on that themes Firefox and Thunderbird with your Pywal colors using the official Theme API from Mozilla!
With Pywalfox you can:
2.7.X
or 3.X
)Note
Pywalfox is supported on GNU/Linux, MacOS and Windows.
Install from the Arch User Repository (AUR), e.g. Paru: Yay: |
Install from [PyPi](https://pypi.org/project/pywalfox/) with [`pip`](https://github.com/pypa/pip), i.e. `pip install pywalfox` |
pywalfox install
in your terminal.Note
If you have problems: please review the Troubleshooting section below before opening a Github issue.
Run pywalfox update
in your terminal to trigger an update of the browser theme.
This command allows you to integrate Pywalfox into e.g. system theming scripts.
It is functionally equivalent to clicking "Fetch Pywal colors" in the add-on settings GUI (accessible from your toolbar).
The add-on settings GUI comes with extensive customization options divided into the following sections:
The palette in the "Palette" section is used to temporarily customize one or more colors from the Pywal palette.
You can use one of the generated colors, or choose any color from a colorwheel.
> **Warning** > Changes to the palette will be reset when you click "Fetch Pywal colors" and when you run `pywalfox update`. |
If you want your palette customizations to be persistent (unlike the regular palette) you must save your current palette as a *palette template*: 1. Click "Fetch Pywal colors" in the add-on settings GUI or run `pywalfox update` 2. Customize the colors to your liking in the "Palette" section - β *Colors from outside the Pywal palette (i.e. from the colorwheel) cannot be used in a template*. 3. Click "Load from current" in the "Palette template" section below. - β *The colors can also be set directly in the "Palette template" section using Pywal color indices.* 4. Click "Save palette" Your custom palette will now be applied whenever you update the browser theme. |
The theme template assigns colors (from your palette template) to different browser elements. To create a palette template, go through the items in the "Theme template" section and assign a color to each item. The colors are identified by their names as seen in the "Palette template" section. |
Note
Every browser element currently supported by the Theme API can be customized.
There are three different theme modes: "Dark" (π), "Light" (β) and "Auto" (π)οΈ. Selecting "Auto" will automatically switch between the other two modes based on a time interval found in the "General" section of the add-on settings GUI.
Note
The dark and light modes have separate theme and palette templates. You will always modifiy the template for the currently selected mode.
Some browser elements (e.g. the context menus) are not available through the Theme API. Pywalfox includes two custom CSS stylesheets (for Firefox) which apply your theme to some of these browser elements.
Before you enable the custom CSS sheets in the add-on settings GUI you must navigate to about:config and set toolkit.legacyUserProfileCustomizations.stylesheets to true .
|
To uninstall Pywalfox from your system, run
pywalfox uninstall # Removes the manifest from native-messaging-hosts
and then
pip uninstall pywalfox # if you installed with pip
or
paru -R python-pywalfox # if you installed with paru (only Arch Linux)
depending on your chosen installation method.
This section lists some common problems and how to (hopefully) fix them. This troubleshooting guide from Mozilla may be of use if you encounter an error that is not listed here.
pywalfox-native
for now, see #68.You should also
~/.cache/wal/colors
exists and contains the colors generated by Pywal;path
in ~/<native-messaging-hosts-folder>/pywalfox.json
is a valid path.It is a good idea to check the Firefox browser console (Tools > Web developer > Browser console
) for errors.
Common errors include:
ExtensionError: No such native application pywalfox
The manifest is not installed properly. Try installing the manifest manually by following the instructions [here](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/Native_manifests.).
The manifest is located at ` |
stderr output from native app pywalfox: /main.sh: line 3: pywalfox: command not found
Pywalfox assumes that the `pywalfox` executable is in your `PATH`. If you can not run `pywalfox` from the command line (without specifying an absolute path), you must either add the path to the execuatable to your `PATH` variable, or move the executable to a path that already is in your `PATH`. |
Note
The errors in theBrowser Console
are not limited to just Pywalfox!
Do you want to hack on Pywalfox? Start here:
git clone git@github.com/frewacom/pywalfox.git # or use your own fork
cd pywalfox
yarn install # or npm if you do not have yarn installed
yarn run debug
To build the extension into a zip:
yarn run build