Plugin Development - Revision history

Daggerstab: Reverted edits by Jamesbzr (talk) to last revision by Alexwolf

2011-06-02T19:02:32Z

Reverted edits by Jamesbzr (talk) to last revision by Alexwolf

Jamesbzr: /* Writing plugins */

2011-06-02T17:15:34Z

Writing plugins

Alexwolf at 04:05, 25 May 2011

2011-05-25T04:05:24Z

Lee Carré: /* Writing plugins */ linkification

2011-02-17T14:31:54Z

Writing plugins: linkification

Lee Carré: /* Writing plugins */ more accessible/usable link text

2011-02-17T14:28:23Z

Writing plugins: more accessible/usable link text

Lee Carré: /* Writing plugins */ linkification, typography, semantics (definition list & ‘code’ elements), copyediting/grammar

2011-02-17T14:23:40Z

Writing plugins: linkification, typography, semantics (definition list & ‘code’ elements), copyediting/grammar

Daggerstab: /* Windows */

2011-01-14T18:44:09Z

Windows

Daggerstab: /* Windows dynamic linking error */

2010-10-15T12:23:44Z

Windows dynamic linking error

Daggerstab: updating the page

2010-10-11T08:32:33Z

updating the page

Barrykgerdes: /* Windows */

2009-09-18T01:03:37Z

Windows

@@ Line 13: / Line 13: @@
 Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice, for an independent plug-in, is to make it dynamic.
-If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of [http://www.launchpad.net/stellarium/ Stellarium in Launchpad], develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like]) [http://www.diamondlinks.net/ Link Building]
+If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of [http://www.launchpad.net/stellarium/ Stellarium in Launchpad], develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like])
 ==Example code==

@@ Line 13: / Line 13: @@
 Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice, for an independent plug-in, is to make it dynamic.
-If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of [http://www.launchpad.net/stellarium/ Stellarium in Launchpad], develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like])
+If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of [http://www.launchpad.net/stellarium/ Stellarium in Launchpad], develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like]) [http://www.diamondlinks.net/ Link Building]
 ==Example code==

@@ Line 23: / Line 23: @@
 ==Building and installing==
-These instructions apply only for dynamic plug-ins.
+These instructions apply only for dynamic plug-ins. Instructions for static plug-ins you can found [[Static Plugin Development|here]].
 ===Linux===
 *Build the core Stellarium code according to the [[Compilation on Linux]] page.  Make sure the build sub-directory is called ''builds/unix''.

@@ Line 13: / Line 13: @@
 Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice, for an independent plug-in, is to make it dynamic.
-If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of Stellarium in Launchpad, develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like])
+If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of [http://www.launchpad.net/stellarium/ Stellarium in Launchpad], develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like])
 ==Example code==

@@ Line 11: / Line 11: @@
 As Stellarium’s plug-in interface has changed over time, plug-ins for different versions are not interchangeable. This is the reason why the official plug-ins have been linked statically to the official release.
-Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice for independent plug-in is to make it dynamic.
+Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice, for an independent plug-in, is to make it dynamic.
-If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of Stellarium in Launchpad, develop the plug-in in it and propose the branch for a merge into the trunk when you are read. (Example what such a branch looks like: [http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer])
+If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of Stellarium in Launchpad, develop the plug-in in it and propose the branch for a merge into the trunk when you are read. ([http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer Example of what such a branch looks like])
 ==Example code==

@@ Line 1: / Line 1: @@
 ==Writing plugins==
-If you are a developer, and would like to have a go at writing your own Stellarium plugin, the following resources might be helpful:
+If you are a developer, and would like to have a go at writing your own Stellarium plugin(s), the following resources might be helpful:
 * the [[Plugins]] page in this wiki and the pages that it links to
-* the [http://www.stellarium.org/doc/head/plugins.html "Plugins" page in Stellarium's online developers' documentation] (as of 11 October 2010, it is sadly outdated)
+* the [http://www.stellarium.org/doc/head/plugins.html “Plugins” page in Stellarium’s online developers’ documentation] (as of 11 October 2010, it is sadly outdated)
-* the [https://lists.sourceforge.net/lists/listinfo/stellarium-pubdevel stellarium-pubdevel] mailing list - please fee free to subscribe and post questions there
+* the [http://lists.sourceforge.net/lists/listinfo/stellarium-pubdevel stellarium-pubdevel] mailing list — please fee free to subscribe and post questions there
 Plug-ins can be compiled and used in two different ways:
-* '''dynamic plug-ins''' are stand-alone dynamic libraries (separate files with .so extension on Linux, .dll in Windows or .dylib on Mac OS X) that are loaded at run-time by Stellarium. This allows plug-ins to be are distributed separately from Stellarium.
+;Dynamic plug-ins:Stand-alone dynamic libraries (separate files with <code>.so</code> extension on [[GNU+Linux]], <code>.dll</code> in [[Windows]] or <code>.dylib</code> on [[Mac OS X]]) that are loaded at run-time by Stellarium. This allows plug-ins to be are distributed separately from Stellarium.
-* '''static plug-ins''' are linked statically at build-time. They become "built-in", a part of Stellarium's binary files. This is used to release fixed versions of some "official" plug-ins together with Stellarium's releases.
+;Static plug-ins:Linked statically at build-time. They become “built-in”, a part of Stellarium’s binary files. This is used to release fixed versions of some “official” plug-ins together with Stellarium’s releases.
-As Stellarium's plug-in interface has changed over time, plug-ins for different versions are not interchangeable. This is the reason why the official plug-ins have been linked statically to the official release.
+As Stellarium’s plug-in interface has changed over time, plug-ins for different versions are not interchangeable. This is the reason why the official plug-ins have been linked statically to the official release.
-Nothing stops you from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice for independent plug-in is to make it dynamic.
+Nothing prevents someone from developing an independent static plug-in, but have in mind that this requires building a custom version of Stellarium. A much better choice for independent plug-in is to make it dynamic.
-If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to create a personal Bazaar branch of Stellarium in Launchpad, develop the plug-in in it and propose the branch for a merge into the trunk when you are read. (Example what such a branch looks like: [http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer])
+If you want to propose a new plug-in to be added to the official ones and distributed with Stellarium, the best choice is to start a personal <code>Bazaar</code> branch of Stellarium in Launchpad, develop the plug-in in it and propose the branch for a merge into the trunk when you are read. (Example what such a branch looks like: [http://code.launchpad.net/~daggerstab/stellarium/comets-asteroids-importer])
 ==Example code==

@@ Line 53: / Line 53: @@
   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.
 == Tips ==

@@ Line 55: / Line 55: @@
 *NOTE: If the plugin source has been loaded into a clean folder the first call on Cmake -G "MSYS Makefiles" ../.. will generate a basic cmakecache.txt file. This may need to be edited to provide some more information. Some need to be directed to the boost files and the location of the path to qmake Qt/4.5.2/bin/qmake.exe. There is now a requirement to nominate whether to build the static or dynamic module. Also the generated lib??????.a file name will need to be the same as the file called in the stellarium//cmakecache.txt file
-== Windows dynamic linking error ==
+== Tips ==
 If a plugin uses a class that inherits a Stellarium class that contains the Q_OBJECT macro (for example, a dialog windows that inherits StelDialog), Stellarium will refuse to load it on Windows, returning an "Invalid access to memory location" error. The workaround is to copy the parent class (for example, StelDialog) to the plugin's sources and rename it appropriately.

@@ Line 22: / Line 22: @@
   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
+  cd /c/msys/1.0/home/bob/stel-plugins/<name of plugin>
   mkdir -p builds/msys
   cd builds/msys