Skip to content

Add support for a new experiment

Arne Peirs edited this page Aug 11, 2020 · 12 revisions

This is a bit more difficult and time consuming than simply adding a new science report. However, it is a great way to round-out the functionality of science instruments added by mods.

Before you start you will need to know the experiment ID (eID for short) of the instrument you'd like to add. This can usually be found by searching for experimentID = in the .cfg file included with the part that performs the experiment. There are a few steps that you will need to follow in order to sucessfully add your experiment:

  • Create a new file called "eID".cfg using the eID of your experiment

  • Insert the following block of text into that file and replace the "eID" with your eID, and "Insert a list..." with your situation/biome combinations:

@EXPERIMENT_DEFINITION:HAS[#id["eID"]]
{
    %RESULTS
    {
        
    }
}

NOTE: The situations available for your experiment can be determined by matching the situation and biome masks found under situationMask = ## and biomeMask = ## in the cfg with the table here.

  • Place a copy of the file in the folder for each planet.
    NOTE: If the experiment is planet specific at most (e.g. SCANSat) you may skip this step.

  • Place a copy of the following in the Mods folder, replacing 'Newmod', 'Author', 'threadID', '##' and 'eID with appropriate values:

// This file adds support for the 'Newmod' mod by 'Author'.
// https://forum.kerbalspaceprogram.com/threads/'threadID'

@EXPERIMENT_DEFINITION:HAS[#id["eID"]]
{
    %RESULTS
    {
        //default = Your science report text here.
    }
}
  • Commit your edits, push them to your fork on Github, and send a pull request here

Thanks for contributing!
After all, Crowd Sourced Science wouldn't exist without the crowd.

Clone this wiki locally