Some information about how contributing to GCstar. Programming skills are not necessarily needed.
If some help is needed, there is a forum for developers and contributors.
- Contribute to development
- Make some translations
- Create new plugins or templates
- How to submit a contribution
To support GCstar development and contribute to its hosting fees, you may make a donation. PayPal is used and let you use your account (if you already have one) or donate directly using your payment card.
To make the donation, click on the image below:
Total donations: 339 Euros
Contribute to development
First, you need to know there is some documentation for developers.
If you wish to contribute to the development, you may consult the list of opened tasks for GCstar. Just add a comment in a task if you began to work on it or need some help.
The task has an associated difficulty. It corresponds to the required level of GCstar knowledge to work on it. If you'd like to begin to contribute to this project, it would be a good idea to have a look to tasks with a low difficulty (Really easy or Easy).
Make some translations
You may find information about this in the page about translating GCstar in other languages.
Create new plugins or templates
There are many kind of plugins and templates used by GCstar. This section list them to let you know what could be done. This requires some programming (mainly Perl) skills.
Import or export plugins
These plugins are used to import/export data from/to other softwares. More information about them in the documentation concerning conversions.
Implementing such a plugin is creating a Perl class. A template with some instructions is available in GCstar sources. Once the files have been extracted from the .tar.gz archive, a templates directory will contain these models.
To test the plugin, it has to be copied into lib/gcstar/GCImport directory (respectively lib/gcstar/GCExport). Then GCstar should be restarted. This directory are shown here relatively to where GCstar is installed. In these directory, there are also some files that could be used as examples.
They are used to find on web sites information associated to collection member. Then some fields are automatically filled.
Creating such a plugin is done as for an import or export plugin. There is also a template. Directory where the file should be copied is lib/gcstar/GCPlugins/CollectionType where CollectionType should be replace by the corresponding name (e.g. GCfilms or GCgames) because these modules depend on the collection type. There is more information in the dedicated page about writing fetch plugins.
If you wish, you could consult the list of plugins some users requested.
HTML or XML templates
These templates are used by HTML or XML export plugins. More information about them in documentation concerning conversions.
These templates must be copied into share/gcstar/html_models/CollectionType or share/gcstar/xml_models/CollectionType. As for search plugins, CollectionType should be replaced with the correct value. These directories contain also some examples that could be used as a base.
GCstar skins let user change the graphical interface. They use the standard format for Gtk+ resource files (gtkrc).
Some examples are in share/gcstar/style.
How to submit a contribution
When a contribution is finished, it could be submited so it may be added in GCstar releases. Create a new topic in forum for developers and contributors. Your submission could be attached to this topic. where a file may be attached.