Home

RasterPropMonitor: Developer's manual

Contents

With great power comes a long developer's manual. RPM contains tools for creating everything for your IVA except the kitchen sink. (Only because I'm still thinking what useful purpose could a sink serve.) None of the packages that use it make use of all of the features, and you do need to read this manual to see all of them.

• Distribution notes
• How to Get Support
• RasterPropMonitor Config - configuration options and special config file nodes.
• Making a prop for RasterPropMonitor
• Setting up cameras
• Configuring a monitor - including configuring the RasterPropMonitorComputer PartModule.
• Writing page definition files
• Defined variables
  • Custom variables - CUSTOM_ compound Boolean operations; MAPPED_ mapping variables from one range to another; MATH_ math operations on variables; and SELECT_ returning a variable, number, or string based on tests done on other variables.
• Writing plugins for RasterPropMonitor
• Auxiliary modules:
  • Variable handlers
  • Internal modules
    • InternalCameraTargetHelper
    • JSIInternalBackgroundNoise
    • JSISetInternalCameraFOV
  • Prop modules
    • JSIActionGroupSwitch - makes buttons and switches do something.
    • JSICallbackAnimator - used to change colors or trigger animations on props in response to infrequently-changing variables.
    • JSIInternalEVAHatch
    • JSIInternalFlagDecal
    • JSILabel - displays text using a Unity TextMesh, which provides more configuration options than the older JSIVariableLabel.
    • JSINavBall - navball replacement with extra configuration options.
    • JSINumericInput - used to change a numeric value.
    • JSIOdometer
    • JSIPropIDFinder
    • JSIPropTextureShift - enables the use of a texture atlas for labeling parts of a prop.
    • JSISelectivelyVisibleProp
    • JSISwitchableVariableLabel
    • JSIVariableAnimator - used to change colors or move components of props in response to a variable changing.
    • JSIVariableLabel - displays text (including variables) using KSP's built-in text system instead of bitmap fonts.
  • Action handlers
    • JSIChatterer
    • JSIFAR (Ferram Aerospace Research)
    • JSIInternalRPMButtons
    • JSIKAC (Kerbal Alarm Clock)
    • JSIMechJeb (formerly MechJebRPMButtons)
    • JSIParachute (including RealChute)
    • JSIPilotAssistant
  • Part modules
    • JSIExternalCameraSelector
    • JSIFlashModule
    • JSIRadar
    • JSIThrustReverser
  • Page handlers
    • RasterPropMonitorComputer
    • JSIFlightLog
    • JSISASMenu
    • JSITargetMenu
    • JSIVariablePageTextSwitcher
    • MechJebRPM
  • Background handlers
    • JSIGraphingBackground
    • JSIHeadsUpDisplay
    • JSIOrbitDisplay
    • JSIPrimaryFlightDisplay
    • JSISCANsatRPM (legacy)
    • JSISteerableCamera - Camera views that can have smooth zoom and pan effects, plus shader effects applied to the camera view.
    • JSIVariableGraph
  • Triggered Events
• Making an IVA that works both with and without RasterPropMonitor
• Meta topics:
  • Changes in this version
  • Changes in previous versions
  • Variables removed in v0.20
  • Variables removed in v0.15

Warning: This manual reflects the current state of development, (I literally edit it every time I change something, documenting the code immediately after it's written) and may (and often does) run ahead of the last published version. A snapshot of it reflecting the state at the moment of release is included with the release since version 0.10, so in case of doubt, please refer to that -- they are available on the Releases page along with the binaries. The version on the wiki directly corresponds to the current development build, but do not attempt to install it unless you know what you are doing, because it literally gets updated every time I press the build button, so it isn't guaranteed to work at all. It certainly isn't guaranteed not to change before the official release.