Plugins

(Difference between revisions)
Jump to: navigation, search
(some wikification; wasn't it better to copy/paste some of the text in the developers' documentation?)
Line 1: Line 1:
 
For more technical information, see [http://www.stellarium.org/doc/head/plugins.html the "Plugins" page in Stellarium's online developers' documentation].
 
For more technical information, see [http://www.stellarium.org/doc/head/plugins.html the "Plugins" page in Stellarium's online developers' documentation].
  
Stellarium is now constructed so that new or special features can be added as plugin modules eg. At the present moment the plug-ins are only supplied in source code.
+
==Existing plugins==
 +
Several plugins are already developed and available in the SVN code tree.
  
== General purpose plug-ins ==
+
*[[AngleMeasure plugin|Angle Measure]] - a tool for measuring the angular distance between two points
There are three general purpose plug-ins available at the moment:
+
*[[CompassMarks plugin|Compass Marks]] - add marks for compass bearings along the horizon
; AngleMeasure : To measure the angle between two objects on the view window
+
*[[Ocular plugin|Ocular]] - simulate the view through various telescope eyepeices
; CompassMarks : Places a relative set of degree markers on the horizon
+
*[[TextUserInterface plugin|Text User Interface]] - re-implements the old TUI (useful for planetarium users)
; Ocular : Creates a window for a predetermined telescope view.
+
*[[Satellites plugin||Satellites]] - calculates and renders Satallites in Earth orbit from NORAD/TLE data (hello ISS!)
  
The programs are in the form of a *.DLL file and a *.ini file, placed in a folder "modules" of the Stellarium root directory or the documents and settings/user area allocated to the config.ini file and is called by a key combination Ctrl (?) and sub key if necessary.
+
==Pre-built plugins==
 +
See the [[Download]] page / plugins section.
 +
 
 +
==Building and installing==
 +
===Linux===
 +
*Build the core Stellarium code according to the [[Compilation on Linux]] page.  Make sure the build sub-directory is called ''builds/unix''.
 +
*Set the environment variable STELROOT to be the path of the stellarium source tree, for example:
 +
export STELROOT=/home/bob/stellarium
 +
*Change to where you have the plugin source code installed, make a sub-directory ''builds/unix'' and change into it.
 +
cd /home/bob/stel-plugins/PluginName
 +
mkdir -p builds/unix
 +
cd builds/unix
 +
*Run cmake, specifying the build type to be the same as that which was used to build the core code (Debug or Release). Then run make
 +
cmake -DCMAKE_BUILD_TYPE=Debug ../..
 +
make
 +
*To install, just do:
 +
make install
 +
This will put the files for the plugin in ''~/.stellarium/modules/PluginName''
 +
 
 +
===Windows===
 +
*Build the core Stellarium code according to the [[Windows Build Instructions]] page.  Make sure the build sub-directory is called ''builds/msys''.
 +
*Set the environment variable STELROOT to be the path of the stellarium source tree, for example:
 +
export STELROOT=/c/msys/1.0/home/bob/stellarium
 +
*Change to where you have the plugin source code installed, make a sub-directory ''builds/msys'' and change into it.
 +
cd /c/msys/1.0/home/bob/stel-plugins
 +
mkdir -p builds/msys
 +
cd builds/msys
 +
*Run cmake, specifying the build type to be the same as that which was used to build the core code (Debug or Release). Then run make
 +
cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Debug ../..
 +
make
 +
*Several of the plugins have a file called "installer.iss" in the main plugin directory.  This can be used with the INNO installer generator to generate a windows installer for the plugin.
  
=== Compiled versions ===
 
As these modules are only available in source code they need to be compiled. For those Windows users who cannot compile there are unofficial compiled versions available at [http://www.geocities.com/wendygblyde Barry Gerdes' Stellarium site]
 
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Development]]
 
[[Category:Development]]

Revision as of 12:57, 22 March 2009

For more technical information, see the "Plugins" page in Stellarium's online developers' documentation.

Contents

Existing plugins

Several plugins are already developed and available in the SVN code tree.

  • Angle Measure - a tool for measuring the angular distance between two points
  • Compass Marks - add marks for compass bearings along the horizon
  • Ocular - simulate the view through various telescope eyepeices
  • Text User Interface - re-implements the old TUI (useful for planetarium users)
  • |Satellites - calculates and renders Satallites in Earth orbit from NORAD/TLE data (hello ISS!)

Pre-built plugins

See the Download page / plugins section.

Building and installing

Linux

  • Build the core Stellarium code according to the Compilation on Linux page. Make sure the build sub-directory is called builds/unix.
  • Set the environment variable STELROOT to be the path of the stellarium source tree, for example:
export STELROOT=/home/bob/stellarium
  • Change to where you have the plugin source code installed, make a sub-directory builds/unix and change into it.
cd /home/bob/stel-plugins/PluginName
mkdir -p builds/unix
cd builds/unix
  • Run cmake, specifying the build type to be the same as that which was used to build the core code (Debug or Release). Then run make
cmake -DCMAKE_BUILD_TYPE=Debug ../..
make
  • To install, just do:
make install

This will put the files for the plugin in ~/.stellarium/modules/PluginName

Windows

  • Build the core Stellarium code according to the Windows Build Instructions page. Make sure the build sub-directory is called builds/msys.
  • Set the environment variable STELROOT to be the path of the stellarium source tree, for example:
export STELROOT=/c/msys/1.0/home/bob/stellarium
  • Change to where you have the plugin source code installed, make a sub-directory builds/msys and change into it.
cd /c/msys/1.0/home/bob/stel-plugins
mkdir -p builds/msys
cd builds/msys
  • Run cmake, specifying the build type to be the same as that which was used to build the core code (Debug or Release). Then run make
cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Debug ../..
make
  • Several of the plugins have a file called "installer.iss" in the main plugin directory. This can be used with the INNO installer generator to generate a windows installer for the plugin.
Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox