KSP-CKAN

Metadata spec for CKAN meta files

Type object
File match *.ckan
Schema URL https://catalog.lintel.tools/schemas/schemastore/ksp-ckan/latest.json
Source https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for validating CKAN meta files

Properties

spec_version integer | string required

Version of the CKAN spec this document uses

name string required

Human readable name of the mod

identifier string required

Unique identifier for this mod.

pattern=^[A-Za-z0-9][A-Za-z0-9-]+$
abstract string required

Short description of the mod

author string | string[] required

Author, or list of authors

license license | license[] required

A license, or array of licenses

version string required

A version string

kind enum

Package type, defaults to package

Values: "package" "metapackage" "dlc"
description string

Longer description of the mod

comment string

Free-form comment. Not displayed to users

download string | string[]

URL where mod can be downloaded by tools

download_size integer

The size of the download in bytes

download_hash object

A object of hashes of the downloaded file

2 nested properties
sha1 string

SHA1 hash of the file

sha256 string

SHA256 hash of the file

download_content_type string

The content type of the download

install_size integer

The size of the installed files

release_status enum

Optional release status

Values: "stable" "testing" "development"
ksp_version string

A game version

pattern=^(any|[0-9]+(\.[0-9]+(\.[0-9]+)?)?)$
ksp_version_min string

A game version

pattern=^(any|[0-9]+(\.[0-9]+(\.[0-9]+)?)?)$
ksp_version_max string

A game version

pattern=^(any|[0-9]+(\.[0-9]+(\.[0-9]+)?)?)$
ksp_version_strict boolean

Optional enforcement of strict version checks (defaults to false)

tags string[]

A series of descriptive keywords to provide quick filtering and organization

localizations string[]

A list of locale strings for which this mod includes localizations

uniqueItems=true
depends object | object[]

A relationship to a list of mods

recommends object | object[]

A relationship to a list of mods

suggests object | object[]

A relationship to a list of mods

supports object | object[]

A relationship to a list of mods

conflicts object | object[]

A relationship to a list of mods

provides identifier[]

A list of virtual packages this mod provides

uniqueItems=true
replaced_by object

Optional pointer to mod that should be selected instead and treated as an update to this mod

3 nested properties
name string required

Unique identifier for this mod.

pattern=^[A-Za-z0-9][A-Za-z0-9-]+$
version string

A version string

min_version string

A version string

resources object

Additional resources

16 nested properties
homepage string

Mod homepage

format=uri
bugtracker string

Mod bugtracker

format=uri
discussions string

Mod discussions

format=uri
license string

Mod license

format=uri
repository string

Mod repository

format=uri
ci string

Continuous Integration

format=uri
spacedock string

Project on SpaceDock

format=uri
curse string

Project on Curse

format=uri
manual string

Mod's manual

format=uri
metanetkan string

Mod's remote hosted netkan

format=uri
remote-avc string

Mod's remote hosted version file

format=uri
remote-swinfo string

Mod's remote hosted swinfo file

format=uri
store string

Purchase DLC here

format=uri
steamstore string

Purchase DLC on Steam here

format=uri
gogstore string

Purchase DLC on GOG here

format=uri
epicstore string

Purchase DLC on Epic Games Store here

format=uri
install object[]

List of install directives

release_date string

Optional timestamp when the described version of the mod was released

format=date-time

One of

1. variant
2. object object
kind enum required
Values: "metapackage" "dlc"

Definitions

identifier string

Unique identifier for this mod.

version string

A version string

ksp_version string

A game version

relationship object | object[]

A relationship to a list of mods

install_to enum | string | string | string | string | enum | string | string

Where file should be installed to. As of v1.2, GameData may take a path

license enum

A license.

redistributable_license enum

A license that grants us the right to redistribute.

licenses license | license[]

A license, or array of licenses

one_or_more_strings string | string[]

One or more strings