Plugin Development

(Difference between revisions)

Jump to: navigation, search

Revision as of 10:58, 23 March 2009

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

make install

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

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.

If you are a developer, and would like to have a go at writing your own Stellarium plugin, the following resources might be helpful:

the "Plugins" page in Stellarium's online developers' documentation
The existing plugin's source code in subversion browse it here
The stellarium-pubdevel mailing list - please fee free to subscribe and post questions there

@@ Line 1: / Line 1: @@
-==Existing plugins==
-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
-*[[CompassMarks plugin|Compass Marks]] - add marks for compass bearings along the horizon
-*[[Ocular plugin|Ocular]] - simulate the view through various telescope eyepeices
-*[[TextUserInterface plugin|Text User Interface]] - re-implements the old TUI (useful for planetarium users)
-*[[Satellites plugin|Satellites]] - calculates and renders Satallites in Earth orbit from NORAD/TLE data (hello ISS!)
-*[http://archive.eso.org/cms/tools-documentation/visual-archive-browser VirGO] - The ESO-sponsored archive browsing and visualization tool
-==Pre-built plugins==
-See the [[Download]] page / plugins section.
 ==Building and installing==
 ===Linux===