Skip to main content

Writing your first UserScript, Template as a beginner's tutorial

UserScripts are fun, useful and often productive. A lot of sites have small improvements you think could add a lot of value. And just because you are not the author of the site, you need not give up. With some basic javascript skills, you could write a userscript, install it on your browser, and make the site behave.

Step 1. Build a script from the template

Start with the following template and modify what you want
// ==UserScript==
//Displayable Name of your script 
// @name           My First Script 
// brief description
// @description    Alerts Hello   
//URI (preferably your own site, so browser can avert naming collisions
// @namespace
// Your name, userscript userid link (optional)   
// @author         sarathonline (****) 
// If you want to license out
// @license        GNU GPL v3 ( 
//(optional) may be used by browsers to display an about link
// @homepage 
//Version Number
// @version        1.0
// Urls process this user script on
// @include        http://*
// Add any library dependencies here, so they are loaded before your script is loaded.
// @require
// @history        1.0 first version
// @history        1.0b first beta version, who knew!!
// ==/UserScript==

//And of course your code!!
window.alert("Hello.. My Extension processed you..");

Thats it, You have your first userscript. By convention user scripts are

Step 2. Host your UserScript on web.

You have by now authored yourscript.user.js file. Now you need to distribute this as an extension. To do that you need to find a home for this file on the web. If can host a js file, on your own website. You could. However, if you do that on, your script is instantly available to a much larger audience. is a free user script hosting site, that also doubles as a market place. also provides an easier way to edit the code online, in case you need to update.

Step 3. Share and Install (coming)

Popular posts from this blog

Being a Vegetarian

I am a Proud Vegetarian. I don't eat Meat or Eggs. People say its hard here in US to be one. I beg to differ. The mere fact that I am hail and healthy these 4 years is a definitive proof. Apart from being bullied and trash talked by The Meat-Eaters, There is really nothing that makes this choice of mine any more than a debatable issue at a lunch or dinner. Other things aside, I am writing this blog having watched a PETA Video. Before you click on the play button, I ask you - If you are a vegetarian : Dont watch it. If you are not : Dare to watch it till the end. If you think going veg is just a fashion, think again . Even if you just want to do it for Fashion . Do it. Go Vegetarian. And Feel better asking the waiter for a Vegetarian Entrée in your next lunch.

Using Equinox CommandProvider to make OSGi console interactive.

After fiddling with the First Bundles that "Hello World"-ed upon Activation, You want to see more interactivity in OSGi. Although Using OSGi for an interactive Command Line Application would be like this one would be, well, a callable over-kill, I am going to start with an example and Expand it in later posts. So, please Welcome CommandProvider. CommandProvider is an EQUINOX specific API for extending the Console. This basic Example illustrates how to get a command from console and do something in java and also gets your feet wet on Service Registry package; import org. eclipse .osgi.framework.console .CommandInterpreter; import org.eclipse.osgi.framework.console.CommandProvider; public class DisplayMessageCommand implements CommandProvider { public void _say(CommandInterpreter ci) { ci.print("You said:" + ci.nextArgument()); } @Override public String getHelp() { return "\tsay - repeats what you say\n"; } }

How to Make a Local (Offline) Repository in Ubuntu / Debian

If you are in a place where you dont have internet (or have a bad one) You want to download .deb packages and install them offline. Each deb file is packaged as a seperate unit but may contain dependencies (recursively). apt-get automagically solves all the dependencies and installs all that are necessary. Manually install deb files one by one resolving each dependency would be tedious. A better approach is to make your own local repository. Before you actually make a repo, You need *all* deb files. You dont practically have to mirror all of the packages from the internet, but enough to resolve all dependencies. Also, You have to make sure, you are getting debs of the correct architecture of your system (i386 etc) # 1. make a dir accessible (atleast by root) sudo mkdir /var/my-local-repo # 2. copy all the deb files to this directory. # 3. make the directory as a sudo dpkg-scanpackages /var/my-local-repo /dev/null > \ /var/my-local-repo/Packages # 4. add the local repo to sour