This repository houses the files that power NetLogo's Extension Manager. If you want to make a new extension (or new version of an extension) available to the NetLogo community for download from the Extension Manager, this is the place to do it. All that you need to do is submit a pull request to this repository and wait for us to merge it (which shouldn't take more than a few days, for a properly-formatted pull request).
Please make sure that you are making your pull request to the correct branch! The 6.1 branch is only for extensions that work with NetLogo 6.1.x. If your extension targets a different version of NetLogo, it must go on the appropriate branch for that version of NetLogo. There was no Extension Manager before 6.1 (actually, before 6.0 development builds), so there cannot be any branches here for earlier versions of NetLogo.
Each pull request should have two parts:
- A
.zipfile added to theextensionsdirectory. - A change to the
libraries.conffile
For (1), the .zip file should have a name that follows the format <extension name>-<version number>.zip. The .zip must contain <extension codeName>.jar and any other supporting files that accompany the extension (e.g. other .jar files, .so libraries). Make sure your jar files are in the "root" of the .zip file, not a subfolder. If you're using at least version 5.2.3 of the NetLogo Extension Plugin for sbt, it can generate an appropriate file for you using the packageZip sbt command, including adding extra files such as documentation and example models. If you add the netLogoShortDescription, netLogoLongDescription, and netLogoHomepage settings to your build file, a snippet will be generated as the below when you run packageZip for easy copy/pasting into the libraries.conf file, too.
Regarding (2), if you are adding a new extension, you should make an insertion into libraries.conf, in alphabetical order according to the "name" field (e.g. "Fetch" comes after "Dist" and before "GoGo"). The new entry should follow this format:
{
name: "The human-friendly name of the extension"
codeName: "The name that will be used to refer to this extension in NetLogo code"
shortDescription: "A one-sentence description of what the extension does"
longDescription: """A full description of what the extension does"""
version: "The current version number"
homepage: "The URL that users may go to for documentation about this extension"
downloadURL: "https://raw.githubusercontent.com/NetLogo/NetLogo-Libraries/<branch name>/extensions/<extension codeName>-<version number>.zip"
}
All of these fields are mandatory. All values to the right of the colon should be wrapped in single-quotes (i.e. "value"). longDescription may be wrapped in triple-quotes (i.e. """value""") in order to hold a multiline string. Some editors also like to insert so-called smart-quotes (“”) around text, but our configuration file format requires straight quotes ("").
Make sure your codeName field is unique among extensions in the library already. There are no namespaces or aliasing for NetLogo extensions (yet), so the only way to differentiate them is with unique identifiers when they're added in code. Also, the zip file name must match the codeName.
If you are simply uploading a new version (and not an entirely new extension), the only things that you usually need to change in libraries.conf are the extension's version field and its downloadURL. And, of course, you still need to also include the new .zip file (as mentioned in (1)).
A more detailed explanation of an extension submission workflow using git and GitHub is available in the wiki.
If your extension uses components from the org.nlogo.api namespace to interact with NetLogo models, then the extensions manager will take care of making sure your extension is available only to the appropriate versions of NetLogo.
If you use components outside of that package, you may find that things break for your extension in NetLogo releases where the API version stayed the same. If so you can restrict which specific minimum version of NetLogo your extension supports by adding a minNetLogoVersion field to your extension's entry in the libraries.conf file. For example: minNetLogoVersion: "6.2.0". In this case your extension will be shown in the extensions manager, but it will prompt the user to upgrade NetLogo before they can install and use it.
NetLogo supports Windows, macOS, and Linux operating systems and we prefer all extensions in the library support those platforms as well. If you have libraries or components that cannot work one or two of the operating systems, you can still self-host your extension and distribute it the old fashioned way, by directing users extract the extension alongside a model or into the extensions folder under NetLogo.
If you do not want to use a pull request to add your extension to the library or to have it updated, you can instead email the CCL developer team at [email protected]. You'll need to provide the same information as in the pull request along with the file package, but we'll take care of getting the repository updated.