Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure

Plugins

Introduction

Plugins are extensions to Stellarium which are dynamically loaded into to the program at runtime.

Plugins are potentially more powerful than scripts, but are more difficult to write and maintain. Unlike scripts, Plugins must be compiled for a specific platform, and will typically only be compatible with a particular version of Stellarium. We hope that the plugin system will allow third party developers to write extensions to Stellarium which might not otherwise be included in the core program, and that the system will allow for prototyping of new features before inclusion into the core.

Stellarium plugins are created from C++ code compiled separately as a dynamic library ( .so on linux, .dll in windows or .dylib on MacOSX). A plugin should contain a main class deriving from the StelModule class as well as an instance of the StelPluginInterface which allows stellarium to dynamically load it. At startup, the StelModuleMgr will load the library (provided that the .dll is put at the proper place in the stellarium file tree), and an instance of the StelModule it contains will be instanciated and added to the list of other "normal" StelModules.

Plugin developers - please note that while plugins are linked at runtime, classes used in plugins must inherit code from the core which is published under the GUN GPL. If you distribute a binary plugin, you must do so under the terms of the GNU GPL license. No sneaky closed-source shenanigans now.

Example Plugins

There are a few plugins which are written by and maintained by the Stellarium developer team.

Building Plugins

The following instructions can be used to build the Angle Measure plugin and the Compass Marks plugin.

To install the plugin on Linux systems, simple add a make install command after the make. This will copy the necessary files to $HOME/.stellarium/modules/AngleMeasure.

To install a plugin on Windows or OSX, you should locate the [[User Data Directory]], and then create a sub-directory called modules in it. Inside this, create a subdirectory named for the plugin, e.g. AngleMeasure. Into this directory, you should copy the following files:


Generated on Mon Mar 22 09:55:38 2010 for Stellarium by  doxygen 1.5.5