Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Manual: Preferences

erikvold edited this page · 26 revisions

This page details Scriptish's options, including those which are not included in the Scriptish Options window.

Main

Boolean extensions.scriptish.enabledSchemes.http

Allows Scriptish to run user scripts against content using the http:/https: scheme.

The default value for extensions.scriptish.enabledSchemes.http is true.


Boolean extensions.scriptish.enabledSchemes.ftp (new in Scriptish!)

Allows Scriptish to run user scripts against content using the ftp: scheme.

The default value for extensions.scriptish.enabledSchemes.ftp is true.


Boolean extensions.scriptish.enabledSchemes.data (new in Scriptish!)

Allows Scriptish to run user scripts against content using the data: scheme.

The default value for extensions.scriptish.enabledSchemes.data is true.


String extensions.scriptish.editor

An absolute path to a text editor. Used when the user wishes to edit a user script.

The default value for extensions.scriptish.editor is an empty string.


Boolean extensions.scriptish.uninstallPreferences

If this preference is set to true any preferences associated with a user script with be erased when the script is uninstalled. If the value is set to false the script's associated preferences will be retained.

The default value for extensions.scriptish.uninstallPreferences is true.


Boolean extensions.scriptish.useDownloadURLForUpdateURL (new in Scriptish!)

If this preference is set to true Scriptish will use the stored download URL (which is not stored if you installed the user script whilst in private mode) for updates when an @updateURL is not provided. If an @updateURL is provided, even if it's a bad URL, the download URL will not be used. If the value is set to false the download URL is never used as the update URL.

The default value for extensions.scriptish.useDownloadURLForUpdateURL is false.


User Interface

Boolean extensions.scriptish.enableNotifications (new in Scriptish!)

If this preference is set to true Scriptish will redirect all Scriptish and user script popup and sliding notifications to the Error Console.

The default value for extensions.scriptish.enableNotifications is false.


Boolean extensions.scriptish.enableCopyDownloadURL (new in Scriptish!)

If this preference is set to true a "Copy Download URL" context menu command will be available for user scripts in the Add-on Manager. If the value is set to false, or if a particular script was installed while in Private Browsing mode, the command will not be available.

The default value for extensions.scriptish.enableCopyDownloadURL is false.


Boolean extensions.scriptish.useDefaultLocale (new in Scriptish!)

If this preference is set to true Scriptish's default locale, English (en-US), will be used throughout Scriptish's user interface regardless of the locale used by the browser. If the preference is set to false Scriptish will use the locale specified by the browser (assuming Scriptish has been translated for that locale).

The default value for extensions.scriptish.useDefaultLocale is false.


Advanced

These preferences are intended for advanced users, and might negatively impact performance and/or security.

Boolean extensions.scriptish.cache.enabled (new in Scriptish!)

If this preference is set to true Scriptish will cache user scripts and their dependencies in memory, resulting in greatly-reduced load times on subsequent uses. If this preference is set to false Scriptish will load user scripts and their dependencies from disk each time they are required.

The default value for extensions.scriptish.cache.enabled is false.


Boolean extensions.scriptish.enabledSchemes.file

Allows Scriptish to run user scripts against content using the file: scheme.

The default value for extensions.scriptish.enabledSchemes.file is false.


Boolean extensions.scriptish.enabledSchemes.chrome (new in Scriptish!)

Allows Scriptish to run user scripts against content using the chrome: scheme.

The default value for extensions.scriptish.enabledSchemes.chrome is false.


Boolean extensions.scriptish.enabledSchemes.unmht

Allows Scriptish to run user scripts against content using the unmht: scheme.

The default value for extensions.scriptish.enabledSchemes.unmht is false.


Boolean extensions.scriptish.enabledSchemes.about

Allows Scriptish to run user scripts against content using the about: scheme.

The default value for extensions.scriptish.enabledSchemes.about is false.

Note: about:blank is always greaseable.


Boolean extensions.scriptish.logChrome

If this preference is set to true Scriptish will send all internal debugging messages to the console.

The default value for extensions.scriptish.logChrome is false.


Boolean extensions.scriptish.logToErrorConsole (new in Scriptish!)

If this preference is set to true Scriptish will send GM_log messages to the Error Console as well as the standard console.

The default value for extensions.scriptish.logToErrorConsole is true.


Boolean extensions.scriptish.update.requireSecured (new in Scriptish!)

If this preference is set to true Scriptish will require user scripts to update using HTTPS. Users might set this to false if the update source does not support HTTPS.

The default value for extensions.scriptish.requireSecured is true.


Boolean extensions.scriptish.update.requireBuiltInCerts (new in Scriptish!)

If this preference is set to true (and secure updates are required) Scriptish will block updates where the update source's SSL certificate can't be validated by the browser.

The default value for extensions.scriptish.requireBuiltInCerts is true.


"Hidden"/Developer

These preferences are not shown in Scriptish Options, and are intended for very advanced users. Use at your own risk.

Boolean extensions.scriptish.enableScriptRefreshing

Each time a page is loaded Scriptish checks the last-modified timestamp to determine whether a script has been modified. If a user script has been modified, its metadata block is parsed to see if the script should be used.

Checking the last-modified timestamp of user scripts is typically very fast, however poor performance is possible on slow or highly-fragmented drives. If you don't plan to modify any of your scripts, or if you are willing to flip this setting whenever you make changes, you will gain some performance benefits by setting extensions.scriptish.enableScriptRefreshing to false.

The default value for extensions.scriptish.enableScriptRefreshing is true.


Boolean extensions.scriptish.optimizingRegexpMerge (new in Scriptish!)

If the preference is set to true Scriptish will attempt to merge internal regular expressions (e.g. user script @includes), potentially resulting in improved performance and resource utilization.

The default value for extensions.scriptish.optimizingRegexpMerge is false.


Boolean extensions.scriptish.config.prettyPrint.enabled (new in Scriptish!)

This preference determines whether Scriptish's config file ("scriptish-config.json") is written in "pretty" fashion, with proper indentation and line returns. Although enabling this preference improves readability, it also increases the file size.

The default value for extensions.scriptish.config.prettyPrint.enabled is false.


Boolean extensions.scriptish.enabledSchemes.* (new in Scriptish!)

Scriptish allows users to add to the list of URI schemes on which user scripts can run.

To add support for a custom scheme, go to about:config and create a Boolean preference with the following format: extensions.scriptish.enabledSchemes.*, replacing * with the scheme.

If the preference is set to true Scriptish will attempt to run user scripts against that scheme's content.

The default value for all schemes is false, with the exception of data, ftp and http (which includes https).

Here are some example preference names:

extensions.scriptish.enabledSchemes.foo // enables matching content using the "foo:" scheme
extensions.scriptish.enabledSchemes.bar // enables matching content using the "foo:" scheme


Boolean extensions.scriptish.blocklist.enabled (new in Scriptish!)

This preference determines whether or not Scriptish will use a blocklist from the location specified in extensions.scriptish.blocklist.url.

The default value for extensions.scriptish.blocklist.enabled is true.


Integer extensions.scriptish.blocklist.interval (new in Scriptish!)

This preference determines how often, in seconds, Scriptish will retrieve a blocklist from the server specified in extensions.scriptish.blocklist.url.

The default value for extensions.scriptish.blocklist.interval is 86400 seconds, which is 24 hours.


String extensions.scriptish.blocklist.url (new in Scriptish!)

This preference specifies the URL from which the blocklist is retrieved.

The default value for extensions.scriptish.blocklist.enabled is https://github.com/scriptish/scriptish/raw/master/blocklist.json.


Integer extensions.scriptish.update.uso.interval (new in Scriptish!)

This preference determines how often, in seconds, Scriptish will attempt to retrieve new user script metadata from userscripts.org, which is parsed to show a script's current rating, reviews, etc.

The default value for extensions.scriptish.blocklist.interval is 86400 seconds, which is 24 hours.

Something went wrong with that request. Please try again.