Difference between revisions of "Addon"

From Kerbal Space Program Wiki
Jump to: navigation, search
(mod descriptions are out of date, they should get their own pages here (for stuff like RSS or FAR) or re-added if someone intends to keep them updated)
(*overhauled hole article;)
Line 1: Line 1:
−
'''Addons''' or '''mods''' are modifications to the official version of the game. They either add new parts, systems and mechanics to the game or replace existing ones. Addons are generally made by the community rather than the developers and can greatly enhance your playing experience. Due to their widespread popularity, Squad offers an official website for exchanging them, the [http://kerbalspaceport.com/ Kerbal SpacePort].
+
'''Addons''', '''mods''' or '''plugins''' are modifications to the official version of the game. They either add new parts, systems and mechanics to the game or replace existing ones. Addons are generally made by the community rather than the developers and can greatly enhance the playing experience. Due to their widespread popularity, Squad offers an official website for exchanging them, the [http://kerbalspaceport.com/ Kerbal SpacePort].
  
−
==How to install addons==
+
== Installing addons ==
−
Provided you downloaded an addon from the SpacePort, you should first unpack the .zip archive and then copy the unpacked contents to the appropriate folder in your KSP directory. Here's how.
+
In general addons are installed into the [[GameData]] directory. If the installation technique differs there is usually a more detailed description in the readme, on the SpacePort page or in the forum's opening post. Some mods directly distribute the content which should go into the GameData directory, while others distribute the GameData directory in which all new directories are. There are also some cases in which the root directory of the zip is itself containing a GameData directory. So unless the root directory is not named GameData it is always good to look if there is a GameData directory in the root directory.
  
−
Open up your KSP directory and go to the "GameData" folder. In another window, find the (unpacked) contents of the .zip archive that you just extracted. As of update 0.20, compatible addons should just show a [mod name here] folder. Copy that folder to the GameData folder, and you're done! All you have to do from there is start the game.
+
Sometimes mods require other mods to work which should be mentioned in the readme, SpacePort or forum page. These are distributed too in most cases with the original mod, which should be checked before copying the contents. Sometimes a mod distribute an older version which might break other plugins which require the newer version. Even worse are mods with a different name, because then the same mod is installed twice which usually break the game. The best way to handle is only installing the mod itself and manually checking if any requirements are already installed and if they might need to be updated.
  
−
Uninstalling is just as simple as deleting the folder with the name of the addon that you want to remove. However, any ships created with those addons will not load next time you start your game, once uninstalled.
+
To install the content of a ZIP archive a program to unzip is required. Usually there is a program already installed, but there are various available on the internet. Of course it should be checked if the sources are trustworthy.
  
−
===Directory system===
+
The directory structure was changed in [[0.20]], which introduced the GameData directory. There are still some plugins which use the old directory system which is more complicated and might introduce file conflicts, where two or more files need to be merged.
  
−
Note: as of the 0.20 update, all of the addon folders are contained in a parent folder (containing the name of the mod downloaded) in the GameData folder. For "legacy" (pre-0.20) addons, the folders were at the root of the .zip file - requiring the user to move the "Parts" and/or "Plugins" folders to the corresponding KSP directory folders. With many mods installed, it may have been hard to tell what parts were mods and what parts weren't when uninstalling. Now, each addon gets its own folder in the KSP directory (instead of sharing one with the game itself), simplifying things.
+
=== Directory system ===
 +
The contents of a ZIP archive are usually:
 +
* A directory with the mod name (might be omitted)
 +
** A directory with the name ''GameData'' (might be omitted too)
 +
*** Again a directory with the mod name, which might be confused with the first level mod directory
 +
**** Usually there is some documentation like a readme text file, or changelog.
 +
**** The "Parts" folder contains the actual ship-building parts you would see in the ship builder interface.
 +
**** The "Plugins" folder contains the plugin .dll files that would support the plugin system implemented by the addon.
 +
**** The "Source" folder is just the source code, and is only needed by modders wanting to see how the addon was made and maybe attempt to modify it (with permission/attribution, of course).
  
−
* Inside of the .zip file will be the folders "Parts", "Plugins", and (occasionally) "Source". There may also be documentation, usually in the form of a "README" text file.
+
== Removing addons ==
−
** The "Parts" folder contains the actual ship-building parts you would see in the ship builder interface.
+
In most cases, addons can be easily removed by deleting the addon directory in the GameData directory. Sometimes it other mods require the removed addon which then need to be removed too. If the addon introduced additional parts, craft which use those parts can't be loaded or approached. To disable the functionality without losing the craft, it is possible to change the file extension of all DLL files or remove them completely in the mod directory. Upon loading the game, the mod's code won't be loaded but the parts are still available.
−
** The "Plugins" folder contains the plugin .dll files that would support the plugin system implemented by the addon.
+
 
−
** The "Source" folder is just the source code, and is only needed by modders wanting to see how the addon was made and maybe attempt to modify it (with permission/attribution, of course).
+
As for installing, removing addons which use the directory system prior to 0.20 is more complex. Each file which was added in that mod needs to be removed manually usually and if files were merged, those needs to be undone.
 +
 
 +
== Addons on this wiki ==
 +
* [[Tutorial:RemoteTech]], a tutorial for RemoteTech 1
 +
* [[Tutorial:RemoteTech2]], a tutorial for RemoteTech 2

Revision as of 12:41, 6 April 2014

Addons, mods or plugins are modifications to the official version of the game. They either add new parts, systems and mechanics to the game or replace existing ones. Addons are generally made by the community rather than the developers and can greatly enhance the playing experience. Due to their widespread popularity, Squad offers an official website for exchanging them, the Kerbal SpacePort.

Installing addons

In general addons are installed into the GameData directory. If the installation technique differs there is usually a more detailed description in the readme, on the SpacePort page or in the forum's opening post. Some mods directly distribute the content which should go into the GameData directory, while others distribute the GameData directory in which all new directories are. There are also some cases in which the root directory of the zip is itself containing a GameData directory. So unless the root directory is not named GameData it is always good to look if there is a GameData directory in the root directory.

Sometimes mods require other mods to work which should be mentioned in the readme, SpacePort or forum page. These are distributed too in most cases with the original mod, which should be checked before copying the contents. Sometimes a mod distribute an older version which might break other plugins which require the newer version. Even worse are mods with a different name, because then the same mod is installed twice which usually break the game. The best way to handle is only installing the mod itself and manually checking if any requirements are already installed and if they might need to be updated.

To install the content of a ZIP archive a program to unzip is required. Usually there is a program already installed, but there are various available on the internet. Of course it should be checked if the sources are trustworthy.

The directory structure was changed in 0.20, which introduced the GameData directory. There are still some plugins which use the old directory system which is more complicated and might introduce file conflicts, where two or more files need to be merged.

Directory system

The contents of a ZIP archive are usually:

  • A directory with the mod name (might be omitted)
    • A directory with the name GameData (might be omitted too)
      • Again a directory with the mod name, which might be confused with the first level mod directory
        • Usually there is some documentation like a readme text file, or changelog.
        • The "Parts" folder contains the actual ship-building parts you would see in the ship builder interface.
        • The "Plugins" folder contains the plugin .dll files that would support the plugin system implemented by the addon.
        • The "Source" folder is just the source code, and is only needed by modders wanting to see how the addon was made and maybe attempt to modify it (with permission/attribution, of course).

Removing addons

In most cases, addons can be easily removed by deleting the addon directory in the GameData directory. Sometimes it other mods require the removed addon which then need to be removed too. If the addon introduced additional parts, craft which use those parts can't be loaded or approached. To disable the functionality without losing the craft, it is possible to change the file extension of all DLL files or remove them completely in the mod directory. Upon loading the game, the mod's code won't be loaded but the parts are still available.

As for installing, removing addons which use the directory system prior to 0.20 is more complex. Each file which was added in that mod needs to be removed manually usually and if files were merged, those needs to be undone.

Addons on this wiki

Retrieved from "https://wiki.kerbalspaceprogram.com/index.php?title=Addon&oldid=34827"