Built-in Plugins

(Difference between revisions)
Jump to: navigation, search
m
Line 3: Line 3:
  
 
==Enabling plugins==
 
==Enabling plugins==
<div style="float:right">
+
<div style="float:right; margin:5px;">
 
http://stellarium.org/wikiimg/sat_howto_01.jpg
 
http://stellarium.org/wikiimg/sat_howto_01.jpg
 
</div>
 
</div>
Line 15: Line 15:
  
 
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.
 
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 <tt>catalog.json</tt> file for identification of catalog for typical plugin.
 +
 +
You can modify the <tt>catalog.json</tt> files manually using a text editor. '''If you are using Windows, it is strongly recommended to use an advanced text editor such as [http://notepad-plus-plus.org/ 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 <tt>catalog.json</tt> 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 <tt>catalog.json</tt> file is something like:
 +
{{user data directory|modules\<Plugin name>|modules/<Plugin name>}}
  
 
<br style="clear:both"/>
 
<br style="clear:both"/>

Revision as of 08:23, 15 August 2013

Information is actual for version 0.12.2

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

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.

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:

  • C:\Users\UserName\AppData\Roaming\Stellarium\modules\<Plugin name> (Windows Vista, Windows 7)
  • C:\Documents and Settings\UserName\Application Data\Stellarium\modules\<Plugin name> (Windows XP)
  • HomeDirectory/Library/Preferences/Stellarium/modules/<Plugin name> (Mac OS X)
  • ~/.stellarium/modules/<Plugin name> (Linux)

(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.)



Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox