Dev:Contribute to Code

2008-07-08T10:25:41Z

Gordebak: /* Things you want to know about the code */

[[Category:Code]]
== Introduction ==

You should know by the [[History|history]], that this program was initially written by an animation company, [[History|Voria Studios]]. Since the code of Synfig was released under [[License|GPL licence]] and turned into an open source project, there have been made some modifications to the code, which allows you to remove bugs and to add some new functionality.

The only documentation you can get, is the source-code itself and the automatically generated [http://synfig.org/api/ API docs] by [http://www.doxygen.org doxygen].
This page tries to collect all the knowledge acquired by the current developers and to create typical guides for common tasks which would allow you to add new features and make the program grow.

Feel free to add here all the information you can get from the experience of reading and modifying the source code or simply add your request to get more details from coders more familiar with the source. Hopefully they will be able to tell you, how it works and where to dive in.

== Common tasks ==

Please add here links to wiki pages where it is explained how to do common tasks to contribut to code. Don't paste here things you want to know or need help. Use the other section for that.

* [[Source:Adding a Layer|Adding Layers to Synfig]]: this guide aids you to understand, how the layers work and how to add a new layer type.
* [[Source:Adding a Panel-Part I| Adding Panels to Synfigstudio]]: This guide explains, how to add a new panel and the objects on it.

== Things you want to know about the code ==

Please add here a brief description of the things you want to know about the code and how to accomplish some task. Someone else will surely know it, and can help you to start developing on synfig.

* Is there anywhere any kind of overview? Any sort of brief description of what each program does/is? Is synfigstudio the GUI for synfig? What's the ETL?
* Is it a sane project to port Synfig ui to Qt?

==Documenting the code ==

It would be a good thing, if all the code documentation and what is being discovered were confirmed and inserted directly in the source code itself. This would allow [http://www.doxygen.org doxygen] to generate the [http://synfig.org/api/ API docs] easily.

Please follow these [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen rules] to add documentation to the source code.

== Getting the source ==

Check out the [[Source code|source code]] page.

Requested Tutorials

2007-12-15T21:50:08Z

Gordebak:

== Requested Tutorials ==

* Explanation of the difference between waypoints and keyframes. (Meanwhile someone writes this requested tutorial you can have a look to [[Keyframe | keyframes]] and [[Waypoints|waypoints]] pages).
* Making a ball bounce- tutorial
* How to rotate objects.
* Make an object to follow a path given by a mathematical function. This is applicable to ball-bounce-tutorial.
* How to change the location of a shape's pivot point. Or a cut-out animation tutorial. (I think I worked it out, making the rotation by rotation layers. Kinda wierd, but actually it is there.)
* How to generate a slideshow (x seconds per picture) from a bunch of pictures.

Requested Tutorials

2007-12-11T06:27:03Z

Gordebak:

Synfig Studio :: Documentation - User contributions [en]

Dev:Contribute to Code

Requested Tutorials

Requested Tutorials