Plugins

(Difference between revisions)
Jump to: navigation, search
m (Version history)
(42 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 +
Since version 0.10.3, Stellarium's packages '''include''' a number of plug-ins:
 +
*[0.10.3+] [[AngleMeasure plugin|Angle Measure]] - a tool for measuring the angular distance between two points
 +
*[0.10.3+] [[CompassMarks plugin|Compass Marks]] - add marks for compass bearings along the horizon
 +
*[0.10.3+] [[Ocular plugin|Oculars]] - simulate the view through various telescope eyepeices
 +
*[0.10.3+] [[Telescope Control plug-in|Telescope Control]] - allows Stellarium to control a computerized telescope
 +
*[0.10.3+] [[TextUserInterface plugin|Text User Interface]] - re-implements the old TUI (useful for planetarium users)
 +
*[0.10.3+] [[Satellites plugin|Satellites]] - calculates and renders Satellites in Earth orbit from NORAD/TLE data (hello ISS!)
 +
*[0.10.6+] [[Solar System Editor plugin|Solar System Editor]]
 +
*[0.10.6+] [[Time Zone plugin|Time Zone]]
 +
*[0.11.0+] [[Historical Supernovae plugin|Historical Supernovae]]
 +
*[0.11.2+] [[Quasars plugin|Quasars]]
 +
*[0.11.2+] [[Pulsars plugin|Pulsars]]
 +
*[0.11.4+] [[Exoplanets plugin|Exoplanets]]
 +
*[0.11.4+] [[Observability analysis plugin|Observability analysis]]
  
==Existing plugins==
+
'''All these plug-ins are "built-in" in the standard Stellarium distribution and DON'T need to be downloaded separately.''' See [[#Enabling plugins]] below on how to enable them.
Several plugins are already developed and available in the SVN code tree.
+
  
*[[AngleMeasure plugin|Angle Measure]] - a tool for measuring the angular distance between two points
+
Some other plug-ins exist:
*[[CompassMarks plugin|Compass Marks]] - add marks for compass bearings along the horizon
+
*[[LogBook plugin|LogBook]] - allows you to record observation notes, and track your observation sessions. It's still under construction.
*[[Ocular plugin|Ocular]] - simulate the view through various telescope eyepeices
+
*[http://archive.eso.org/cms/tools-documentation/visual-archive-browser VirGO] - The ESO-sponsored archive browsing and visualization tool
*[[TextUserInterface plugin|Text User Interface]] - re-implements the old TUI (useful for planetarium users)
+
*[http://svmtdemo.hq.eso.org/ SVMT] (Survey Visualization and Monitoring Tool), another ESO-sponsored plug-in
*[[Satellites plugin||Satellites]] - calculates and renders Satallites in Earth orbit from NORAD/TLE data (hello ISS!)
+
  
==Pre-built plugins==
+
==Enabling plugins==
See the [[Download]] page / plugins section.
+
<div style="float:right">
 +
http://stellarium.org/wikiimg/sat_howto_01.jpg
 +
</div>
  
==Building and installing==
+
To enable a plugin:
===Linux===
+
#Open the '''Configuration dialog''' (press F2 or use the left tool bar button)
*Build the core Stellarium code according to the [[Compilation on Linux]] page.  Make sure the build sub-directory is called ''builds/unix''.
+
#Select the '''Plugins''' tab
*Set the environment variable STELROOT to be the path of the stellarium source tree, for example:
+
#Select the plugin you want to enable from the list
export STELROOT=/home/bob/stellarium
+
#Check the '''Load at startup''' option
*Change to where you have the plugin source code installed, make a sub-directory ''builds/unix'' and change into it.
+
#Restart Stellarium
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===
+
If the plugin has configuration options, the '''configuration''' button will be enabled when the plugin is loaded and clicking it will open the plugin's configuration window.
*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.
+
  
==Writing Plugins==
+
<br style="clear:both"/>
If you are a developer, and would like to have a go at writing your own Stellarium plugin, the following resources might be helpful:
+
 
*[http://www.stellarium.org/doc/head/plugins.html the "Plugins" page in Stellarium's online developers' documentation]
+
==Version history==
*The existing plugin's source code in subversion [http://stellarium.svn.sourceforge.net/viewvc/stellarium/trunk/extmodules/ browse it here]
+
The following table shows which plug-in versions are bundled with which versions of Stellarium. There were plug-ins for Stellarium 0.10.2 and prior, but they were a separate download.
*The stellarium-pubdevel mailing list - please fee free to subscribe and post questions there
+
 
 +
{| class="wikitable" width="100%"
 +
! rowspan="2" | Plug-in
 +
! colspan="10" | Stellarium version
 +
|-
 +
| 0.10.3
 +
| 0.10.4
 +
| 0.10.5
 +
| 0.10.6
 +
| 0.11.0
 +
| 0.11.1
 +
| 0.11.2
 +
| 0.11.3
 +
| 0.11.4
 +
| ''0.12.0''
 +
|-
 +
| [[AngleMeasure plugin|Angle Measure]]
 +
| colspan="6" | 0.1.0
 +
| 0.2.0
 +
| 0.2.1
 +
| 0.2.2
 +
| ''0.2.3''
 +
|-
 +
| [[CompassMarks plugin|Compass Marks]]
 +
| colspan="8" | 0.1.0
 +
| 0.2.1
 +
| ''0.2.2''
 +
|-
 +
| [[Ocular plugin|Oculars]]
 +
| colspan="2" | 0.13.0
 +
| colspan="2" | 0.13.1
 +
| colspan="2" | 0.99.0
 +
| colspan="2" | 0.99.1
 +
| 0.99.2
 +
| ''0.99.3''
 +
|-
 +
| [[Telescope Control plug-in|Telescope Control]]
 +
| colspan="2" | 0.1.9
 +
| 0.2.1
 +
| colspan="3" | 0.2.2
 +
| colspan="3" | 0.2.3
 +
| ''0.2.4''
 +
|-
 +
| [[TextUserInterface plugin|Text User Interface]]
 +
| colspan="2" | 0.2.0
 +
| 0.2.1
 +
| colspan="3" | 0.2.2
 +
| colspan="3" | 0.2.3
 +
| ''0.2.4''
 +
|-
 +
| [[Satellites plugin|Satellites]]
 +
| colspan="2" | 0.5.2
 +
| 0.5.3
 +
| colspan="3" | 0.6.4
 +
| colspan="2" | 0.7.1
 +
| 0.7.2
 +
| ''0.7.3''
 +
|-
 +
| [[Solar System Editor plugin|Solar System Editor]]
 +
| colspan="3" | &mdash;
 +
| 0.0.1
 +
| 0.0.2
 +
| 0.1.0
 +
| colspan="3" | 0.1.1
 +
| ''0.1.2''
 +
|-
 +
| [[Time Zone plugin|Time Zone]]
 +
| colspan="3" | &mdash;
 +
| 0.0.1
 +
| colspan="2" | 0.0.2
 +
| colspan="3" | 0.0.3
 +
| ''0.0.4''
 +
|-
 +
| [[Historical Supernovae plugin|Historical Supernovae]]
 +
| colspan="4" | &mdash;
 +
| 0.2.3
 +
| 0.2.7
 +
| 0.2.8
 +
| 0.2.9
 +
| 0.2.11
 +
| ''0.2.12''
 +
|-
 +
| [[Quasars plugin|Quasars]]
 +
| colspan="6" | &mdash;
 +
| 0.1.1
 +
| 0.1.2
 +
| 0.1.4
 +
| ''0.1.5''
 +
|-
 +
| [[Pulsars plugin|Pulsars]]
 +
| colspan="6" | &mdash;
 +
| colspan="2" | 0.1.2
 +
| 0.2.1
 +
| ''0.2.2''
 +
|-
 +
| [[Exoplanets plugin|Exoplanets]]
 +
| colspan="8" | &mdash;
 +
| 0.1.2
 +
| ''0.1.3''
 +
|-
 +
| [[Observability analysis plugin|Observability analysis]]
 +
| colspan="8" | &mdash;
 +
| 1.0.2
 +
| ''1.0.3''
 +
|-
 +
|}
 +
 
 +
== See also ==
 +
*[[Plugin Development]]
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
[[Category:Development]]
 

Revision as of 10:45, 9 September 2012

Since version 0.10.3, Stellarium's packages include a number of plug-ins:

All these plug-ins are "built-in" in the standard Stellarium distribution and DON'T need to be downloaded separately. See #Enabling plugins below on how to enable them.

Some other plug-ins exist:

  • LogBook - allows you to record observation notes, and track your observation sessions. It's still under construction.
  • VirGO - The ESO-sponsored archive browsing and visualization tool
  • SVMT (Survey Visualization and Monitoring Tool), another ESO-sponsored plug-in

Enabling plugins

sat_howto_01.jpg

To enable a plugin:

  1. Open the Configuration dialog (press F2 or use the left tool bar button)
  2. Select the Plugins tab
  3. Select the plugin you want to enable from the list
  4. Check the Load at startup option
  5. Restart Stellarium

If the plugin has configuration options, the configuration button will be enabled when the plugin is loaded and clicking it will open the plugin's configuration window.


Version history

The following table shows which plug-in versions are bundled with which versions of Stellarium. There were plug-ins for Stellarium 0.10.2 and prior, but they were a separate download.

Plug-in Stellarium version
0.10.3 0.10.4 0.10.5 0.10.6 0.11.0 0.11.1 0.11.2 0.11.3 0.11.4 0.12.0
Angle Measure 0.1.0 0.2.0 0.2.1 0.2.2 0.2.3
Compass Marks 0.1.0 0.2.1 0.2.2
Oculars 0.13.0 0.13.1 0.99.0 0.99.1 0.99.2 0.99.3
Telescope Control 0.1.9 0.2.1 0.2.2 0.2.3 0.2.4
Text User Interface 0.2.0 0.2.1 0.2.2 0.2.3 0.2.4
Satellites 0.5.2 0.5.3 0.6.4 0.7.1 0.7.2 0.7.3
Solar System Editor 0.0.1 0.0.2 0.1.0 0.1.1 0.1.2
Time Zone 0.0.1 0.0.2 0.0.3 0.0.4
Historical Supernovae 0.2.3 0.2.7 0.2.8 0.2.9 0.2.11 0.2.12
Quasars 0.1.1 0.1.2 0.1.4 0.1.5
Pulsars 0.1.2 0.2.1 0.2.2
Exoplanets 0.1.2 0.1.3
Observability analysis 1.0.2 1.0.3

See also

Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox