Kref radio

Metadata documents(separated by --- in YAML or separate top-level {} object blocks in JSON), one per server.These will all be checked for new releases and the results merged based on the value of their version properties,resulting in a download property containing an array of multiple download URLs.A JSON Schema is provided for validation purposes.Any .netkan file must conform to this schema to be considered valid.YAML OptionA .netkan file may be in either JSON or YAML format. All examples shown below assume YAML, but the JSON equivalents will work the same way.Note that # is the comment character in YAML, so even if you choose YAML syntax, you still can't omit the quotes around a value that includes #, such as typical values of $kref and $vref:$kref: "#/ckan/spacedock/1234"$vref: "#/ckan/ksp-avc"Internal .ckan filesIf a module's download contains a file with a .ckan extension, this file will be parsed and its contents added to the module's metadata. This can be a convenient way to handle metadata values that can change from one version to the next, such as dependencies.An internal .ckan file may be in either JSON or YAML format.$krefThe $kref field indicates that data should be filled in from an external service provider. The following $krefvalues are understood. Only one $kref field may be present in a .netkan file.#/ckan/spacedock/:sdidIndicates that data should be fetched from SpaceDock, using the :sdid provided. For example: #/ckan/spacedock/269.When used, the following fields will be auto-filled if not already present:namelicenseabstractauthorversiondownloaddownload_sizedownload_hashdownload_content_typeresources.homepageresources.spacedockresources.repositoryresources.bugtrackerresources.x_screenshotksp_versionrelease_daterelease_status#/ckan/curse/:cidThe Curse API that we used to use was sunsetted,

Of the new version field.The following special variables are supported and will be filled in by various metadata aggregated during inflation:${tag} ($kref #/ckan/github only): Replaced with the release tag from GitHub.strict (type: boolean, default: true)Specifies if NetKAN should produce an error if find fails to produce a match against the version field.x_netkan_version_edit can also be a string in which case its value is treated as the value the find field andthe default values for the replace and strict fields are used.An example .netkan excerpt:.+)$ replace: ${version} strict: true">$kref: '#/ckan/jenkins/ find: ^[vV]?(?.+)$ replace: ${version} strict: truex_netkan_overrideThe x_netkan_override field is used to override field values based on the value of the version field.x_netkan_override is an array of objects. Each object may have the following fields:version (type: array of string, version comparison)An array of version comparison strings that are used to match against version. Version comparison strings are ofthe form "[operator]" where operator is one of =, , >, , or >=. If no operator is givenit is equivalent to specifying =. In order for the override to match all the comparisons must be true. Thereforea range may be specified as such: [ ">=1.0", ". A string may also be specified instead of an array inwhich case it is treated as an array with a single element equal to the value of the string.before (type: string, transformation name)The name of a transformation this override to happen directly before.after (type: string, transformation name)The name of a transformation this override to happen directly after.override (type:

Fields will be auto-filled if not already present:nameabstractauthorversionresources.repositoryresources.bugtrackerresources.manualdownloaddownload_sizedownload_hashdownload_content_typerelease_dateAn example .netkan excerpt:$kref: '#/ckan/gitlab/Ailex-/starilex-mk1-iva'An x_netkan_gitlab field must be provided to customize how the metadata is fetched from GitLab. It is an object with the following fields:use_source_archive (type: boolean) (default: false)Specifies that the source ZIP of the release will be used instead of any discrete assets.Note that this must be true! GitLab only offers source ZIP assets, so we can only index mods that use them. If at some point in the future GitLab adds support for non-source assets, we will be able to add support for setting this property to false or omitting it.#/ckan/sourceforge/:repoIndicates that data should be fetched from SourceForge using the :repo provided.For example: '#/ckan/sourceforge/ksreWhen used, the following fields will be auto-filled if not already present:nameresources.homepageresources.repositoryresources.bugtrackerdownloaddownload_sizedownload_hashdownload_content_typerelease_dateAn example .netkan excerpt:$kref: '#/ckan/sourceforge/ksre'#/ckan/jenkins/:joburlIndicates that data should be fetched from a Jenkins CI server using the :joburl provided. Forexample: #/ckan/jenkins/ following fields will be auto-filled if not already present:versiondownloaddownload_sizedownload_hashdownload_content_typeresources.cirelease_dateAn x_netkan_jenkins field may be provided to customize how the metadata is fetched from the Jenkins server. It isan object with the following fields:build (type: string, enumerated) (default: "stable")Specifies the type of build to use. Possible values are "any", "completed", "failed", "stable","successful", "unstable", or "unsuccessful". Many of these values do not make sense to use in practice butare provided for completeness.asset_match (type: string, regex) (default: \.zip$)Specifies a regex which selects which artifact to use by filename (case-insensitively). Not having exactly onematching asset is an error.use_filename_version (type: boolean, default: false)Specifies if the filename of the matched artifact

Should be used as the value of the version property. Combinedwith the x_netkan_version_edit property this allows the version to be extracted from the filename itself.Otherwise the expectation is that the archive will have an AVC .version file which will be used to generate theversion value.If any options are not present their default values are used.An example .netkan excerpt:$kref: '#/ckan/jenkins/ build: stable asset_match: \.zip$ use_filename_version: false#/ckan/http/:urlIndicates that data should be fetched from an HTTP server, using the :url provided. For example:$kref: '#/ckan/http/ used, the following fields will be auto-filled if not already present:downloaddownload_sizedownload_hashdownload_content_typeThis method depends on the existence of an AVC .version file in the download fileto determine:version#/ckan/ksp-avc/:urlIndicates that data should be fetched from a KSP-AVC .version file at the :url provided. The file should be in the KSP-AVC JSON file format, see the KSP-AVC spec. The DOWNLOAD property of the file is used to find the download. For example: #/ckan/ksp-avc/ used, the following fields will be auto-filled if not already present:namedownloaddownload_sizedownload_hashdownload_content_typeresources.repositoryversionksp_versionksp_version_minksp_version_max#/ckan/netkan/:urlIndicates that data should be fetched from another .netkan file hosted remotely.For example: #/ckan/netkan/ remote .netkan file is downloaded and used as if it were the original. .netkan files which contain such areference are known as recursive netkans or metanetkans. They are primarily used so that mod authors can provideauthoritative metadata.A metanetkan may be in either JSON or YAML format.The following conditions apply:A metanekan may not reference another metanetkan, otherwise an error is produced.Any fields specified in the metanetkan will override any fields in the target netkan file.When used, the

Following fields will be auto-filled if not already present:resources.metanetkanAn example .netkan including all required fields for a valid metanetkan:spec_version: 1,identifier: AwesomeMod$kref: '#/ckan/netkan/ $vref field indicates that version data should be filled in from an external service provider. Only one$vref field may be present in a document.#/ckan/ksp-avc[[/path]/avcfilename.version]If present, a $vref symbol of #/ckan/ksp-avc states that versioninformation should be retrieved from an embedded KSP-AVC .version file in thefile downloaded by the download field. The following conditions apply:Only .version files that would be installed for this mod are considered. (In theory. Transformer ordering may cause files outside the installed folders being considered)It is an error if more than one .version file would be considered.It is an error if the .version file does not validate according tothe KSP-AVC spec.The KSP_VERSION field for the .version file will be ignored if theKSP_VERSION_MIN and KSP_VERSION_MAX fields are set.Netkan will first attempt to use anything after ksp-avc as a literalpath within the zip file, and if that fails, will use the string as aregexp to search for a matching file to use.When used, the following fields are auto-generated:ksp_versionksp_version_minksp_version_maxresources.remote-avc (if the URL property is present in the version file)Version information is generated in such a way as to ensure maximum compatibility. For example if the .version filespecifies that the mod is compatible with KSP version 1.0.2 but the existing version specifies 1.0.5 then theversion information generated will give a ksp_version_min of 1.0.2 and a ksp_version_max of 1.0.5.If (and only if) no mod version number has been identified (eg a

So Curse is no longer supported.Expand to see the old infoIndicates that data should be fetched from Curse, using the :cid provided. The :cid may be a number for modules indexed prior to March 2018, or the name from the Curse URL otherwise. For example: #/ckan/curse/220221 or #/ckan/curse/photonsail.When used, the following fields will be auto-filled if not already present:namelicenseauthorversiondownloaddownload_sizedownload_hashdownload_content_typeresources.curseksp_version#/ckan/github/:user/:repo[(/asset_match/:filter_regexp)|(/version_from_asset/:version_regexp)]Indicates that data should be fetched from GitHub, using the :user and :repo provided.For example: #/ckan/github/pjf/DogeCoinFlag.When used, the following fields will be auto-filled if not already present:namelicense (v1.26)abstractauthorversiondownloaddownload_sizedownload_hashdownload_content_typeresources.repositoryresources.bugtrackerrelease_daterelease_statusOptionally, one of asset_match with :filter_regexp or version_from_asset with :version_regexp may be provided:asset_match with filter_regexp: A string which is treated as case-sensitive C# regular expressions which are matched against thename of the released artifact.version_from_asset with :version_regexp: A string which is treated as case-sensitive C# regular expressions which are matchedagainst the names of all release artifacts. Every matching artifact will result in a separate metadata output. The :version_regexpmust have a named capturing group version, which is used as the version of each asset's module.An example .netkan excerpt:.+).zip$'">$kref: '#/ckan/github/pjf/DogeCoinFlag/version_from_asset/^DogeCoinFlag-(?.+).zip$'An x_netkan_github field may be provided to customize how the metadata is fetched from GitHub. It is an object with the following fields:use_source_archive (type: boolean) (default: false)Specifies that the source ZIP of the repository itself will be used instead of any assets in the release.prereleases (type: boolean) (default: null)Skip prereleases if false, skip regular releases if true, use both if absent.#/ckan/gitlab/:user/:repoIndicates that data should be fetched from GitLab, using the :user and :repo provided.For example: #/ckan/gitlab/Ailex-/starilex-mk1-iva.When used, the following