ConfigNode Definitions

These are the names of the nodes themselves, and are followed by braces in the configuration file, e.g. MODE { }. Items tagged (M) are mandatory, (R) are recommended, and (D) can be depended on if other values in other nodes are used. Any mandatory values in an optional node are mandatory only if the optional node is declared. Any value in <> is a placeholder for a type of variable, and can be entered multiple times as long as each name is unique within that node.

Value Definitions

There are two value name types, predefined strings and user-defined strings (which must refer to an object of the appropriate type). User-defined strings are noted by the name being enclosed in <> brackets.

Notes

Lastly, it is worth noting that all fuel cell configurations should include a RESOURCE definition with a non-zero amount of ElectricCharge, as this will prevent divide by zero errors in the code which could lead to unpredictable behavior.

Animation

Animation is optional but recommended. Models should be built in their "deployed" state, with a single animation retracting any necessary elements. This animation will be played in reverse when deploying. When importing into Unity, remember to set "Animation Type" to "Legacy" under "Rig", and "Generation" to "Store in Root." Under "Animations," set "Wrap Mode" to "ClampForever" (sic), and be sure to set the "Wrap Mode" for the animation itself to "Clamp Forever." Lastly, remember to uncheck "Play Automatically" on the Animation component in your GameObject.

Emitters

KSPParticleEmitters can be embedded in the model to give a visual representation of the fuel being consumed. Be sure to uncheck "Simulate World Space" when doing so, but realize that there are several bugs with the current version of PartTools (1.1 as of this writing) and emitters, and appearance in Unity will not match the appearance in the game. Emitters will be scaled by ScaleHack, so remember to set that equal to whatever scaling your model is using. Also, all emitters should have the same "emission" values, as <EmitterScale> for an emitter defaults to 1 if not present. Lastly, alpha settings for color animations will be overridden (along with the color, of course) if values for the emitters are specified in the EMITTERS ConfigNode, as they should be.

Lights

Light "Range" is scaled by ScaleHack (assuming the light is listed in LIGHTS), so be sure to set that when scaling your model. Note that when scaling, "Intensity" is dependant on "Range," so this will not change how bright your lights appear. Light "Intensity" should be set to how bright you want the light to appear when the fuel cell is operating at maximum capacity (if not rate limited), and the plugin will automatically scale intensity between the model's internal value and zero depending on the output of the fuel cell.

Tanks

Tanks, if present, use texture swapping instead of model (i.e. UV) swapping, in order to make modding in additional tank textures for other resources more accessible. See <TankValue> for more information.