Userscript Updater Generator

by ΙδεΠÐ

Introduction

Userscript Updater Generator is a GAE application for Greasemonkey scriptwrights to make any userscript on userscripts.org auto-updatable.

Effect

With Userscript Updater Generator, every time you update your userscript on userscripts.org, your users would sooner or later see a messagebox popping up, indicating that a new release is available, which would then be installed. Also, new items would be added to the Greasemonkey menu, enabling users to check for updates at any time.

Usage

In the metadata section of your userscript, add

// @require http://userscript-updater-generator.appspot.com/?id=<userscript id>[&day=<update interval>][&hour=<update interval>]

[// @title <userscript alias>]

[// @version <userscript version>]

[/* @reason
<update notes>
@end */]

and it is done. Parameters and options are explained below.

• id=<userscript id>

  Required. The id of your userscript on userscript.org, whose homepage is http://userscripts.org/scripts/show/<userscript id>.

• day=<update interval>

  Optional. Must be a postive integer. Stand alone or combined with parameter hour to specify the minimal time between two checks for update, which by default is 12 hours.

• hour=<update interval>

  Optional. Must be a postive integer. Stand alone or combined with parameter day to specify the minimal time between two checks for update, which by default is 12 hours.

• @title <userscript alias>

  Optional. Would appear in concerned menu items and prompts replacing the original name of your userscript specified by @name. Should not contain any double quotation mark(").

• @version <userscript version>

  Optional. Should not contain any double quotation mark("). Userscript Updater Generator decides there is a new release when auto-generated @uso:version increases. If meanwhile @version (that you specifies) increases as well, it will be displayed in the update messagebox. Any character other than 0~9 and "." in @version will be neglected when compared.

• @reason <update notes>

  Optional. Anything you write with @reason would show up along with @version in the update messagebox, i.e., if @version is not shown, neither is @reason. I often list fixed bugs and new features here.

Compatibility

Works in Firefox and other browsers that support following features of Greasemonkey:

• @require
• GM_xmlhttpRequest
• GM_getValue
• GM_setValue