Pywalfox Save
Dynamic theming of Firefox (and Thunderbird) using your Pywal colors
Pywalfox
🎨 Dynamic theming of Firefox 🦊 (and Thunderbird 🐦) using your Pywal colors
- Tired of Firefox and Thunderbird not respecting your gorgeous Pywal colors like the rest of your system?
- Looking to rack up some karma :arrow_up: on /r/unixporn?
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:
- Customize the colors of almost every UI element
- Easily update the theme using the add-on GUI and/or the command line
- Automatically theme DuckDuckGo :duck: searches in Firefox (optional)
- Have bold text, styled dropdowns and much more (optional)
- Automatically switch between a dark and a light theme based on the time of day
✅ Requirements
- Firefox and/or Thunderbird
- Python (version
2.7.Xor3.X) - Pywal
Note
Pywalfox is supported on GNU/Linux, MacOS and Windows.
👨💻 Installation
- Install the Pywalfox native messaging application using one of two methods below (depending on your operating system).
Arch Linux only (AUR) - click me!
|
Install from the Arch User Repository (AUR), e.g. Paru: Yay: |
- Run
pywalfox installin your terminal. - Get the Pywalfox add-on for
- Restart Firefox and/or Thunderbird.
- Generate Pywal colors with your preferred method, use e.g. this guide.
- Click the Pywalfox icon in the Firefox/Thunderbird UI and click "Fetch Pywal colors". This should apply a theme that uses your Pywal colors to the Firefox/Thunderbird GUI!
Note
If you have problems: please review the Troubleshooting section below before opening a Github issue.
🤔 Usage
🗔 Update the theme through your terminal
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).
🎨 Customization
The add-on settings GUI comes with extensive customization options divided into the following sections:
💧 Palette (click for details)
|
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.
|
📝 Palette template (click for details)
|
If you want your palette customizations to be persistent (unlike the regular palette) you must save your current palette as a palette template:
Your custom palette will now be applied whenever you update the browser theme. |
🗂 ️Theme template (click for details)
|
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.
🌗 Theme modes
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.
🖺 Further theming with the included userChrome.css and userContent.css in Firefox
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.
|
❎ Uninstall
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.
🔧 Troubleshooting
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.
- Librewolf users must use an experimental version of
pywalfox-nativefor now, see #68.
You should also
- check the log in the Debugging section at the bottom of the Pywalfox settings page for any errors;
- verify that
~/.cache/wal/colorsexists and contains the colors generated by Pywal; - verify that
pathin~/<native-messaging-hosts-folder>/pywalfox.jsonis a valid path.
🚫 Common errors in the browser console
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. The manifest is located at After you have copied over the manifest to the correct path, make sure to also update the If it still does not work, you can try to reinstall Firefox, see #14. |
stderr output from native app pywalfox: /main.sh: line 3: pywalfox: command not found
|
Pywalfox assumes that the If you can not run |
Note
The errors in theBrowser Consoleare not limited to just Pywalfox!
🚧 Development setup
Do you want to hack on Pywalfox? Start here:
git clone [email protected]/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
Open Source Agenda Badge
