Skip to content

Distribution notes

Eugene Medvedev edited this page Jun 15, 2014 · 24 revisions

Please, if you use this plugin to create a screen or any other prop of your own, do one of the following but not both:

Distributing RPM components with your mod

Distribute a copy of the plugin in this fashion with your mod package:

  • GameData\WhereverYouLikeToKeepYourFiles
  • GameData\JSI\RasterPropMonitor\Plugins\RasterPropMonitor.dll
  • GameData\SCANsatRPM\SCANsatRPM.dll
  • GameData\MechJeb2RPM\MechJebRPM.dll

Please do not use anything from the JSI\RasterPropMonitor\Library in this case and make your own versions. (hopefully they're better what I have in Library...)

This is very important, because to work, the plugin requires placing multiple interface DLLs in very specific locations around GameData -- this affects the loading order, and loading order affects whether they can load after the plugins they interface to. (If they end up loading before the plugins they reference, the interface DLLs just won't work.) While GPLv3 license leaves your hands free to do more or less whatever, including taking over the project if I no longer have the interest to continue it, this way at least avoids the DLL conflicts -- the user is meant to overwrite these files with the fresh versions from the package I maintain. Please instruct your users to compare version numbers on the DLLs when doing so -- Windows shows version numbers of DLLs when you attempt to do that.

You also need to include, in whichever readme file you distribute, the link to this GitHub repository, because that's what the GPL license requires of you if you wish to use this plugin without modifying the source code: https://github.com/Mihara/RasterPropMonitor/

If you do modify the source code, patches and pull requests are quite welcome. Please do not distribute binaries of the development build with released work -- it's liable to confuse users because these builds are very much not stable in terms of configuration options.

Depending on RPM distribution package

If you depend on RPM distribution package and tell your users to install RPM, keep the following in mind:

  • The files in JSI/RasterPropMonitor/Library are there for you to reference. They are not expected to change. If they need to change, new ones will be added instead. If you need to change them, create your own copy, distribute it with your mod and reference that instead.
  • The files in JSI/RPMPodPatches are not expected to be present, do not rely on them. In the future, it is expected they will be split into their own separate package. If you wish to use them anyway, prefer to make your own copy and avoid name conflicts.

Clone this wiki locally