Synfig Studio :: Documentation - User contributions [en]

Doc:Cut-out Animation

2016-07-01T05:15:09Z

VeganaiZe: spelling

{{Title|Cut-out Animation}}
{{TOCright}}
{{Category|Manual}}
{{Category|Tutorials}}
{{Category|Tutorials Intermediate}}
{{NewTerminology}}

{{Note|Cut-out Animation using Group Transformation Widget|Version 1.x series users, check here the {{l|Doc:Cut-out_Animation_using_Group_Transformation_Widget}} tutorial.}}

This is brief tutorial to show how create cut-out style animations. Usually cut-out style animations use image art instead of vector art to create the animation. See South Park series. You should obtain some kind of animation like this one:

{{l|Image:Cutoutsample.gif}}

== Preparing the material ==
For a cut out animation you'll need some images that represent the moving parts of the animation. For this example I've prepared a Simpsons like boy. You can take the images from {{l|Media:Cutout-sample.zip|this file}}. It also has the final sifz animation result.

{{l|Image:Boy-split.png|right|thumb|A character split into parts}}

Each part of the body (head, arms, legs, etc.) is a single PNG file. (In the split image, the individual images are composited in a bigger one). I've set all the files to have the same horizontal and vertical dimensions so all the images can fit one over the other to create the character without the need to adjust their sizes or positions. It will help later to import each image into Synfig.

{{Note|Directly in SynfigStudio|Take a look to the {{l|Cutout_Tool}}. A special tool to easily select a piece of a composition by adding a mask.}}

== Importing the cut out images ==

This is as simple as going to the Caret Menu and selecting File->Import and the proper file for each part of the character. After repeating this process for each of the image files of your character you should obtain what is shown below:

When you do the tutorial you'll notice that all the image layers have the same dimensions. The boundary of each image layer is the rectangle with the green handles shown. The bounding boxes of all the layers coincide since I expressly created each image with those dimensions and properly placed. It will allow us to do the following: Select all the layers ({{Shortcut|CTRL|}} + click each layer in the layer list) and go to the Top-Left and Bottom-Right parameters (they get greyed) in the parameter list. Make right-click -> Link on each one of the Top-Left, Bottom-Right parameter. It will link all the boundaries of the image layers to maintain them at the same relative position. This will prevent any accidental modification of the image edges and subsequently avoid any improper image deformation.

[[File:CutOut Animation 1 0.63.06.png|frame|center]]

Obviously the layer order is important so place each part of the character to compose it properly (in this case the left leg is behind the right one).

== Group the image layers ==

As you can imagine we are going to use Rotate Layers to perform the cut out animation. But before applying the rotation for each part of the character, we need to group it so that the rotation only applies to the desired layers. After grouping and renaming the group layers, it looks like this:

[[File:CutOut Animation 2 0.63.06.png|right|thumb|Layers dialog after grouping]]

== Add the Rotate Layers ==

Before adding the Rotate Layers you should have analyzed your character. You need to have figured out the mechanical framework which the character's movements are bound by; the mechanics of the character's ''skeleton''. For a simple humanoid character one considers the hip as the center of the rotation of the whole skeleton. Each limb rotates relative to the hip's rotation. Also each sub-limb should rotate relative to its parent and the parent relative to the hip (we use the hip as the root ''bone'').

In our current example, the body will rotate relative to the hip and the head relative to the body. When the character's hip is rotated there needs to be an identical rotation of the body. The head needs to rotate with the torso and additionally with the hip. This cumulative effect of rotating limbs and sub-limbs is known as the limb hierarchy. The head also needs its own individual rotation which won't affect any other limb.

Let's start by adding a Rotate Layer to the hip. Go to the hip group layer and select the hip image layer. Insert a new Rotate layer (File->Layer->New Layer->Transform->Rotate) just above the hip image layer. Rename the layer to 'Rotate hip'. Now go to the Rotate Layer parameters dialog and select the Amount parameter. This parameter governs the angle of rotation. Export that parameter (right click) and give a proper name (hip).

Now to set up the rotation layer. You should have noticed that there is a Origin parameter in the Rotation Layer, this is the origin of the rotation. It is very important that you set the origin to the proper position, allowing proper rotation of the image layers. So in this case you need to place the origin of rotation at the center of the character's hips. As another important example, arms will rotate about the shoulder and not about the hand.

{|align = "center"
|'''Before'''||'''After'''
|-
|[[File:CutOut Animation 3 0.63.06.png|400px|thumb|Original hip origin placement]] || [[File:CutOut Animation 4 0.63.06.png|400px|thumb|After, hip origin in proper position ]]
|}

{|align = "center"
| Now consider our reasoning: ''When the character's hip is rotated there needs to be an identical rotation of the body. The head needs to rotate the with the torso and additionally with the hip''. Another way to put this would be that each limb bears it's own rotation, plus the rotations of those limbs higher up the limb hierarchy. To effect this you should add the same rotation layer to all the limbs that depend on the hip rotation. Copy and paste the ''Rotate hip'' layer to all the grouped image layers. Remember that the rotation parameter is exported, and so will the value shared between all the pasted rotation layers, giving our desired effect. All the limbs will now rotate in congruence with the hip. Magic! See the image. || [[File:CutOut Animation 5 0.63.06.png|thumb|After copy the Rotate hip layer over all the image layers]]
|}

For each of the next level limbs we need an additional individual Rotation Layer. The next level limbs are: the legs and the body. We need to add a Rotation Layer for each next level limb. You should repeat the same process for each one: Add the Rotate Layer, rename it, export the Amount parameter (very important) and place Origin to the proper rotation place.

After doing that for the legs and for the body you should obtain something like this:

[[File:CutOut Animation 6 0.63.06.png|frame|center]]

Notice that fortunately you have exported the Amount parameter for each added rotation layer. So all the copies of the Rotate hip layer share the same rotation. The same applies to the other rotation layers (body and legs).

Since the arms and the head are children limbs of the body they should suffer the same rotation as the body. Repeat the same for the body rotation layer and copy it over the arms and the head image layers.

Now you can imagine how this works. You need now an additional rotation layer for the rest of the limbs to produce its individual rotation. So repeat the steps of Add a Rotate Layer, rename it, export the Amount parameter and center the Origin. You should obtain something like this:

[[File:CutOut Animation 7 0.63.06.png|frame|center]]

== Now animate it! ==

It is time to animate the character!. You can go to the Library Panel and expand the ValueBase Nodes and select any of the already exported parameters (angles). Alternatively you can select the parameter itself from the proper layer. It will set the angle handle at the proper position showing the altered position and angle due to the nested rotations performed for each sub-limb. You can do use of the {{l|Sets Panel|Set feature}} of Synfig to select multiple scattered layers with only one double click.

[[File:CutOut Animation 8 0.63.06.png|frame|center]]

Don't move the origin of any layer! If you do, you will break the composition.

Notice that I've prepared the individual images with a rounded hidden area (look again at the split character image and see what I mean). This allows us to make rotations without revealing sharp corners.

== Tips & Tricks ==

Herb, in the [http://www.synfig.org/forums/viewtopic.php?f=8&t=852 forum], give a "Ball joint style construction". It's a simple solution to mask the lines of two intersecting shapes.
You can use a circle of same color, not a {{l|Region Layer|region}} or {{l|Outline Layer|outline layer}}. The circle must cover intersecting lines and be above ({{l|Z_Depth_Parameter|z}}) both shapes in layers. Rotation {{l|Handle|handles}} origins are close to origins of the circles. {{l|Linking}} them are optional and needs some tweaking of position when done. Here is a leg Herb had construct using this method.

[[File:CutOut Animation 9 0.63.06.png|frame|center]]

----

For alternative set-ups and its pros and cons, see the {{l|Talk:Cut-out_Animation|talk page}}.

Doc:Cut-out Animation

2016-07-01T03:33:35Z

VeganaiZe: spelling

{{Title|Cut-out Animation}}
{{TOCright}}
{{Category|Manual}}
{{Category|Tutorials}}
{{Category|Tutorials Intermediate}}
{{NewTerminology}}

{{Note|Cut-out Animation using Group Transformation Widget|Version 1.x series users, check here the {{l|Doc:Cut-out_Animation_using_Group_Transformation_Widget}} tutorial.}}

This is brief tutorial to show how create cut-out style animations. Usually cut-out style animations use image art instead of vector art to create the animation. See South Park series. You should obtain some kind of animation like this one:

{{l|Image:Cutoutsample.gif}}

== Preparing the material ==
For a cut out animation you'll need some images that represent the moving parts of the animation. For this example I've prepared a Simpsons like boy. You can take the images from {{l|Media:Cutout-sample.zip|this file}}. It also has the final sifz animation result.

{{l|Image:Boy-split.png|right|thumb|A character split into parts}}

Each part of the body (head, arms, legs, etc.) is a single PNG file. (In the split image, the individual images are composited in a bigger one). I've set all the files to have the same horizontal and vertical dimensions so all the images can fit one over the other to create the character without the need to adjust their sizes or positions. It will help later to import each image into Synfig.

{{Note|Directly in SynfigStudio|Take a look to the {{l|Cutout_Tool}}. A special tool to easily select a piece of a composition by adding a mask.}}

== Importing the cut out images ==

This is as simple as going to the Caret Menu and selecting File->Import and the proper file for each part of the character. After repeating this process for each of the image files of your character you should obtain what is shown below:

When you do the tutorial you'll notice that all the image layers have the same dimensions. The boundary of each image layer is the rectangle with the green handles shown. The bounding boxes of all the layers coincide since I expressly created each image with those dimensions and properly placed. It will allow us to do the following: Select all the layers ({{Shortcut|CTRL|}} + click each layer in the layer list) and go to the Top-Left and Bottom-Right parameters (they get greyed) in the parameter list. Make right-click -> Link on each one of the Top-Left, Bottom-Right parameter. It will link all the boundaries of the image layers to maintain them at the same relative position. This will prevent any accidental modification of the image edges and subsequently avoid any improper image deformation.

[[File:CutOut Animation 1 0.63.06.png|frame|center]]

Obviously the layer order is important to place each part of the character to compose it properly (in this case the left leg is behind the right one).

== Group the image layers ==

As you can imagine we are going to use Rotate Layers to perform the cut out animation. But before applying the rotation for each part of the character, we need to group it so that the rotation only applies to the desired layers. After grouping and renaming the group layers, it looks like this:

[[File:CutOut Animation 2 0.63.06.png|right|thumb|Layers dialog after grouping]]

== Add the Rotate Layers ==

Before adding the Rotate Layers you should have analysed your character. You need to have figured out the mechanical framework which the character's movements are bound by, the mechanics of the character's ''skeleton''. For a simple humanoid character one considers the hip as the center of the rotation of the whole skeleton. Each limb rotates relative to the hip's rotation. Also each sub-limb should rotate relative to its parent and the parent relative to the hip (we use the hip as the root ''bone'').

In our current example, the body will rotate relative to the hip and the head relative to the body. When the character's hip is rotated there needs to be an identical rotation of the body. The head needs to rotate with the torso and additionally with the hip. This cummulative effect of rotating limbs and sub-limbs is known as the limb hierarchy. The head also needs its own individual rotation which won't affect any other limb.

Let's start by adding a Rotate Layer to the hip. Go to the hip group layer and select the hip image layer. Insert a new Rotate layer (File->Layer->New Layer->Transform->Rotate) just above the hip image layer. Rename the layer to 'Rotate hip'. Now go to the Rotate Layer parameters dialog and select the Amount parameter. This parameter governs the angle of rotation. Export that parameter (right click) and give a proper name (hip).

Now to set up the rotation layer. You should have noticed that there is a Origin parameter in the Rotation Layer, this is the origin of the rotation. It is very important that you set the origin to the proper position, allowing proper rotation of the image layers, so in this case you need to place the origin of rotation at the center of the character's hips. As another important example, arms will rotate about the shoulder and not about the hand.

{|align = "center"
|'''Before'''||'''After'''
|-
|[[File:CutOut Animation 3 0.63.06.png|400px|thumb|Original hip origin placement]] || [[File:CutOut Animation 4 0.63.06.png|400px|thumb|After, hip origin in proper position ]]
|}

{|align = "center"
| Now consider our reasoning: ''When the character's hip is rotated there needs to be an identical rotation of the body. The head needs to rotate the with the torso and additionally with the hip''. Another way to put this would be that each limb bears it's own rotation, plus the rotations of those limbs higher up the limb hierachy. To effect this you should add the same rotation layer to all the limbs that depend on the hip rotation. Copy and paste the ''Rotate hip'' layer to all the grouped image layers. Remember that the rotation parameter is exported, and so will the value shared between all the pasted rotation layers, giving our desired effect. All the limbs will now rotate in congruently with the hip. Magic! See the image. || [[File:CutOut Animation 5 0.63.06.png|thumb|After copy the Rotate hip layer over all the image layers]]
|}

For each next level limbs we need an additional individual Rotation Layer. The next level limbs are: the legs and the body. We need to add a Rotation Layer for each next level limb. You should repeat the same process for each one: Add the Rotate Layer, rename it, export the Amount parameter (very important) and place Origin to the proper rotation place.

After doing that for the legs and for the body you should obtain something like this:

[[File:CutOut Animation 6 0.63.06.png|frame|center]]

Notice that fortunately you have exported the Amount parameter for each added rotation layer. So all the copies of the Rotate hip layer share the same rotation. The same applies to the other rotation layers (body and legs).

Since the arms and the head are children limbs of the body they should suffer the same rotation as the body. Repeat the same for the body rotation layer and copy it over the arms and the head image layers.

Now you can imagine how this works. You need now an additional rotation layer for the rest of the limbs to produce its individual rotation. So repeat the steps of Add a Rotate Layer, rename it, export the Amount parameter and center the Origin. You should obtain something like this:

[[File:CutOut Animation 7 0.63.06.png|frame|center]]

== Now animate it! ==

It is time to animate the character!. You can go to the Library Panel and expand the ValueBase Nodes and select any of the already exported parameters (angles). Alternatively you can select the parameter itself from the proper layer. It will set the angle handle at the proper position showing the altered position and angle due to the nested rotations performed for each sub-limb. You can do use of the {{l|Sets Panel|Set feature}} of Synfig to select multiple scattered layers with only one double click.

[[File:CutOut Animation 8 0.63.06.png|frame|center]]

Don't move the origin of any layer! If you do, you will break the composition.

Notice that I've prepared the individual images with a rounded hidden area (look again at the split character image and see what I mean). This allows us to make rotations without revealing sharp corners.

== Tips & Tricks ==

Herb, in the [http://www.synfig.org/forums/viewtopic.php?f=8&t=852 forum], give a "Ball joint style construction". It's a simple solution to mask the lines of two intersecting shapes.
You can use a circle of same color, not a {{l|Region Layer|region}} or {{l|Outline Layer|outline layer}}. The circle must cover intersecting lines and be above ({{l|Z_Depth_Parameter|z}}) both shapes in layers. Rotation {{l|Handle|handles}} origins are close to origins of the circles. {{l|Linking}} them are optional and needs some tweaking of position when done. Here is a leg Herb had construct using this method.

[[File:CutOut Animation 9 0.63.06.png|frame|center]]

----

For alternative set-ups and its pros and cons, see the {{l|Talk:Cut-out_Animation|talk page}}.

Doc:Synfig Studio vs Synfig

2016-03-29T06:17:58Z

VeganaiZe:

{{Title|Synfig Studio vs Synfig}}
{{Category|Manual}}
{{Navigation|Category:Manual}}
{{NewTerminology}}


In the Synfig Project there are two main tools:
* Synfig: The command line renderer
* Synfig Studio: The graphical user interface (GUI)

Both applications use the synfig libraries to render the output animation. The first one (Synfig) just converts an animation composition into a movie file and the second one (Synfig Studio) is a GUI that helps the user to create the animation composition and save it to a source file.

==Synfig Animation file format==

It is not the interest of this article to show you the {{l|Sif_Format|synfig animation file format}}. For the moment you should only need to know that the file extension is .sif and that it is an XML formatted text file. For space saving it is saved and loaded in gzip format under the extension of .sifz.
If you're interested in learning more about synfig file format or want to contribute to its definition visit {{l|Sif_Format|this page}}.

== Synfig the CLI renderer==

Although {{l|Synfig CLI syntax|Synfig CLI}} (command line interface) is an independent application from Synfig Studio it is worth it to have it installed in your system. In fact, both share the same libraries to produce the output renders, one (the GUI) to the screen output and also to the file output and the other (the CLI) just the file output.
The syntax of usage is the typical one with optional parameters that just need an input file and an output filename in most of the cases.
One of the things that makes synfig CLI great is the ability to render large files without take your computer with your attention. Also if the render is quite long and there is any possible error (for example power supply) you can always continue rendering later, using the CLI, where the animation render ended (this is only possible if you use an image sequence render target). It is explained in some of the tips of the {{l|Tips}} page.
Also, for modern computers with several cores, if you tell to the renderer the proper values, you can run several simultaneous instances to drastically decrease the render time. It has not been developed yet but it is possible to create render farms to decrease render time for huge movies.

Understanding and learning the Synfig CLI syntax is not very difficult. Once you understand the basic concepts of Synfig by using Synfig Studio you will dominate the Synfig CLI quickly.

== Synfig Studio ==

Synfig Studio is a graphical user interface that is used to create new animations. With Synfig Studio you can:

* Create a new animation from scratch.
* Import external resources: single images, image sequences, other vectorial files (SVG) and even videos (at the moment through ffmpeg).
* Export the animation into a movie file or into a animated graphic or a image sequence.
* Edit several files at the same time.
* Reference external sif files and create a macro composition.
* Preview the animation.
* Redo and undo the operations performed during edition.

Synfig Studio interface is a bit complex when you watch it for the very first time. But after a while, and after learning the animation work flow you feel comfortable with, you'll understand "why things are like that" ;-)

If you're impatient and want to go straight to knowing the interface of Synfig Studio see this {{l|Quick Overview|quick visual overview}}.
But it is more interesting to discover, step by step, the meaning of the Synfig Studio components and its usage.

Further reading:
* Principles of Animation with Synfig Studio
* Synfig Studio Work Flow
* Advanced Techniques

Doc:Synfig Studio vs Synfig

2016-03-29T06:12:21Z

VeganaiZe:

{{Title|Synfig Studio vs Synfig}}
{{Category|Manual}}
{{Navigation|Category:Manual}}
{{NewTerminology}}


In the Synfig Project there are two main tools:
* Synfig: The command line renderer
* Synfig Studio: The graphical user interface (GUI)

Both applications use the synfig libraries to render the output animation. The first one (Synfig) just converts an animation composition into a movie file and the second one (Synfig Studio) is a GUI that helps the user to create the animation composition and save it to a source file.

==Synfig Animation file format==

It is not the interest of this article to show you the {{l|Sif_Format|synfig animation file format}}. For the moment you should only need to know that the file extension is .sif and that it is an XML formatted text file. For space saving it is saved and loaded in gzip format under the extension of .sifz.
If you're interested in learning more about synfig file format or want to contribute to its definition visit {{l|Sif_Format|this page}}.

== Synfig the CLI renderer==

Although {{l|Synfig CLI syntax|Synfig CLI}} (command line interface) is an independent application from Synfig Studio it is worth it to have it installed in your system. In fact, both share the same libraries to produce the output renders, one (the GUI) to the screen output and also to the file output and the other (the CLI) just the file output.
The syntax of usage is the typical one with optional parameters that just need an input file and an output filename in most of the cases.
One of the things that makes synfig CLI great is the ability to render large files without take your computer with your attention. Also if the render is quite long and there is any possible error (for example power supply) you can always continue rendering later, using the CLI, where the animation render ended (this is only possible if you use an image sequence render target). It is explained in some of the tips of the {{l|Tips}} page.
Also, for modern computers with several cores, if you tell to the renderer the proper values, you can run several simultaneous instances to drastically decrease the render time. It has not been developed yet but it is possible to create render farms to decrease render time for huge movies.

Understanding and learning the Synfig CLI syntax is not very difficult. Once you understand the basic concepts of Synfig by using Synfig Studio you will domain Synfig CLI quickly.

== Synfig Studio ==

Synfig Studio is a graphical user interface that is used to create new animations. With Synfig Studio you can:

* Create a new animation from scratch.
* Import external resources: single images, image sequences, other vectorial files (SVG) and even videos (at the moment through ffmpeg).
* Export the animation into a movie file or into a animated graphic or a image sequence.
* Edit several files at the same time.
* Reference external sif files and create a macro composition.
* Preview the animation.
* Redo and undo the operations performed during edition.

Synfig Studio interface is a bit complex when you watch it for the very first time. But after a while, and after learning the animation work flow you feel comfortable with, you'll understand "why things are like that" ;-)

If you're impatient and want to go straight to knowing the interface of Synfig Studio see this {{l|Quick Overview|quick visual overview}}.
But it is more interesting discover, step by step, the meaning of the Synfig Studio components and its usage.

Further reading:
* Principles of Animation with Synfig Studio
* Synfig Studio Work Flow
* Advanced Techniques

Dev:MSYS2 Build

2016-03-20T22:57:34Z

VeganaiZe:

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

* ''These steps should be improved, but they seem to work for now...''

* ''The following 'pacman' command is incomplete... Refer to other wiki build pages for more dependecies...''
<pre>
$ pacman -S \
git \
nano \
base-devel \
mingw-w64-`uname -m`-binutils \
mingw-w64-`uname -m`-boost \
mingw-w64-`uname -m`-cairo \
mingw-w64-`uname -m`-cairomm \
mingw-w64-`uname -m`-ccache \
mingw-w64-`uname -m`-crt-git \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-freetype \
mingw-w64-`uname -m`-gcc \
mingw-w64-`uname -m`-glibmm \
mingw-w64-`uname -m`-gtk2 \
mingw-w64-`uname -m`-gtk3 \
mingw-w64-`uname -m`-gtkmm \
mingw-w64-`uname -m`-gtkmm3 \
mingw-w64-`uname -m`-ilmbase \
mingw-w64-`uname -m`-imagemagick \
mingw-w64-`uname -m`-libpng \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-make \
mingw-w64-`uname -m`-mesa \
mingw-w64-`uname -m`-libmng \
mingw-w64-`uname -m`-nsis \
mingw-w64-`uname -m`-nsis-nsisunz \
mingw-w64-`uname -m`-opencl-headers \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-pangomm \
mingw-w64-`uname -m`-pkg-config \
mingw-w64-`uname -m`-png2ico \

$ pacman -Ss <package> # Search for <package>
</pre>

=== MLT ===

<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=`uname -m`-w64-mingw32 \
--host=`uname -m`-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>

Dev:MSYS2 Build

2016-03-20T22:56:11Z

VeganaiZe: Pacman/MSYS2

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

* ''These steps should be improved, but they seem to work for now...''

* ''The following 'pacman' command is incomplete... Refer to other wiki build pages for more dependecies...''
<pre>
$ pacman -S \
git \
nano \
base-devel \
mingw-w64-`uname -m`-binutils \
mingw-w64-`uname -m`-boost \
mingw-w64-`uname -m`-cairo \
mingw-w64-`uname -m`-cairomm \
mingw-w64-`uname -m`-ccache \
mingw-w64-`uname -m`-crt-git \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-freetype \
mingw-w64-`uname -m`-gcc \
mingw-w64-`uname -m`-glibmm \
mingw-w64-`uname -m`-gtk2 \
mingw-w64-`uname -m`-gtk3 \
mingw-w64-`uname -m`-gtkmm \
mingw-w64-`uname -m`-gtkmm3 \
mingw-w64-`uname -m`-ilmbase \
mingw-w64-`uname -m`-imagemagick \
mingw-w64-`uname -m`-libpng \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-make \
mingw-w64-`uname -m`-mesa \
mingw-w64-`uname -m`libmng \
mingw-w64-`uname -m`-nsis \
mingw-w64-`uname -m`-nsis-nsisunz \
mingw-w64-`uname -m`-opencl-headers \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-pangomm \
mingw-w64-`uname -m`-pkg-config \
mingw-w64-`uname -m`-png2ico \

$ pacman -Ss <package> # Search for <package>
</pre>

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=`uname -m`-w64-mingw32 \
--host=`uname -m`-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>

Dev:MSYS2 Build

2016-03-20T04:48:45Z

VeganaiZe: /* ETL */

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

* ''These steps should be improved, but they seem to work for now...''

* ''The following 'pacman' command is incomplete... Refer to other wiki build pages for more dependecies...''
<pre>
$ pacman -S \
git \
pkg-config \
libltdl \
mingw-w64-`uname -m`-boost \
mingw-w64-`uname -m`-libpng \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-png2ico \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-mesa \
mingw-w64-`uname -m`-ccache \
mingw-w64-`uname -m`-nsis \
mingw-w64-`uname -m`-nsis-nsisunz \
mingw-w64-`uname -m`-imagemagick \
mingw-w64-`uname -m`-gtk2 \
mingw-w64-`uname -m`-gtk3 \
mingw-w64-`uname -m`-gtkmm \
mingw-w64-`uname -m`-gtkmm3 \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-cairomm \
mingw-w64-`uname -m`-glibmm \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-pangomm \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-gettext \
mingw-w64-`uname -m`-gcc \
mingw-w64-`uname -m`-opencl-headers \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-ilmbase \
mingw-w64-`uname -m`-opencl-headers

$ pacman -Ss <package> # Search for <package>
</pre>

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=`uname -m`-w64-mingw32 \
--host=`uname -m`-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Dev:MSYS2 Build

2016-03-20T04:47:29Z

VeganaiZe: Pacman packages

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

* ''These steps should be improved, but they seem to work for now...''

* ''The following 'pacman' command is incomplete... Refer to other wiki build pages for more dependecies...''
<pre>
$ pacman -S \
git \
pkg-config \
libltdl \
mingw-w64-`uname -m`-boost \
mingw-w64-`uname -m`-libpng \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-png2ico \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-mesa \
mingw-w64-`uname -m`-ccache \
mingw-w64-`uname -m`-nsis \
mingw-w64-`uname -m`-nsis-nsisunz \
mingw-w64-`uname -m`-imagemagick \
mingw-w64-`uname -m`-gtk2 \
mingw-w64-`uname -m`-gtk3 \
mingw-w64-`uname -m`-gtkmm \
mingw-w64-`uname -m`-gtkmm3 \
mingw-w64-`uname -m`-libsigc++ \
mingw-w64-`uname -m`-cairomm \
mingw-w64-`uname -m`-glibmm \
mingw-w64-`uname -m`-libxml++ \
mingw-w64-`uname -m`-pangomm \
mingw-w64-`uname -m`-libtool \
mingw-w64-`uname -m`-gettext \
mingw-w64-`uname -m`-gcc \
mingw-w64-`uname -m`-opencl-headers \
mingw-w64-`uname -m`-openexr \
mingw-w64-`uname -m`-ilmbase \
mingw-w64-`uname -m`-opencl-headers

$ pacman -Ss <package> # Search for <package>
</pre>

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Dev:Build Instructions

2016-03-20T04:00:21Z

VeganaiZe: Grammar correction & MSYS2 link

{{Title|Build Instructions}}
{{Category|Manual}}


Some information may be outdated, please have a look in the forums at the [http://www.synfig.org/forums/viewforum.php?f=13 build thread] to get fresh data...

== Scripts provided with the source code ==

Within the source code we provide two automatic package scripts. They are used to generate the library independent packages for Linux or Mac OSX. Since the scripts ship all the needed libraries in a single package the size of the packages are higher compared to the typical deb or rpm package. That's not the case for dmg package for OSX because in general they bundle all needed libraries in the dmg image.

You can find those scripts under the ''autobuild'' folder from the source code. There are usage instruction inside each script allowing resuming builds (reusing the current downloaded libraries) and specific options to just compile and build the binaries without package them.

===Staged boost library===
To use the autobuild scripts with a staged boost library, you will need to define environment variables:
$ export BOOST_ROOT=/my/boost/path
$ export CPLUS_INCLUDE_PATH="$CPLUS_INCLUDE_PATH:$BOOST_ROOT/include"
$ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$BOOST_ROOT/lib"

===Debug build===
Consider, that you can run in the following way to enable debug:
$ DEBUG=1 ./synfigstudio-linux-build.sh

In this case you can combine debug with other modes:
$ DEBUG=1 ./synfigstudio-linux-build.sh quick # just invokes "make install" for every component
$ DEBUG=1 ./synfigstudio-linux-build.sh synfig # builds synfig-core only
$ DEBUG=1 ./synfigstudio-linux-build.sh synfigstudio # builds synfig-studio only

== Notes ==

* If you are using the released versions instead of GIT, none of the libtoolize or autoreconf steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* If you are using packages for synfig's dependencies, you want the '''development packages''' not the main packages. Check below for your distribution's packages.

* Please read the {{l|Dev:Source code|source code}} page to check out the latest code. Please also check the {{l|Download|download page}} and the {{l|FAQ}} to find out about any issues that you may run into along the way.

* Some Linux/BSD distros (Like Gentoo Linux) have a pkg-config that doesn't look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* Don't use automake 1.4, there are problems with it.

* Using automake 1.9, 'make install' seems to re-link and re-install all the synfig core modules every time whether they have changed or not. If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single 'synfig' folder where the three main modules (etl, synfig-core and synfig-studio) are up to date. '''The trunk folder has been removed in the git tree'''. Please modify the build instructions for other platforms.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/HEAD
origin/genete_bones
origin/genete_canvasview
origin/genete_master
origin/genete_onionskin
origin/genete_scale_reverse
origin/genete_setup_dialog
origin/genete_svg
origin/gerco_opengl
origin/master
origin/uiomae_opengl
origin/zelgadis_cia
origin/zelgadis_master
</pre>

Then to properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout it. For example:
<pre>
~/synfig$ git branch --track test_canvas origin/genete_canvasview
~/synfig$ git checkout test_canvas
</pre>

Your code is ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory using sudo, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

** export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
** export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
** export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.

And when you run ./configure, run it with <pre>--prefix $prefix</pre> and don't use sudo when you do make install.

* See the automatic building script attached.

== System-specific instructions ==
Please update them including the new GIT repo.

* Gentoo: {{l|Dev:Gentoo Ebuilds|ebuilds}} are available for both release versions and GIT
* MacOS X: {{l|Dev:Building_On_Mac_OS_X|instructions for building}} with the GTK+ Aqua port are available.
* PCLinuxOS: {{l|Dev:PCLinuxOS build instructions|build instructions}}
* Windows: {{l|Dev:Building on Windows|instructions for building}} with {{l|Dev:Mingw_installation|mingw}} in {{l|Dev:MSYS2_Build|MSYS2}} are available.

==System wide build Instructions==

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 
* Debian: build-essential autoconf automake libtool
* OS X: already included with Mac OS X

''Type the following commands at the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force
$ ./configure
$ sudo make install
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 
* Debian: etl-dev libxml++2.6-dev libsigc++-2.0-dev libltdl3-dev libtool gettext cvs autopoint
* Fedora: ETL-devel libxml++-devel libsigc++20-devel libtool-ltdl-devel libtool gettext-devel cvs
* Gentoo: dev-cpp/ETL dev-cpp/libxmlpp dev-libs/libsigc++ dev-util/cvs
** If you are using ./configure --prefix="$PREFIX" to configure synfig, do not install dev-cpp/ETL.
*OS X use glibtoolize instead of libtoolize, as Apple renamed it.

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files). The package is libpng12-dev on Debian or media-libs/libpng on Gentoo.

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2, as shipped with ubuntu 8.10. To work around the problem until a proper fix is found, comment out line 622 or thereabouts (it says "AC_CONFIG_SUBDIRS(libltdl)") by putting a "#" at the front of the line. The line is required for older versions of libtool, as shipped with other distributions. DO it straight with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 
* Debian: libpng12-dev libmng-dev libjpeg62-dev libfreetype6-dev libfontconfig1-dev libopenexr-dev libavcodec-dev libavformat-dev libswscale-dev libmagick++9-dev
* Gentoo: sys-devel/libtool media-libs/libpng media-libs/libmng media-libs/jpeg media-libs/freetype media-libs/fontconfig media-libs/openexr media-libs/tiff
*Ubuntu (since Jaunty): Same libraries as Debian but do not use libmagick++9-dev, use graphicsmagick-libmagick-dev-compat instead.

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)
* Debian: libdv-bin ffmpeg imagemagick
* Gentoo: media-libs/libdv media-video/ffmpeg media-gfx/imagemagick

''Type the following commands at the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force
$ ./configure
$ make
$ sudo make install
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 
* Debian: etl-dev libsynfig-dev libgtkmm-2.4-dev libgtk2.0-dev libglibmm-2.4-dev libsigc++-2.0-dev libltdl3-dev libtool gettext cvs
* Gentoo: virtual/ETL virtual/synfig dev-cpp/gtkmm-2.4 dev-libs/libsigc++ sys-devel/libtool
** If you are using ./configure --prefix="$PREFIX" to configure synfigstudio, do not install virtual/ETL or virtual/synfig.
''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* Debian: ttf-freefont ttf-dejavu ttf-dustin
* Gentoo: freefonts dejavu

''Type the following commands at the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh
$ ./configure
$ make
$ sudo make install
</pre>



== finalizing ==

Depending on where you installed synfig to, you might have to tell your system where the libraries can be found. That can be done via the following command:

<pre>
$ sudo ldconfig
</pre>

== Build script examples ==

If you want to build a binary for testing or debugging proposes you can run one of the following scripts:

The binaries are installed at $(pwd)/install/bin. Alter the script according to your preferences.

Your system must satisfy synfig's build requirements, the script won't do it for you. Also be sure what git branch are you building each time. In some cases you'll need to make clean on each folder first.

Be sure that '''you have ccache installed''' on your system because you will get errors otherwise.

=== Linux ===
<pre>
#!/bin/sh
CPUS=4
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
# Uncomment this line if you want to use ccache
# export CXX="/usr/bin/ccache g++-snapshot"

cd ETL &&
autoreconf --install --force &&
./configure --prefix $prefix &&
make --debug=b install &&
\
cd ../synfig-core &&
libtoolize --copy --force &&
autoreconf --install --force &&
./configure --prefix $prefix --enable-optimization=0 --enable-debug &&
make --debug=b -j $CPUS install &&
\
cd ../synfig-studio &&
./bootstrap.sh &&
./configure --prefix $prefix --enable-optimization=0 --enable-debug &&
make --debug=b -j $CPUS install
</pre>

With libboost no standard installation to /personal/boost/install/path/ :

<pre>
#!/bin/sh
#move to synfig folder (to get the script out from git)
cd synfig
CPUS=2
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"

cd ETL &&
autoreconf --install --force &&
./configure --prefix $prefix &&
make install &&
\
cd ../synfig-core &&
libtoolize --ltdl --copy --force &&
autoreconf --install --force &&
./configure --with-boost=/personal/boost/install/path/boost_1_55_0 --enable-optimization=0 --prefix $prefix --enable-debug &&
make -j $CPUS install &&
\
cd ../synfig-studio &&
autoreconf --install --force &&
intltoolize --force --copy &&
./configure --enable-optimization=0 --prefix $prefix --enable-debug &&
make -j $CPUS install
</pre>

=== Mac OSX ===
<pre>
#!/bin/sh
CPUS=4
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export ACLOCAL_FLAGS="-I $prefix/share/aclocal"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
# Uncomment those line if you want to use g++ instead of the native clang
# compiler and preprocessor
#export CXX="/opt/local/bin/ccache /usr/bin/g++"
#export CPP="/usr/bin/cpp"
export CPPFLAGS="-I/opt/local/include"
export LDFLAGS="-L/opt/local/lib"

cd ETL &&
autoreconf --install --force &&
./configure --prefix $prefix &&
make --debug=b install &&
\
cd ../synfig-core &&
libtoolize --copy --force &&
autoreconf --install --force &&
./configure --prefix $prefix --enable-optimization=0 --enable-debug &&
make --debug=b -j $CPUS install &&
\
cd ../synfig-studio &&
./bootstrap.sh &&
./configure --prefix $prefix --enable-optimization=0 --enable-debug &&
make --debug=b -j $CPUS install
</pre>

Dev:MSYS2 Build

2016-03-19T01:19:47Z

VeganaiZe:

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

* ''These steps should be improved, but they seem to work for now...''

* ''The following 'pacman' command is incomplete... Refer to other wiki build pages for more dependecies...''
<pre>
$ pacman -S \
mingw-w64-x86_64-boost \
mingw-w64-x86_64-libpng \
mingw-w64-x86_64-libxml++ \
mingw-w64-x86_64-libsigc++ \
libltdl \
libtool \
gettext \
gcc \
pkg-config \
mesa \
mingw-w64-x86_64-opencl-headers \
ccache \

$ pacman -Ss <package> # Search for <package>
</pre>

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Dev:MSYS2 Build

2016-03-19T01:16:38Z

VeganaiZe:

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

* ''These steps should be improved, (ie. SDL_image issue) but they seem to work for now...''

<pre>
$ pacman -S \
mingw-w64-x86_64-boost \
mingw-w64-x86_64-libpng \
mingw-w64-x86_64-libxml++ \
mingw-w64-x86_64-libsigc++ \
libltdl \
libtool \
gettext \
gcc \
pkg-config \
mesa \
mingw-w64-x86_64-opencl-headers \
ccache \

</pre>

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Dev:MSYS2 Build

2016-03-19T01:12:17Z

VeganaiZe: More info

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single '''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_cairo
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

* export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
* export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
* export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.
 
And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

* ''These steps should be improved, (ie. SDL_image issue) but they seem to work for now...''

=== MLT ===
''This step may not be necessary.''
<pre>
https://sourceforge.net/projects/mlt/files/latest/download?source=files

$ tar xvf mlt-6*.tar.gz
$ cd mlt-6.0.0/

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw32 \
--disable-debug \
--disable-frei0r \
--without-kde \
--disable-sdl \
$ make
$ make install
</pre>

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32

$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force

$ ./configure --prefix=/mingw64 \
--build=x86_64-w64-mingw32 \
--host=x86_64-w64-mingw32 \
--with-boost-libdir=/mingw64/lib

$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?

$ ./configure --prefix=/mingw64 --build=x86_64-w64-mingw32 --host=x86_64-w64-mingw3

$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Dev:MSYS2 Build

2016-03-19T00:55:57Z

VeganaiZe: Created initial MSYS2 build instructions

{{Title|MSYS2 Build Instructions - Synfig wiki}}
{{Category|Manual}}


== Notes ==

* If you are using the released versions instead of GIT, none of the '''libtoolize''' or '''autoreconf''' steps are necessary. For released versions, "./configure && make && sudo make install" should be enough.

* '''pkg-config''' might not look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

* If you intend to build code repetitively you can export export CXX="/usr/bin/ccache /usr/bin/g++". This allows to not rebuild the already build modules so they taken from the cache.

* After you obtain the source code using the git repository, you obtain a single ''''synfig/''' folder where the three main modules ('''ETL''', '''synfig-core''' and '''synfig-studio''') are up to date.

* If you want to test a particular branch of the repository do the following:
<pre>
~/synfig$ git branch -r
</pre>
You'll obtain a list of the remote branches that exists in the repo. For example:
<pre>
origin/0.64.2
origin/0.64.x
origin/1.0.x
origin/HEAD -> origin/master
origin/dev-1.0.1
origin/eldruin_new_cairo_core
origin/eldruin_transformation_matrix
origin/genete_cairo_core
origin/genete_new_cairo_core
origin/master
</pre>

To properly checkout a remote branch you have to create a local branch to track a particular remote branch and checkout. For example:
<pre>
~/synfig$ git branch --track test_cairo origin/eldruin_new_cairo_core
~/synfig$ git checkout test_canvas
</pre>

Your code is now ready to be built on that branch.

* The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

* If you don't want to install to a system-wide directory, run something like these commands before starting:

<pre>
prefix=$(pwd)/install
export PKG_CONFIG_PATH="$prefix/lib/pkgconfig"
export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH
export CXX="/usr/bin/ccache /usr/bin/g++"
</pre>

** export PKG_CONFIG_PATH="$prefix/lib/pkgconfig" allows to find the linking libraries.
** export PATH=$(pwd)/synfig-core/src/tool/.libs:$PATH allows synfigstudio find the correct * libraries to render the icons for the toolbox etc.
** export CXX="/usr/bin/ccache /usr/bin/g++" allows to use the cache to avoid rebuilding.

And when you run '''./configure''', run it with: <pre>--prefix $prefix</pre>

==System wide build Instructions==

=== ETL ===

ETL is a template library, there is nothing to build really, it just needs to be installed.

'''Requires''': autoconf automake 

''Type the following commands at the directory where you cloned the git repo''
<pre>
$ cd synfig/ETL
$ autoreconf --install --force
$ ./configure
$ make install # Optional
</pre>

=== synfig-core ===

'''Requires''': ETL (etl-dev, already installed if you successfully built etl), libxml++, libsigc++, libltdl, libtool, gettext, autopoint (part of gettext-dev), cvs, boost-program-options 

'''Note''': libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files).

'''Note''': the 'configure.ac' file in the synfig-core directory doesn't work with libtool version 2; put a "#" at the front of the line with this command:
<pre> sed -i 's/^AC_CONFIG_SUBDIRS/# AC_CONFIG_SUBDIRS/' synfig-core/configure.ac </pre>

'''Optional''': libpng, libmng, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary) 

'''Runtime''': encodedv (from libdv), ffmpeg, convert (from imagemagick)

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-core
$ libtoolize --copy --force
$ autoreconf --install --force
$ ./configure
$ make
$ make install # Optional
</pre>

''Note'':

* Don't use --enable-half, it is slow.
* If ETL was installed in a non-standard directory using --prefix=<location>, it suffices to run the configure script with an updated PKG_CONFIG_PATH environment variable. E.g.: PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:/my/install/prefix/lib/pkgconfig ./configure --prefix=/my/install/prefix

=== synfig-studio ===

''Requires'': ETL (etl-dev, already installed if you successfully built etl), synfig (libsynfig-dev, already installed if you successfully built synfig-core), gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs, intltool, libboost >= 1.53, libcairo >= 1.12 

''Optional'': fonts (for the images), [http://www.fmod.org FMOD] (version 3.x, proprietary)
* ttf-freefont ttf-dejavu ttf-dustin
* freefonts dejavu

''Type the following commands from the directory where you cloned the git repo''
<pre>
$ cd synfig/synfig-studio
$ ./bootstrap.sh # Necessary?
$ ./configure
$ make
$ make install # Optional
</pre>



=== MSYS2 - Mingw64 ===

1. Follow the instructions to install MSYS2 here:
https://msys2.github.io/

"MinGW-w64 Win64 Shell"

Writer Documentation

2016-03-19T00:27:55Z

VeganaiZe: Grammatical corrections

{{Title|Writer Documentation}}
{{TOCright}}

= Getting Started =
To add an additional page (and also {{l|Meta:Translation|translated}} pages) just call the page by editing the address in your browser.
You'll then see a page telling you that this page currently doesn't exist and you can click on {{literal|Create}} at the top menu. If you don't feel comfortable doing changes in the mains pages, you can start by submitting your changes in the {{Literal|Discussion}} pages ( {{Shortcut|Alt|Shift|t}}). There you are...

= Editor Documentation =
* General Conventions
** {{l|Meta:General Documentation Style}}
** {{l|Meta:ScreenShots}}
** {{l|Meta:Synfig Naming Conventions}}

* Wiki
** {{l|Meta:Wiki Structure}}
** {{l|Meta:Template Style And Syntax}}
** {{l|Wiki Improvements}}

* {{l|Meta:Translation}}

= Administrator Documentation =
* {{l|Meta:Templates}}
* {{l|Meta:How to add support for new language}}

= Marketing/Sales Documentation =
* {{l|Meta:Writing Press Releases}}

= Pages Currently Developed =
These pages are currently under development and do not show up on the official documentation:
* {{l|Writer_Documentation#.28in_progress.29_2015_-_Rewrite_for_1.x_series|Rewrite for 1.x series}}
* {{l|Writer_Documentation#.28todo.29_2015_-_Wikification_of_Genete.27s_stuff|Wikification of Genete's stuff}}
* {{l|Writer_Documentation#.28in_progress.29_2013_-_Terminology_rewrite_sprint|Terminology rewrite sprint}}

= Projects =

== (in progress) 2015 - Rewrite for 1.x series==

In order to update the documentation to follow the 1.0 release, a '''major revision of the documention''' is needed.

In some cases, draft work has already been done in the '''Talk''' section of the pages.

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the '''screenshots''' must also be done...see howto in next paragraph.

The documentation can be now rewritten directly on the Pages (It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously)

=== Where to start ===
* {{l|Doc:Interface}}
* {{l|Canvas}}
* {{l|Category:Canvas_Window}}
* {{l|Dock dialogs}} : and everything related to dock system should be rewritten
* Something about jack synchro
* A sound layer tutorial
* A jack tutorial
* {{l|Tool_Options_Panel}} (see talk)
* {{l|Category:File_Menu_%28Toolbox%29}} : in progress
* {{l|Category:Toolbox_Menu}} : in progress
* {{l|Help_Menu}} : in progress
* {{l|Toolbox}}
* and : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

===How to do the Screenshots ===
For complete recommendations on screenshot creation, see the synfig studio documentation : {{l|Meta:ScreenShots}}

* Please make screenshots in default light theme.
* Please keep image width under ~1000px.
* Use generic file notation : image_file_name_current.png. Example ''File:Render_settings_Dialog_current.png'' ‎used in [[Render_dialog]] (to take advantage of the upgrade image system)

===Terminology===
It's possible (and certain) that around the corners, some terminologies have been updated with all the GUI's recent changes. Some parts of the documentation may not reflect all the changes. If you find some... feel free to correct them in wiki original page (+ your native langage?) ! (and add it to this list for helping the translation into other languages)

{|border="1" align="none"
|-style="background:#silver"
|'''Old Terminology'''||'''New Terminology'''||'''Where'''
|-
||Children Lock
||{{l|Lock Selection}}
||{{l|Group Layer}} and Swicth Group Layer
|-
||
||
||
|}

== (todo) 2015 - Wikification of Genete's stuff ==
A lot of documentation resources have been produced by Genete. They are hosted in the cloud. Some of it should be hosted in the wiki, in the dev, or tutorial or .... sections.

* [https://drive.google.com/folderview?id=0Bx8g_H3f7qpZZDExNjU0NmEtZWI2Mi00M2UzLWI2OWQtNDUyYmRhOGRiN2Qx&usp=sharing Genete Stuff].

''please, log here any progress to avoid duplicate work''

== (done) 2014-2015 - Rewrite preparation for future release 1.0==

The documentation can be now rewritten directly on the Page. It's no longer necessary to use the Talk Pages nor the "Rewrite preparation for 0.65" has modification comment has suggested previously.

Have a look at what has already been initiated : http://wiki.synfig.org/wiki/index.php?title=Special%3ASearch&profile=advanced&search=rewrite+0.65&fulltext=Search&ns0=1&ns1=1&profile=advanced

According the synfigstudio 1.0 single window (and other changes) UI a global review and update of the screenshots must be done...

(No more useful) <strike>Write inside Talk:Pages the new feature that will be available in synfig 1.0 in order to not do ''visible modification'' until next release is out.</strike>

(No more useful)<strike> Suggested workflow : use "Rewrite preparation for 0.65" has modification comment, and add "Rewrite preparation for 0.65" sentence inside the Talk Page (to get an easy way to retrieve all the pages who need to be updated once 1.0 will be out)</strike>

== (in progress) 2013 - Terminology rewrite sprint ==
Have a look in the Forum [http://www.synfig.org/forums/viewtopic.php?f=25&t=4056] for more information.

* (''[http://www.synfig.org/forums/viewtopic.php?f=1&t=4056&start=75#p18012 done]'') - {{l|Dev:Sprints/2013-01-07_Reworked_Terminology|Terminology}} step of original (English) doc .
* ''(done - overdated by 1.0 work)'' - {{l|Dev:Sprints/2013-02-19_Screenshots_Update|Screenshot Update}} step
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18930 done])'' - Approve terminology change step on reference page (english)
* ''([http://synfig.org/forums/viewtopic.php?f=1&t=4056&start=150#p18985 done])'' - Signal translation pages outdated
* ''(done)'' - Banner with the instructions to all translation pages not updated with new terminology
* ''(done)'' - Some translation pages have to be renamed. For example "Params Panel/ru" have to become "Parameters Panel/ru". Only admins can do that.
* ''('''todo''')'' - Find a way to work on translation pages outdated
* ''('''todo''')'' - Update the translations step