Skip to content

Latest commit

 

History

History
135 lines (89 loc) · 6.59 KB

README.md

File metadata and controls

135 lines (89 loc) · 6.59 KB
Raw

graphic

Boring-Fox is primarily developed with JavaScript and CSS. It offers a sophisticated and intuitive browsing experience for users seeking efficiency and convenience, and who are just a tad bit boring. With its minimal and retro design, Boring-Fox combines boring aesthetics with functionality seamlessly. The theme enhances your Firefox homepage by providing easy access to bookmarks, daily notes, weather widgets, as well as unit and currency conversion within a single, cohesive interface.

stars issues-closed issues-open

Features

Boring-Fox offers a window with tabs-like buttons to organise its functionality. It has a range of helpful features designed to elevate your browsing experience. They are not cluttered and all over the place; rather, they're thoughtfully placed with the intent of keeping your browser distraction-free to boost productivity.


Tab based bookmarks

1
Experience a visually stunning browsing interface with the theme's minimalist design and functional yet elegant features.


Weather Information

2
Check the weather right on your Firefox homepage for convenient access to up-to-date information. To set this up make an account with openweathermap and paste your API key in the scripts/temp.js file.


Useful Tools

3
Convert currencies and units whenever you want. To set up currency conversion make an account with exchangerate-api and paste your API key in the scripts/conv.js file.


Daily Note

4
Stay productive with the integrated daily note feature. Create and manage your tasks right from your start page.



Configuration

The theme can be configured and customized by editing the scripts/tabs.js, scripts/temp.js, scripts/conv.js files. It is pretty self explanatory but it allows you to update/add the following:

  1. API keys
  2. Location information
  3. Bookmarks


Instructions

These instructions provide a step-by-step guide for downloading and applying themes to customize your Firefox. The process is divided into three parts: adding the necessary colors, styling the Firefox elements, and modifying the new tab and homepage with the custom theme.

Colors

  1. Download the Firefox Color add-on. To use the default colors of the theme, click here to add them to Firefox. You can also customize the colors to your liking.

Custom Styling

  1. On the Firefox url bar, enter about:config and set toolkit.legacyUserProfileCustomizations.stylesheets to true to enable CSS customization.

  2. Enter about:profiles on the url bar and open the root directory under deafult-release to go to your profile folder

  3. Copy chrome/ and boring-fox from this repo into the profile folder.

Start Page

  1. Find your Firefox directory corresponding to your operation system:
  • Linux: output of whereis firefox
  • Windows: C:\Program Files\Mozilla Firefox
  • MacOS: /Applications/Firefox.app/Contents/MacOS

  1. Under default/prefs create or update autoconfig.js and paste in the code below:

    //
pref("general.config.filename", "autoconfig.cfg");
pref("general.config.obscure_value", 0);
pref("general.config.sandbox_enabled", false);

  2. Navigate one directory back to defaults/ and create autoconfig.cfg and paste in the code below:

    //  
var {classes:Cc,interfaces:Ci,utils:Cu} = Components;  

try {  
Cu.import("resource:///modules/AboutNewTab.jsm");  
var newTabURL = "file:///PATH_TO_YOUR_START_PAGE.html";  
AboutNewTab.newTabURL = newTabURL;  
} catch(e){Cu.reportError(e);} // report errors in the Browser Console

  3. Change homepage under Firefox settings to 'Custom URLs' and paste in the path.

  4. Restart Firefox.


Fonts

The font files are already present in the theme. If you want to manually incorporate the required fonts into the theme, download Minecraftia, Fira Mono, and Montserrat, then rename the font variables accordingly. Alternatively, you can choose any font by modifying the variables located at the top of the style.css file.


ASCII Art

All ASCII art, except for the graph found on the currency converter tab, is not created by me. Please find the sources for them below:



Other Themes

If you're looking for a more streamlined and functional start page, you can find some themes from the other/ directory. These themes feature a minimalist design and a simple yet elegant look, creating a comfortable browsing experience. Feel free to browse and choose from these themes to personalize your Firefox homepage according to your preferences and style.