Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 3 KB

README.md

File metadata and controls

65 lines (40 loc) · 3 KB
Raw

The Comprehensive Kerbal Archive Network (CKAN)

Click here to open a new CKAN issue

Click here to go to the CKAN wiki

The CKAN Spec can be found here.

What's the CKAN?

The CKAN is a metadata respository and associated tools to allow you to find, install, and manage mods for Kerbal Space Program. It provides strong assurances that mods are installed in the way prescribed by their metadata files, for the correct version of Kerbal Space Program, alongside their dependencies, and without any conflicting mods.

CKAN is great for players and for authors:

  • players can find new content and install it with just a few clicks;
  • modders don't have to worry about misinstall problems or outdated versions;

The CKAN has been inspired by the solid and proven metadata formats from both the Debian project and the CPAN, each of which manages tens of thousands of packages.

What's the status of the CKAN?

The CKAN is currently under active development. We very much welcome contributions, discussions, and especially pull-requests.

The CKAN spec

At the core of the CKAN is the metadata specification, which comes with a corresponding JSON Schema.

This repository includes a JSON schema validator that you can use to validate your files.

CKAN for players

CKAN can download, install and update mods in just a few clicks. See the User guide to get started with CKAN.

CKAN for modders

If you are an author, you might want to provide metadata to ensure that your mod installs correctly. While CKAN can usually figure out most of the metadata by itself, you can add your own file to provide dependencies, recommendations and installation instructions.

Check out the page about adding a mod to the CKAN on the wiki; you might also want to take a look at the CKAN spec and CKAN schema, they can useful when writing your custom CKAN files.

Helping the development

The CKAN client is a C# application that targets Mono 4.0, and therefore it runs natively on all the major platforms

Contributions are welcome:

  • We have a wiki that you are encouraged to use and contribute to. You can find development instructions there.

  • Our issues page lists things that need doing, or are being worked upon. Feel free to add to this!

  • Hop onto the #ckan IRC channel (irc.esper.net) to chat with the team, lend a hand, or ask questions.

  • Ask the authors of your favourite mods to join the CKAN: adding a mod to the CKAN is very easy and will only take a few minutes.