How To Install a Mod From Github - KSP-RO/RP-1 GitHub Wiki

Don't know how to install a mod from Github? Have no clue what folder belongs where? Never fear, here's a guide.

There are two main ways to install a KSP mod off Github. We'll go over both of them: 1) installing from a packaged release and 2) downloading a branch and extracting the /GameData contents.

Downloading a release (the recommended way to install)

1. Navigate to the releases page by clicking on this this on the right hand of the screen

2. On the release page (looks like this) there will be one or more zipped folders. Click it to download.

3. Extract it into GameData.

The contents of the .zip will vary, but generally there will be a /GameData subfolder you will copy over into your KSP GameData like the normal method.

Grabbing a branch's source code (the less common way to install)

Some mods may not have a releases page, and will instead want you to download the mod straight from the source code.

Note: If a mod has .cs, .csproj, and/or .sln files, and doesn't have a .dll file(s) within its source code nor a releases page, then you'll need to build the mod from the source code instead of simply copying the source code, or else the mod won't work. This is a complicated process, so check out the Mod's wiki for info or ask the Mod how you should build the source code.

1. Choose the branch you want (you will generally want master).

2. Press the green "Code" button and choose the the zip option.

3. Unzip the zip folder

On windows, this can be done by right-clicking on the folder and clicking "Extract All". On other platforms, use 7zip, WinRAR, or your favorite unzipping program.

4. In the unzipped folder, navigate to the GameData folder.

5. Copy the contents into your KSP GameData folder.

If you are updating or replacing a mod, you will likely need to delete the preexisting folder(s) of the same name before you copy it over.

Note: this isn't always the case, occasionally mods will just need to update a single file in an existing folder (ROTanks does this to /GameData/RealFuels/Plugins/RealFuels.dll), and thus will only contain that file in the packaged folder. In this case, removing the existing folder will break your install. Best practice is to always check that the contents of both folders looks reasonably similar before replacing the old one.

Note: as for all things github, when in doubt, consult the mod wiki or repository readme (hopefully the mod author wrote one!) To find the readme, it will be in the downloaded branch/release folder as /README.md or displayed on in pretty markup on the main repository page when you scroll down.

Congrats, that's it!