You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
Stephen Brown II 223792834f Update tweaks repo - 2018-02-14 (#6) 3 years ago
userfirefox Merge branch 'master' of https://github.com/Admicos/userfirefox 3 years ago
.gitignore Initial version 4 years ago
LICENSE Create LICENSE 4 years ago
README.md Add AUR package 4 years ago
config.yml New version! 4 years ago
requirements.txt Basic repo system 4 years ago
tweaks_repo.yml Update tweaks repo - 2018-02-14 (#6) 3 years ago
ufox.py remove accidental debug message 3 years ago

README.md

userFirefox

A CLI program and an API to manage userChrome.css changes

Installation

If you're on Arch Linux, you can get this from the AUR as userfirefox-git. If you're not on Arch, download the requirements below, clone the repo and run ufox.py

Requirements

  • Python 3
  • pyyaml
  • requests
  • pip (so you can download pyyaml and requests)

Usage

Currently, there's only a command line program as I cannot do GUIs, if someone can, I'd be glad to include their pull request!

Preparation

  1. First, assuming you have pip3 (or pip) in your PATH, run pip3 install -r requirements.txt.
  2. Then edit config.yml to select your OS.

Running it

Assuming you have Python 3 installed, you can do the following:

  • python3 ufox.py

or, if you use macOS or Linux and mark the file as an executable, you can do this:

  • ./ufox.py

More help is in the program.

How to install a module

userFirefox comes with the https://github.com/Timvde/UserChrome-Tweaks repo by default, so after you update it by running ./ufox.py repo update, you should be able to search and install any module from there.

How to make a module

Without a repo

  1. Put your module into a seperate css file.
  2. Go to the very first line and add the following JSON: (make sure it's in a comment)
/*{"name": "<module name here>", "author": "<you>", "license": "<...>", "description": "<optional...>"}*/
  1. You're done! Put it in the modules directory (Find out where by running ./ufox.py get-dir) and try listing your modules. It should get your metadata from that line and show it.

With a repo

If you want to create a repo of modules, you shouldn't use the method above. ınstead:

  1. Put your module into a seperate css file and try to find its url. (If you're hosting on GitHub, the URLs work like this: https://raw.githubusercontent.com/:user/:reponame/:branch/(:/path/to/your.mod.css))
  2. Create or edit your repo's YML file. and include the following template inside modules::
  - id: "my-awesome-module"
    name: "My AWESOME Module!"
    description: "Does neat stuff to your browser."
    license: "GPLv3"
    author: "Me"
    url: "..."
  1. Include your repo in the config.yml, update the repos and check if it's listed.