See Using Quarks for an introduction to the Quarks package system.
Show the interface for managing quarks
QuarksGui
Will execute the hooks \preInstall and \postInstall if defined.
| name |
Name of a quark that is listed in the directory, or the url of a git repository or the path (absolute or relative to current working directory) of a folder to install. |
| refspec |
Optional git refspec. By default it will install the latest version. Optionally you can specify a tag: "tags/1.0.0" A sha commit: "15e6ea822a18d06b286c3f10918f83b8d797d939" "HEAD" nil (default) |
this
Install a quark Usually you use *install with a name, url or path.
| quark |
this
Will execute the hooks \preUninstall and \postUninstall if defined.
| name |
Name (String) of a quark that is listed in the directory, or url of a git repository or the path (absolute or relative to current working directory) of a folder to uninstall. |
this
Uninstall all Quarks, by setting LanguageConfig.installedPaths to empty.
this
| path |
In addition to the default downloaded-quarks add folders that contain quarks to offer on the menu for installation. These may be private quarks, cloned working copies or folders where you have manually downloaded quarks. NOTE: The argument should be a path to a directory containing quark directories. It should not be an isolated quark directory by itself. Users are discouraged from scattering quark directories in isolated locations.
|
this
All Quarks whether downloaded or installed or not. Includes any Quarks that were installed by path.
Array of Quarks
All currently installed Quarks
Array of Quarks
| name |
Name, url or path |
Boolean
Saves the currently installed quarks to a file as a list of urls and refspecs.
| path |
path of file to save to |
this
Clear all installed quarks and load a list from a file. Relative paths in the file are resolved relative to the file itself. eg. ./classes/my-quark Unix style tildes (~/supercollider/quarks/my-quark) resolve to the user's home directory, even on Windows. By convention the file is called quarks.txt
| path |
path of file to load. May contain ~ or relative paths (root is current working directory) |
| done |
function to be evaluated when loading is done |
this
Runs 'git pull' on the checked out copy of the quark. The gui provides a more robust way to do updates. Will execute the hooks \preUpdate and \postUpdate if defined.
| name |
name of quark |
this
Open the downloaded-quarks folder
this
Path of the downloaded-quarks folder where Quarks are cloned to before installing.
path
Scan through all downloaded, git-repository quarks and download any updates. This uses git fetch; updates will be retrieved but not applied to the working copy (i.e., no visible change to the environment). After this, repositories will be aware of new branches and version tags.
This will take several seconds per quark. The SC interpreter will be unresponsive during each individual quark update.
| done |
(Optional) A function to evaluate after all quarks have been checked. |
| quarkAction |
(Optional) A function to evaluate before checking each individual quark. This function receives the Quark object as an argument, so you can use it, for instance, to print the quark name and have a running status update in the post window: |
Private. Fetches the directory listing into downloaded-quarks/quarks If a local copy already exists and it is not a git repo then this is used instead.
| force |
(Boolean) Force fetch. By default it is fetched once per session. Recompile the class library to fetch it again, or call Quarks.fetchDirectory(true) to force it. |
this
Returns the Classes that are defined in the Quark or package.
| packageName |
name of quark or any folder in Extensions or Common. "Common" is a package that refers to the standard library. |
Array of Classes
Adds the path to LanguageConfig.installedPaths. private
| path |
this
Removes a path from LanguageConfig.installedPaths. private
| path |
this
private
this
private
| name |
this
The URL of the directory.txt file
this
The community contributed Quarks directory. Fetched from the directoryUrl and parsed.
Dictionary[name->url@refspec]
Helper method to resolve paths to absolute paths.
| path | |
| relativeTo |
optional root for resolving relative paths |
absolute path
private
| name |
quark name, path or git url. |
absolute path where the Quark is
private. gets or creates a Quark by name, storing it in a central cache.
| name |
Quark