Since version 0.10.3, Stellarium's packages include a number of plug-ins: Angle Measure, Compass Marks, Oculars, Telescope Control, Text User Interface, Satellites, Solar System Editor, Time Zone, Historical Supernovae, Quasars, Pulsars, Exoplanets and Observability analysis. All these plug-ins are "built-in" in the standard Stellarium distribution and DON'T need to be downloaded separately.

Since version 0.10.3, Stellarium's packages include a number of plug-ins: Angle Measure, Compass Marks, Oculars, Telescope Control, Text User Interface, Satellites, Solar System Editor, Time Zone, Historical Supernovae, Quasars, Pulsars, Exoplanets and Observability analysis. All these plug-ins are "built-in" in the standard Stellarium distribution and DON'T need to be downloaded separately.

Line 27:

Line 27:

The path to the directory which contains <tt>catalog.json</tt> file is something like:

The path to the directory which contains <tt>catalog.json</tt> file is something like:

{{user data directory|modules\<Plugin name>|modules/<Plugin name>}}

{{user data directory|modules\<Plugin name>|modules/<Plugin name>}}

+

+

==How you can help==

+

We are welcome bug reports, feature requests and feedback through the usual channels (trackers, forums and so on).

<br style="clear:both"/>

<br style="clear:both"/>

+

+

==Angle Measure Plugin==

+

<div style="float:right; margin:5px;">

+

http://porpoisehead.net/images/plugin-angle-measure.jpg

+

</div>

+

+

The Angle Measure plugin is a small tool which is used to measure the angular distance between two points on the sky. *goes misty eyed* I recall measuring the size of the Cassini Division when I was a student. It was not the high academic glamor one might expect... It was cloudy... It was rainy... The observatory lab had some old scopes set up at one end, pointing at a ''photograph'' of Saturn at the other end of the lab. We measured. We calculated. We wished we were in Hawaii. A picture is worth a thousand words.

+

+

===Using plugin===

+

#Enable the tool by clicking the tool-bar button, or by pressing '''control-A'''. A message will appear at the bottom of the screen to tell you that the tool is active.

+

#Drag a line from the first point to the second point using the left mouse button

The Bright Novae plugin provides visualization of some bright novae in the Milky Way galaxy.

+

+

Example ([http://en.wikipedia.org/wiki/V1500_Cygni '''Nova Cygni 1975'''], also known as '''V1500 Cyg'''):

+

http://stellarium.org/wikiimg/novae/NovaCygni1975wiki.jpg

+

+

==Using plugin==

+

#Enable the tool by clicking the tool-bar button "Load at startup"

+

#Set date and time (30 August 1975 year for ''Nova Cygni 1975'' as example)

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/Bright_Novae_plugin

+

+

<br style="clear:both"/>

+

+

==Compass Marks Plugin==

+

<div style="float:right; margin:5px;">

+

http://porpoisehead.net/images/plugin-compass-marks.jpg

+

</div>

+

Stellarium helps the user get their bearings using the cardinal point feature - the North, South, East and West markers on the horizon. Compass Marks takes this idea and extends it to add markings every few degrees along the horizon, and includes compass bearing values in degrees.

+

+

===Using plugin===

+

There is a tool bar button for toggling the compass markings, or you can press '''control-C'''.

+

+

Note that when you first enable compass marks, the cardinal points will be turned off. You can have both active at once, but there is a small bug which means you have to press '''Q''' ''two times'' to re-enable cardinal points after enabling the compass markings.

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/CompassMarks_plugin

+

+

<br style="clear:both"/>

+

+

==Text User Interface Plugin==

+

<div style="float:right; margin:5px;">

+

http://porpoisehead.net/images/plugin-tui.jpg

+

</div>

+

Older versions of Stellarium used to have a little menu system which was controlled by the cursor keys. This was used primarily by planetarium system operators to change settings, run scripts and so on. In the 0.10.x series, this function vanished as we totally re-designed the user interface. This plugin re-implements the "TUI", as it was known. Full list of the commands for the TUI plugin you can read in the section [[TUI_Commands|TUI Commands]].

+

+

===Using plugin===

+

#Activate the text menu using the '''m''' key

+

#Navigate the menu using the cursors keys.

+

#To edit a value, press the right cursor until the value you wish to change it highlighted with > and < marks, e.g. >3.142<. Then press the up and down cursors to change the value. You may also type in a new value with the other keys on the keyboard.

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/TextUserInterface_plugin

+

+

<br style="clear:both"/>

+

+

==Oculars Plugin==

+

+

+

Oculars. This places a window on the screen that corresponds to the view through a telescope or on a camera. It reads from an editable data base.

+

+

http://barry.sarcasmogerdes.com/stellarium/Oculars.png

+

+

When this plug in is active a window will appear around the selected object depicting what would be seen by the viewing object. On the top right hand side of the screen a menu will appear that can be used to select the viewing device eg. Camera, Eyepiece. This menu is filled with items from the ocular.ini file in the modules\oculars folder. his file can be edited from the Plugins menu screen or by a text editor.

+

+

==Telescope Control Plugin==

+

+

Telescope Control. Stellarium has a simple control mechanism for motorised telescope mounts. The user selects an object (i.e. by clicking on something - a planet, a star etc.) and presses the ''telescope go-to'' key (see section []) and the telescope will be guided to the object.

+

+

Multiple telescopes may be controlled simultaneously.

+

+

http://www.stellarium.org/wikiimg/UserManual/telescope_control.png

+

+

The control interface uses the Meade or the Celestron protocol and most telescopes use either one or the other so many different brands of telescopes can be controlled. There is a third party Telescope control system going under the name of ASCOM. They provide an interface to stellarium and then translate the control into many other forms

+

+

Multiple telescopes may be controlled simultaneously.

+

+

''WARNING: Stellarium will not prevent your telescope from being pointed at the Sun. It is up to you to ensure proper filtering and safety measures are applied!''

+

+

==Satellites Plugin==

+

+

Satellites. This displays a number of earth orbiting satellies. automatically updated every 72 hours from the internet.

+

+

http://www.stellarium.org/wikiimg/UserManual/satellites.png

+

+

This plug in reads information on a selected range of near earth orbiting satellites from a file satellites.json that is updated every 72 hours and displays

+

http://www.stellarium.org/wikiimg/UserManual/hint.png with a name. The file is editable with a text editor to change the colour and visibility when required.

+

+

==Solar System Editor Plugin==

+

+

This plugin provides a window to the Minor Planet Center where the latest Solar System information can be found. When this plugin is loaded you can select configure and the second window will appear where you can select the planet, asteroid or comet database. You can then download the latest orbital data from the MPC. This done you will be able to select the object you need and have it automatically added to the ssystem.ini file

+

+

==Time Zone Plugin==

+

+

TimeZoneConfiguration. Used to manipulate the time zone of the display.

Example ([http://en.wikipedia.org/wiki/3C_249.1 3C 249.1], also known as '''LEDA 2821945''' or '''4C 77.09'''):

+

http://stellarium.org/wikiimg/quasars/qso_3c_249.1.jpg

+

+

===Using plugin===

+

#Enable the tool by clicking the tool-bar button "Load at startup"

+

#Enable displaying of the quasars on the bottom bar (or press '''Control+Alt+Q''' for toggle plugin).

+

#Find the quasar by their designation (3C 249.1 as example)

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/Quasars_plugin

+

+

==Pulsars Plugin==

+

This plugin plots the position of various pulsars, with object information about each one. Pulsar data is derived from ''Catalog of Pulsars'' ([http://cdsads.u-strasbg.fr/cgi-bin/nph-bib_query?1993ApJS...88..529T&db_key=AST&nosetcookie=1 Taylor+ 1995]) for 0.1.x series and derived from ''The ATNF Pulsar Catalogue'' (Manchester, R. N., Hobbs, G. B., Teoh, A. & Hobbs, M., Astron. J., 129, 1993-2006 (2005) ([http://arxiv.org/abs/astro-ph/0412641 astro-ph/0412641])) for series 0.2.x.

+

+

Example ([http://en.wikipedia.org/wiki/PSR_B0329+54 PSR J0332+5434]):

+

+

http://stellarium.org/wikiimg/pulsars/psr_j0332_5434.jpg

+

+

===Using plugin===

+

#Enable the tool by clicking the tool-bar button "Load at startup"

+

#Enable displaying of the pulsars on the bottom bar (or press '''Control+Alt+P''' for toggle plugin).

+

#Find the pulsar by their designation (PSR J0437-4715 as example)

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/Pulsars_plugin

+

+

==Exoplanets Plugin==

+

This plugin plots the position of stars with exoplanets. Exoplanets data is derived from "[http://exoplanet.eu/ The Extrasolar Planets Encyclopaedia]". List of potential habitable exoplanets and data about them were taken from "The Habitable Exoplanets Catalog" by Planetary Habitability Laboratory.

+

+

http://stellarium.org/wikiimg/exoplanets/exoplanets.jpg

+

+

===Using plugin===

+

#Enable the tool by clicking the tool-bar button "Load at startup"

+

#Enable displaying of the stars with exoplanets on the bottom bar (or press '''Control+Alt+E''' for toggle plugin).

+

#Find the stars with exoplanets by their designation (24 Sex as example)

+

+

===Plugin's home page===

+

http://www.stellarium.org/wiki/index.php/Exoplanets_plugin

+

+

==Observability Analysis Plugin==

+

Reports an analysis of source observability (rise, set, and transit times), as well as the epochs of year when the source is best observed. It assumes that a source is observable if it is above the horizon during a fraction of the night. The plugin also gives the day for largest separation from the Sun and the days of Acronychal and Cosmical rise/set.

Revision as of 23:40, 20 May 2014

Information is actual for version 0.12.4

Since version 0.10.3, Stellarium's packages include a number of plug-ins: Angle Measure, Compass Marks, Oculars, Telescope Control, Text User Interface, Satellites, Solar System Editor, Time Zone, Historical Supernovae, Quasars, Pulsars, Exoplanets and Observability analysis. All these plug-ins are "built-in" in the standard Stellarium distribution and DON'T need to be downloaded separately.

Enabling plugins

Open the Configuration dialog (press F2 or use the left tool bar button)

Select the Plugins tab

Select the plugin you want to enable from the list

Check the Load at startup option

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.

Data for plugins

Some plugins contain files with different data, e.g. catalogs. JSON is a typical format for those files and you can edit it's manually. Of course, each plugin has specific format of data for the own catalogs and you should read documentation for plugin before editing of it catalog.

You can read some common instructions for editing catalogs of plugins below. In this example we use catalog.json file for identification of catalog for typical plugin.

You can modify the catalog.json files manually using a text editor. If you are using Windows, it is strongly recommended to use an advanced text editor such as Notepad++ to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)

Warning: Before editing your catalog.json file, make a backup copy. Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.

The path to the directory which contains catalog.json file is something like:

(Note that this is a hidden folder, so in order to find it you may need to change your computer's settings to display hidden files and folders.)

How you can help

We are welcome bug reports, feature requests and feedback through the usual channels (trackers, forums and so on).

Angle Measure Plugin

The Angle Measure plugin is a small tool which is used to measure the angular distance between two points on the sky. *goes misty eyed* I recall measuring the size of the Cassini Division when I was a student. It was not the high academic glamor one might expect... It was cloudy... It was rainy... The observatory lab had some old scopes set up at one end, pointing at a photograph of Saturn at the other end of the lab. We measured. We calculated. We wished we were in Hawaii. A picture is worth a thousand words.

Using plugin

Enable the tool by clicking the tool-bar button, or by pressing control-A. A message will appear at the bottom of the screen to tell you that the tool is active.

Drag a line from the first point to the second point using the left mouse button

To clear the measurement, click the right mouse button

To deactivate the angle measure tool, press the tool-bar button again, or press control-A on the keyboard.

Plugin's home page

Compass Marks Plugin

Stellarium helps the user get their bearings using the cardinal point feature - the North, South, East and West markers on the horizon. Compass Marks takes this idea and extends it to add markings every few degrees along the horizon, and includes compass bearing values in degrees.

Using plugin

There is a tool bar button for toggling the compass markings, or you can press control-C.

Note that when you first enable compass marks, the cardinal points will be turned off. You can have both active at once, but there is a small bug which means you have to press Qtwo times to re-enable cardinal points after enabling the compass markings.

Plugin's home page

Text User Interface Plugin

Older versions of Stellarium used to have a little menu system which was controlled by the cursor keys. This was used primarily by planetarium system operators to change settings, run scripts and so on. In the 0.10.x series, this function vanished as we totally re-designed the user interface. This plugin re-implements the "TUI", as it was known. Full list of the commands for the TUI plugin you can read in the section TUI Commands.

Using plugin

Activate the text menu using the m key

Navigate the menu using the cursors keys.

To edit a value, press the right cursor until the value you wish to change it highlighted with > and < marks, e.g. >3.142<. Then press the up and down cursors to change the value. You may also type in a new value with the other keys on the keyboard.

Plugin's home page

Oculars Plugin

Oculars. This places a window on the screen that corresponds to the view through a telescope or on a camera. It reads from an editable data base.

When this plug in is active a window will appear around the selected object depicting what would be seen by the viewing object. On the top right hand side of the screen a menu will appear that can be used to select the viewing device eg. Camera, Eyepiece. This menu is filled with items from the ocular.ini file in the modules\oculars folder. his file can be edited from the Plugins menu screen or by a text editor.

Telescope Control Plugin

Telescope Control. Stellarium has a simple control mechanism for motorised telescope mounts. The user selects an object (i.e. by clicking on something - a planet, a star etc.) and presses the telescope go-to key (see section []) and the telescope will be guided to the object.

Multiple telescopes may be controlled simultaneously.

The control interface uses the Meade or the Celestron protocol and most telescopes use either one or the other so many different brands of telescopes can be controlled. There is a third party Telescope control system going under the name of ASCOM. They provide an interface to stellarium and then translate the control into many other forms

Multiple telescopes may be controlled simultaneously.

WARNING: Stellarium will not prevent your telescope from being pointed at the Sun. It is up to you to ensure proper filtering and safety measures are applied!

Satellites Plugin

Satellites. This displays a number of earth orbiting satellies. automatically updated every 72 hours from the internet.

This plug in reads information on a selected range of near earth orbiting satellites from a file satellites.json that is updated every 72 hours and displays
with a name. The file is editable with a text editor to change the colour and visibility when required.

Solar System Editor Plugin

This plugin provides a window to the Minor Planet Center where the latest Solar System information can be found. When this plugin is loaded you can select configure and the second window will appear where you can select the planet, asteroid or comet database. You can then download the latest orbital data from the MPC. This done you will be able to select the object you need and have it automatically added to the ssystem.ini file

Time Zone Plugin

TimeZoneConfiguration. Used to manipulate the time zone of the display.

Plugin's home page

Pulsars Plugin

This plugin plots the position of various pulsars, with object information about each one. Pulsar data is derived from Catalog of Pulsars (Taylor+ 1995) for 0.1.x series and derived from The ATNF Pulsar Catalogue (Manchester, R. N., Hobbs, G. B., Teoh, A. & Hobbs, M., Astron. J., 129, 1993-2006 (2005) (astro-ph/0412641)) for series 0.2.x.

Plugin's home page

Exoplanets Plugin

This plugin plots the position of stars with exoplanets. Exoplanets data is derived from "The Extrasolar Planets Encyclopaedia". List of potential habitable exoplanets and data about them were taken from "The Habitable Exoplanets Catalog" by Planetary Habitability Laboratory.

Using plugin

Enable the tool by clicking the tool-bar button "Load at startup"

Enable displaying of the stars with exoplanets on the bottom bar (or press Control+Alt+E for toggle plugin).

Find the stars with exoplanets by their designation (24 Sex as example)

Plugin's home page

Observability Analysis Plugin

Reports an analysis of source observability (rise, set, and transit times), as well as the epochs of year when the source is best observed. It assumes that a source is observable if it is above the horizon during a fraction of the night. The plugin also gives the day for largest separation from the Sun and the days of Acronychal and Cosmical rise/set.