Skip to content

averageksp/KerbalChecklists

Repository files navigation

Kerbal Checklists

License Downloads Last commit GitHub release (latest by date) KSP Version Imgur Image

Kerbal Checklists is an in-game checklist system for Kerbal Space Program (KSP) to help you manage launch procedures, space missions, and vehicle preparation.


⚠️ Dependencies

✨ Features

  • Create, save, and load checklists for VAB, SPH, and Flight modes
  • Auto-saves while editing checklists
  • Toolbar icon integration for quick access
  • Refresh checklists without restarting the game
  • Safe checklist deletion with confirmation prompts

📦 Installation

  1. Download the latest version from the Releases.
  2. Extract the zip into your KSP/GameData/ folder.
  3. Your folder structure should look like this:
    GameData/
      KerbalChecklists/
        SavedChecklists/
          Checklist.txt
        Plugin/
          KerbalChecklists.dll
        Textures/
          icon.png
          arrow_up.png
          arrow_down.png
    
  4. Launch KSP and click the toolbar icon to open (must be in VAB, SPH or Flight for it to show up) Kerbal Checklists.

🚀 How to Use

  • Click the toolbar icon to open the checklist UI.
  • Add, check off, and delete items from your list.
  • Use the Save button to save your current checklist, and Load to retrieve existing ones.
  • The New Checklist button prompts a save (for default lists) before clearing your items.
  • Click Refresh to reload checklists during runtime.

🛠️ Making a Checklist Mod

  1. Inside GameData, create a folder named after your mod.
  2. Create a folder in the folder you just created, it has to be called Checklists.
  3. Add a .txt file for example with one checklist item per line, like:
    False|SAS
    False|RCS
    False|Solar Panels
    
    False would be that it is not checked and true would be that it will be checked.
  4. To make the mod show up please make a .txt file inside your folder and call it KerbalChecklistsConfig.txt. You should put this into the .txt file and save it.
    ModName=ExampleMod
    Author=averageksp
    AddToKerbalChecklists=true
    
  5. REQUIRED: If you want to publish your mod (e.g. to CKAN, Spacedock, etc.) a licence MUST be included.

🛠️ How to Compile

Want to build from source?

  1. Open Visual Studio.
  2. Clone or download this repo.
  3. Add the following references:
    KSPAssets.dll
    UnityEngine.InputModule.dll
    UnityEngine.InputLegacyModule.dll
    UnityEngine.PhysicsModule.dll
    KSPAssets.XmlSerializers.dll
    UnityEngine.AnimationModule.dll
    UnityEngine.CoreModule.dll
    UnityEngine.IMGUIModule.dll
    UnityEngine.UI.dll
    Assembly-CSharp.dll
    Assembly-CSharp-firstpass.dll
    
  4. Build the project.
  5. Copy the compiled KerbalChecklists.dll to:
    GameData/KerbalChecklists/
    
  6. Add the toolbar icon image:
    GameData/KerbalChecklists/Textures/icon.png
    

🐞 Issues & Contributions

Found a bug or want to suggest a feature? Head over to the Issues tab.

Pull requests are welcome!


📚 Additional Resources

For a list of useful links and resources related to this mod, check out LINKS.md.


📄 License

This project is licensed under the MIT License. See the LICENSE file for more information.

About

KerbalChecklist Mod for KSP

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages