Synfig Studio :: Documentation - User contributions [en]

Z Depth Parameter

2020-12-03T13:46:51Z

Zelgadis: Reverted edits by Want (talk) to last revision by D.j.a.y

{{Category|Parameters}}
{{NewTerminology}}

{{note|Warning, [http://www.synfig.org/issues/thebuggenie/synfig/issues/868 actually] broken in some cases|[http://www.synfig.org/issues/thebuggenie/synfig/issues/868 Bug report #868] - Z-Depth not affected by time offset : a layer z depth parameter animation is not affected by a time offset manipulation of the group is included to. }}
This parameter can be used to change the 'depth' (order) of a layer in the layer stack, or of a Bone in a {{l|Skeleton Layer}}.

By default, each canvas gives its layers zdepths which depend on their order in the canvas. The first layer has a depth of 0, the 2nd has a depth of 1, and so on.

Zdepth may be thought of as an indication of the distance to an observer: layers with a lower zdepth are 'nearer' to an observer than layers with a higher zdepth.

The Z Depth parameter on each layer can be used to adjust this default depth. The value of the Z Depth parameter is added to the layer's 'natural' depth, given by its order in its canvas.

For example, suppose we have 2 layers, first a circle, and then a rectangle. The circle will have a 'natural' depth of 0, and the rectangle's will be 1, so the circle will be drawn on top of the rectangle.

If we use the parameters dialog to set the rectangle's zdepth to -2, however, -2 will be added to its natural depth of 1, giving a new depth of -1, and so it will be drawn above the circle.

The parameter can be animated, so that layers change order throughout the animation.

Here's an example which shows the Z Depth parameter being animated to bring one circle in front of another at a certain point in time:

{{l|Image:Offset-z-depth-revisited.gif}}
{{l|Media:Offset-z-depth-revisited.sifz|source sif file}}

== Too Much Detail ==

If you want to see a more complex Z depth order animation and an explanation to how it was done please watch this animation and this PDF file.

Animation: http://www.youtube.com/watch?v=YTpSfUthuVE

Project : ''{{File:Zdepth-balls.sifz}}'' [[File:Zdepth-balls.sifz]]

Explanatory PDF file: http://www.darthfurby.com/genete/synfig/Balls.pdf

Same file but ODT format: http://www.darthfurby.com/genete/synfig/Ballsv2.odt

Widget:AdSenseBlock

2020-05-03T04:52:05Z

Zelgadis: Remove adsense blocks

<noinclude>__NOTOC__
Notification for top and bottom page placement.
</noinclude><includeonly>
</includeonly>

Doc:Plugins

2020-05-01T10:37:44Z

Zelgadis: Page is moved to https://synfig.readthedocs.io/en/latest/plugins.html

This page is moved to https://synfig.readthedocs.io/en/latest/plugins.html

Doc:Plugins

2020-04-30T11:25:49Z

Zelgadis: Reverted edits by Zelgadis (talk) to last revision by Glax

{{Title|Plugins}}
{{Category|Manual}}
{{NewTerminology}}


= Summary =
The Plugins feature allows to run custom python scripts directly from Synfig Studio menu. Each script takes .sif file as first argument and should modify its contents in some way. After script execution finished, the file is automatically reopened back in Synfig Studio.

With the current script feature, has it work with the file itself you can't retrieve the current {{l|Time_Cursor}} position when the script is invoked. But you can know the value of a {{l|Parameter}} or {{l|ValueNode}} at a certain time (the ones fixed by {{l|Waypoints}}), because the {{l|ValueNode#Animated ValueNodes|Animated Value Nodes}} are stored (other problem is to know the interpolated value, which is not trivial for other thing rather than {{l|Linear}} or {{l|Constant}} interpolation)

All plugins are located in the "Plug-Ins" submenu of the canvas.

= Rationale =
People often write some scripts to make useful things on Synfig (sif) files. The most of these scripts are written in python. But for ordinary users running custom scripts from terminal is tricky. With plugins feature user can install scripts as easy as they copy files and transparently run them in the same way as they use standard Synfig Studio commands. Also, runing scripts from menu is much faster than from terminal and it greatly improves the workflow for advanced users. Having this feature allows to easily add simple functions to Synfig Studio by writting scripts in python.

= How to install plugins =

Plugin is a directory, containing the python script (*.py file), plugin.xml and maybe some other files if they are required by python script.

To install the plugin user should copy its directory into the following location:

* '''Windows Vista/7/8:''' C:\Users\USERNAME\Synfig\plugins
* '''Windows XP:''' C:\Documents and Settings\USERNAME\Synfig\plugins
* '''Linux:''' ~/.config/synfig/plugins
* '''OSX:''' /Users/USERNAME/Library/Synfig/plugins

The system-wide location for the plugins is USER_DIRECTORY/SYNFIG_CONFIGURATION_DIR/plugins

== Where to find plugins ==
* [https://github.com/yoyobuae/synfig-plugins Yoyobuae:FreeForm Deform]
* [http://morevnaproject.org/2012/06/11/plugins-feature-in-synfig-studio/ Morevna:Plugins feature in Synfig Studio]
* [https://github.com/berteh/synfig-import-labels Berteh:Import Labels and Timings]
* [https://forums.synfig.org/c/development/scripting Synfig forum: scripts/plugin thread]

= Plugin structure =

A plugin keeps all its files inside a directory as described above.

Synfig parses the file called plugin.xml found in each plugin directory, which defines plugin metadata and how to invoke the script.

This section describes the xml elements available and what they do.

== <plugin> ==

Root element. Can contain the following:

<name>, <exec>, <importer>, and <exporter>.

* <name> The name of the plugin, must have at least the default version
* <exec> Script to run when the user clicks on the Plugin menu. Can be omitted if there are importers or exporters
* <exporter> Defines an exporter, a plugin can have multiple of these
* <importer> Defines an importer, a plugin can have multiple of these

== <name> ==

Name of the plugin, can be specified multiple times to provide translations

Example:
<pre>
<name>This is the default name</name>
<name xml:lang="it">This is name it will show if you set Italian as your language</name>
</pre>

== <exec> ==

Defines a script to run, the text contents must be a path (relative to the plugin directory) of a script to run.

If present inside <plugin>, the plugin will be shown in the Plugins menu, and the script will be invoked when you click on the corresponding menu item.

It has a few attributes, all optional.

{|class=wikitable
!name
!default
!effect
|-
!type
|python
|selects the interpreter (currently only Python is supported)
|-
!stdout
|ignore
|What to do with the script standard output:
* '''ignore''' output is discarded
* '''log''' the output is shown in the Synfig log
* '''message''' an error message is shown to the user
|-
!stderr
|message
|Same as above, but for standard error
|}

Example:
<pre>
<exec>myscript.py</exec>
</pre>

Changing stream behaviour:

<pre>
<exec stdout="log" stderr="ignore">myscript.py</exec>
</pre>

== <exporter> ==

Defines a new exporter, used to convert synfig files into other formats.

A plugin can define multiple exporters.

Exporters will be shown in the Export dialog.

The exporter contains the following sub-elements:

* <exec> must have exactly one of these
* <extension> must have at least one of them
* <description> must have the default version

Example:
<pre>
<exporter>
<extension>svg</extension>
<extension>svgz</extension>
<description>Scalable Vector Graphics (*.svg, *.svgz)</description>
<exec>svg-exporter.py</exec>
</exporter>
</pre>

== <importer> ==

Works the same as <exporter>, but provides script to convert from other formats into synfig.

A plugin can define multiple importers.

Importers will be shown in the Open file dialog.

Example:
<pre>
<importer>
<extension>svg</extension>
<extension>svgz</extension>
<description>Scalable Vector Graphics (*.svg, *.svgz)</description>
<exec>svg-exporter.py</exec>
</importer>
</pre>

== <extension> ==

For <importer> and <exporter>, which extensions are supported.

Multiple <extension> elements may be present in an importer or exporter (at least one is required)

Example:
<pre>
<extension>svg</extension>
</pre>

== <description> ==

For <importer> and <exporter>, the text to be shown in the file dialog.

Similarly to <name> this can be translated using xml:lang

Example:
<pre>
<description>Scalable Vector Graphics (*.svg, *.svgz)</description>
</pre>

= Script Invocation =

== Plugins Menu ==

For scripts run when the user clicks on the plugin name in the Plugins menu, synfig will save a copy of the open canvas and pass the path to that file as the argument to the script.

The script can then modify that file and synfig will reload the canvas to reflect any changes.

== Exporter ==

For an exporter, synfig will pass two arguments to the script: the first is the path to a synfig file containing the open canvas; the second is the file name.

== Importer ==

For an importer, synfig will pass the file selected in the open dialog as first argument, and the path to a temporary synfig file as second argument.

Once the script is completed, synfig will load that second file, so the plugin script should populate it appropriately.

= Tutorial =

<videoflash>De9UhUkzNiY|425|344</videoflash>

= Details =

Each plugin located in a separate subdirectory with unique name. The part of the name before first "-" symbol is used to set the group plugin belongs to (not implemented yet). The main information about plugin (plugins name and script to execute) is stored in the plugin.xml file. It's self-explanatory :

<pre><?xml version="1.0" encoding="UTF-8"?>
<plugin>
<name>Unhide All Layers</name>
<name xml:lang="es">Activa todas las capas</name>
<name xml:lang="eu">Erakutsi geruza guztiak</name>
<name xml:lang="eu_ES">Erakutsi geruza guztiak</name>
<name xml:lang="fr">Afficher Tous les Calques</name>
<name xml:lang="lt">Parodyti visus sluoksnius</name>
<name xml:lang="ru">Показать все скрытые слои</name>
<exec>view-unhide-all-layers.py</exec>
</plugin></pre>

view-unhide-all-layers.py :
<pre>
#!/usr/bin/env python

#
# Copyright (c) 2012 by Konstantin Dmitriev <k....z...gmail.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

import os
import sys

def process(filename):

# Read the input file
inputfile_f = open(filename, 'r')
inputfile_contents = inputfile_f.readlines()
inputfile_f.close()

# Now write results to the same file
inputfile_f = open(filename, 'w')

for line in inputfile_contents:
if "<layer " in line:
inputfile_f.write(line.replace(' active="false" ',' active="true" '))
else:
inputfile_f.write(line)
inputfile_f.close()

if len(sys.argv) < 2:
sys.exit()
else:
process(sys.argv[1])
</pre>

All scripts are interpreted with python 3.

In Linux and Mac OSX case Synfig Studio looks for "python" or "python3" binary. For windows case Python binary is expected at INSTALL_PREFIX/python/python.exe. New environment variable SYNFIG_PYTHON_BINARY allows to set custom path to the python 3 binary.

Doc:Plugins

2020-04-30T07:32:04Z

Zelgadis: Reverted edits by Glax (talk) to last revision by Zelgadis

Time Loop Layer

2020-04-07T14:00:01Z

Zelgadis: Local Time is now fixed, fix will be shipped in 1.3.14

{{Title|Time Loop Layer}}
{{Category|Layers}}
{{Category|Time}}


{{l|Image:Layer_other_timeloop_icon.png|64px}}

== About Time Loop Layers==

The {{literal|Time Loop layer}} is used to repeat an animation over and over. It loops a section of the layers below and within the same canvas over and over.

See also the {{l|Convert#Time_Loop|Time Loop ValueNode}} conversion, which can be used to loop the value of a single parameter, rather than an entire layer or group of layers.

==Parameters of Time Loop Layers==

These parameters, to '''prevent undesired modification''', by default are {{l|Static_Parameters|statics}}.

The parameters of the time loop layers are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:silver"
|'''Name'''||'''Value'''||'''Type'''
|-style="background:#"
||{{l|Image:Type_real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_time_icon.png|16px}} {{l|Time_Loop_Layer#Link_Time_.28time.29|Link Time}}
||0f
||time

|-style="background:#"
||{{l|Image:Type_time_icon.png|16px}} {{l|Time_Loop_Layer#Local_Time_.28time.29|Local Time}}
||0f
||time

|-style="background:#eeeeee"
||{{l|Image:Type_time_icon.png|16px}} {{l|Time_Loop_Layer#Duration_.28time.29|Duration}}
||1s
||time

|-style="background:#"
||{{l|Image:Type_bool_icon.png|16px}} {{l|Time_Loop_Layer#Only_For_Positive_Duration_.28bool.29|Only For Positive Duration}}
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} {{l|Time_Loop_Layer#Symmetrical_.28bool.29|Symmetrical}}
||
{| style="width:16px; height:16px" border="1"
|-
|}
||bool

|}

=== Link Time (time) ===
Start time of cycled material/child layers.

=== Local Time (time) ===
Start time of loop.

=== Duration (time) ===
Number of seconds or frames that are looped in the child layer.

=== Only For Positive Duration (bool) ===
* If checked and {{Literal|Duration}} is zero or negative, then the time loop layer is effectively disabled, and acts as if it wasn't there.
* If not checked and the Duration is zero, the Time Loop layer freezes the animation of the children layers at the value of {{Literal|Link Time}}.

=== Symmetrical (bool) ===
If not checked, and the current time is less than {{Literal|Local Time}}, then {{Literal|Duration}} is taken off the resulting time. This is to provide compatibility with {{l|Time Loop Layer (v0.1)|version 0.1}} of the time loop layer.

== How to use the Time Loop Layer ? ==

The {{literal|Time Loop layer}} repeatedly loops through the {{Literal|Duration}} seconds of its child layers, from {{Literal|Link Time}} to {{Literal|Link Time}} + {{Literal|Duration}}.

{{Literal|Local Time}} is used to line up the offset of the time looping.

When the Time Loop layer is asked to set its time to {{Literal|Local Time}}, it sets the time in its child layers to be {{Literal|Link Time}}, ie. the start of the loop.

=== Breaking loop ===

# Be Sure you are not in {{l|Animate Editing Mode|Animation Mode}}
# In the layer's parameters of the time loop, you need to remove the 'green guy' ({{l|Image:Animate mode off icon.png|16px}}), indicating that the parameter is {{literal|Static}}, from {{l|Time_Loop_Layer#Duration_.28time.29|Duration Parameter}}. Just right-click on him and set {{literal|Allow animation}}. See {{l|Static Parameters}} for more informations.
# On the {{L|Timebar|timeline}} navigate to a place where you want to break the animation. And now enter the {{l|Animate Editing Mode|Animation Mode}}.
# In the time loop parameters, set 'Duration' to {{literal|EOT}} (End-of-Time).
# Now you have three {{l|Waypoint|waypoints}}. One before the current, we left it as it is. One is current, we {{l|Convert|convert}} it to the {{literal|constant}} (right-click on it -> Both -> Constant). And one after current, this one have to be removed (right-click on it -> Remove).
# Now test it. Pay attention, that loop will always break at the very first frame of you animation, so you need to break it in the right place.

===Detailed explanation===
'Green guy' ({{l|Image:Animate mode off icon.png|16px}}) - {{l|Static Parameters}} - is a guard that says "You shall not pass!" to the animation. So when you attempt to change such parameter in animation mode it just changes the usual way. It's done to prevent unnecessary parameters to be animated, e.g. {{l|Blend Method Parameter|Blend Method}}.

Setting {{Literal|Duration}} to {{literal|EOT}}. If you set it to 0f, then the whole animation will stop, because you try to play it from 0f ({{Literal|local time}}) to 0f ({{Literal|Duration}}). And EOT means it'll continue to play your animation to the end of the time...

Removing {{l|Waypoint|waypoint}} after current one. If you skip this step, then at the next waypoint {{Literal|Duration}} parameter will be restored to the value before current waypoint. It's a standard Synfig's behavior, but there's a magical button somewhere that can change it.

Converting current waypoint to the constant. Without it, {{Literal|Duration}} will be smoothly interpolated from value you set to the EOT and the constant type will just set immediately at the waypoint. Interpolation can be a bit confusing sometimes, so you better read this about {{l|Waypoint|waypoints}}.



== Visualized Example ==

For example, suppose:
* Link Time is 5s
* Duration is 3s
* Local Time' is 4s

And suppose that the Time Loop layer is applied over an existing animation. The {{Literal|Link Time}} and {{Literal|Duration}} specify that the section from 5s to 8s in the children layers will be looped. The {{Literal|Local Time}} specifies that this loop will be at the beginning at 4s. (And so also therefore at 1s, 7s, 10s, etc).

This is how the mapping actually works:

{| border="1" cellspacing="0"
|'''real time'''||'''child time<br/>(symmetrical = true)'''||'''child time<br/>(symmetrical = false)'''
|-
| 0 || 7 || 4
|-
| 1 || 5 || 2
|-
| 2 || 6 || 3
|-
| 3 || 7 || 4
|-
| 4 || 5 || 5 (local time = 4; link time = 5)
|-
| 5 || 6 || 6
|-
| 6 || 7 || 7
|-
| 7 || 5 || 5 (duration = 3, so loop repeats after 3 seconds)
|-
| 8 || 6 || 6
|-
| 9 || 7 || 7
|-
| 10 || 5 || 5
|}

Specifying a huge number for the Duration parameter effectively turns the Time Loop layer into a Time Shift layer. The Link Time and Local Time parameters controls which time in the children lines up with which time in the Time Loop layer, giving the amount of the timeshift, with both positive and negative differences working as expected.

== Contrived Example ==

Download and examine this example file: {{l|Media:Time-loop-demo-0.2.sifz|Time-loop-demo-0.2.sifz}}

It's a 10 second animation, and shows 2 circles. The top one moves linearly from the left to the right. Its position is marked by static text digits 0 through 10.

The other circle is an identical copy of the first one, with the same waypoints, but it's inside an Group layer. The parameters are:
* Link Time: 5s
* Duration: 1.5s
* Local Time: 2s
* Symmetrical: true

So as time=2s, the top circle is at position 2 (local time) and the bottom circle is at position 5 (link time):

{{l|Image:Time-loop-demo-0.2-2s-0f.png}}

The loop is 1.5s long, so the bottom circle is also at position 5 every 1.5 seconds before and after this point in time, for example at t=3.5s and at t=8s:

{{l|Image:Time-loop-demo-0.2-3s-12f.png}}
{{l|Image:Time-loop-demo-0.2-8s-0f.png}}

The following two images show the positions at t=0s and t=3s. The loop starts at t=2s, so it's also at the start at t=0.5s. So at t=0s it's half a second before finishing the previous loop. And at t=3s the same is true, but 2 loops later on:

{{l|Image:Time-loop-demo-0.2-0s-0f.png}}
{{l|Image:Time-loop-demo-0.2-3s-0f.png}}

There's a rendered copy of this example on [http://www.youtube.com/watch?v=WyYLd7319Gw YouTube], and it's also available for download: {{l|Media:Time-loop-demo-0.2.avi‎|Time-loop-demo-0.2.avi‎}}.

Group Layer

2019-06-19T12:55:20Z

Zelgadis: /* Parameters of Group Layers */ Fix link to Outline Grow Parameter

{{Title|Group Layer}}
{{TOCright}}
{{Category|Layers}}
{{Category|Other}}
{{NewTerminology}}

{{l|Image:Layer other group icon.png|64px}}

== About Group Layers==

The {{Literal|Group Layer}} is a special layer that can hold other layers. It is generated via the {{l|Group}} command accessed via the context menu in the {{l|Layers Panel}} or through the {{l|Category:Layer Menu}} in the {{l|Canvas Menu Caret}}. As well as grouping a set of layers it can also translate them, scale them, and even modify the time for the layers it contains.

{{Literal|Group Layers}} can also be created through the {{l|Category:Layer_Menu#New_Layer_Menu|New Layer Menu}}, using {{c|<New Layer>|<Other>|Group Layer|}}.

==Parameters of Group Layers==

The parameters of the {{Literal|Group Layers}} are:

{|border="0" align="none" style="border-collapse" cellpadding="3" cellspacing="0"
|-style="background:#c8c8c8"
|'''Name'''||'''Value'''||'''Type'''
|-
||{{l|Image:Type_real_icon.png|16px}} {{l|Z Depth Parameter|Z Depth}}
||0.000000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Amount Parameter|Amount}}
||1.000000
||real

|-
||{{l|Image:type_integer_icon.png|16px}} {{l|Blend Method|Blend Method}}
||Composite
||integer

|-style="background:#eeeeee"
||{{l|Image:Type_vector_icon.png|16px}} {{l|Origin Parameter|Origin}}
||0.000000u,0.000000u
||vector

|-
||{{l|Group Layer#Transformation Parameter|Transformation}}
||0.000000, 0.000000, 0.00°, 60, 60
||transformation

|-style="background:#eeeeee"
||{{l|Image:Type canvas icon 0.63.06.png|16px}} {{l|Group Layer#Canvas Parameter|Canvas}}
||<No Image Selected>
||canvas

|-
||{{l|Image:Type_real_icon.png|16px}} {{l|Group Layer#Speed|Speed}}
||1.000000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Zoom Parameter|Zoom}}
||0.000000
||real

|-
||{{l|Image:Type_time_icon.png|16px}} {{l|Time Offset Parameter|Time Offset}}
||Of
||time

|-style="background:#eeeeee"
||{{l|Image:Type_bool_icon.png|16px}} {{l|Lock Selection}}
||
{| style="width:18px; height:16px" border="1"
|-
|}
||bool (Static)

|-
||{{l|Image:Type_vector_icon.png|16px}} {{l|Focus Point}}
||0.000000u,0.000000u
||vector

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Group Layer#Outline Grow Parameter|Outline Grow}}
||0.000000
||real

|-
||{{l|Image:Type_bool_icon.png|16px}} {{l|Group Layer#Z Depth Range Enabled|Z Range}}
||
{| style="width:18px; height:16px" border="1"
|-
|}
||bool

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Group Layer#Z Depth Range Position|Z Range Position}}
||0.000000
||real

|-
||{{l|Image:Type_real_icon.png|16px}} {{l|Group Layer#Z Depth Range Depth|Z Range Depth}}
||1.000000
||real

|-style="background:#eeeeee"
||{{l|Image:Type_real_icon.png|16px}} {{l|Group Layer#Z Depth Range Transition|Z Range Blur}}
||0.000000
||real

|}

=== Transformation Parameter ===
The {{Literal|Transformation}} parameter is a composite parameter, it hold an Offset, a rotation angle, a skew angle and a scale value for the group. The {{Literal|Transformation}} parameter is already {{l|Convert#Composite|converted to composite}} when the {{l|Group Layer}} is created and so directly expose the {{l|Offset Parameter|Offset}}, {{l|Rotation Parameter|Rotation}}, {{l|Skew Parameter|Skew}} and {{l|Scale Parameter|Scale}} subparameters.

See also {{l|Group_Transformation_Widget}}

=== Canvas Parameter ===
{{l|Image:Type canvas icon 0.63.06.png|64px}}

This is "Group" by default if the {{Literal|Group Layers}} was created by grouping other layers, or {{Literal|No Image Selected}} if it was created from the {{l|New Layer Menu}}. This parameter lets you select another canvas.

The canvas parameter presents a drop-down menu of the exported canvases, plus an extra entry called "Other...". Selecting "Other..." presents the user with a text entry box asking for the name of the canvas to use. The name typed should have the following format (where <nowiki>[ ]</nowiki> indicates an optional part, ( ) is for grouping, and * means "0 or more times"):

<nowiki> [[filename]#][:]</nowiki>''id''(:''id'')*

In its simplest form, this is just an ''id'', ie. the exported name of one of the child canvases of the current canvas.

Other possibilities are:
* if a '#' is present, the part before the '#' is interpreted as the filename of an external .sif file to use.
* if the '#' is the first character of the string (ie. the filename is blank) then the '#' is ignored, and the current canvas is used instead
* if a ':' appears before the first ''id'', it means to start at the root canvas of the current canvas
* each subsequent :id steps down into the specified child

Examples:
* '''/usr/share/doc/synfig/examples/business_card.sifz#:IndividualCard''' -- gives the absolute path to a .sifz file, and says to use the canvas that was exported from its root canvas as "IndividualCard"
* '''../../examples/business_card.sifz#:IndividualCard''' -- the same, but with a relative path to the .sifz file
* '''#:sy:head:eyes:left''' -- look in the current composition, and starting from the root, navigate down through the canvas tree. Find a child canvas of the root canvas called 'sy', look in 'sy' for a child canvas called 'head', and so on.
* ''':sy:head:eyes:left''' -- exactly as above. an empty filename is the same as not using the '#' at all
* '''eyes:left''' -- without a ':' before the first ''id'', this starts at the current canvas (presumably the Group in question is in the "head" subcanvas of the "sy" subcanvas of the root)

=== Outline Grow Parameter ===
This parameter allows to control thickness of all outline layers inside. Assigning positive value to this parameter makes all child outlines rendered thicker, while negative value makes them look thinner. This feature is very helpful for tuning outlines in complex artwork and it also allows to achieve some nice effects like constant outline width at any zoom level.

Note: The {{Literal|Outline Grow}} parameter can not be applied to exported and imported (external) Groups layers.

{{l|Image:Paste-canvas-outline-grow-param.png}}

===Z Range parameters===

====Z Depth Range Enabled====
When checked, only layers inside range are visible and the visible layers are signaled with bolded font in the {{l|Layers_Panel}}
====Z Depth Range Position====
Starting z_depth position where layers are visible
====Z Depth Range Depth====
Depth where layers are visibles in z_depth range
====Z Depth Range Transition====
Z_Depth area where layers inside are partially visible.

Example of Z Range use : http://www.youtube.com/watch?v=UPpmOz0wUY4

===Speed===
Alters the velocity group's child animated layers (not the {{literal|Group Layer}} itself)

Set it to zero, it would stop the animation. A value of one makes the animation run at normal speed and a value of two makes it run double speed. Minus one reverses the animation.

==See Also==
{{l|Switch_Group_Layer}}

Doc:Plugins

2019-03-03T15:43:38Z

Zelgadis: Fix link to scripts thread on Synfig Forums

Dev:Build Instructions

2019-02-12T15:34:20Z

Zelgadis: Link to new build instructions

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


See https://synfig-docs-dev.readthedocs.io/en/latest/common/building.html

Dev:Roadmap

2019-02-12T15:31:46Z

Zelgadis: Link to recent roadmap

{{Title|Roadmap}}

WARNING: This roadmap is outdated. See latest one here - https://synfig-docs-dev.readthedocs.io/en/latest/common/roadmap.html

=== Current Status of polishing ===
* {{L|Dev:Roadmap/Bones|Bones}} (''18/26 done'')
* {{L|Dev:Roadmap/Frame-by-frame animation (bitmap)|Frame-by-frame animation (bitmap)}} (''10/26 done'')
* {{L|Dev:Roadmap/UI|UI improvement}} (''4/7 done'')
* {{L|Dev:Roadmap/Speed|Rendering speed optimization}} (''3/11 done'')
* {{L|Dev:Roadmap/SFG Format|SFG Format}}
* {{L|Dev:Roadmap/Sound|Sound support}} (''6/10 done'')
* Video import
* Vector drawing tools
* Scripting (python) (''minimal support ready : scripts can be called from an entry menu'')
* SWF export

Take also a look to our [http://www.synfig.org/issues/thebuggenie/synfig/roadmap issue tracker roadmap]

Nota : The following list of features will NOT be subject for polishing for 1.0, but will be available as "experimental features":
* SFG container
* MyPaint integration
* Frame-by-frame animation tools
(we will focus on them after 1.0 release)

Environment Variables

2019-02-09T08:31:19Z

Zelgadis: /* Environment Variables */ Add SYNFIG_USER_SETTINGS environment variable, as requested in https://github.com/synfig/synfig/issues/716

{{Title|Environment Variables}}
{{NewTerminology}}


== Environment Variables ==

Several environment variables can be set to affect the behavior of Synfig Studio:

{| border="1" cellspacing="0"
|'''variable'''||'''description'''
|-
| SYNFIG_DISABLE_AUTOMATIC_DOCUMENT_CREATION || If no documents are specified when synfig is run, it will create a new blank document unless this variable is set.
|-
| SYNFIG_ENABLE_NEW_CANVAS_EDIT_PROPERTIES || When a new document is created, the {{l|Canvas Properties Dialog}} will only be shown if this variable is set.
|-
| SYNFIG_DISABLE_OPTIMIZE<br/>SYNFIG_DISABLE_OPTIMIZE_TRANS<br/>SYNFIG_DISABLE_REMOVE_DUPS || These three variables, when set, disable various steps of the animated gif optimization process in the magick++ module. Namely: disable optimization completely, disable optimization of transparent pixels, and disable the removal of adjacent duplicate frames respectively.
|-
| SYNFIG_DISABLE_DRAW<br/>SYNFIG_DISABLE_POLYGON<br/>SYNFIG_DISABLE_SKETCH || These can be used to disable the named tools from being shown in the {{l|Toolbox}}.
|-
| SYNFIG_ENABLE_WIDTH || If set, this enables the (mostly broken) {{l|Width Tool}} in the {{l|Toolbox}}.
|-
| SYNFIG_TIMETRACK_HEADER_HEIGHT<br/>SYNFIG_TIMETRACK_ROW_HEIGHT || These are used to change the header and row heights in the {{l|Timetrack_Panel}}. This is sometimes needed to make the timetrack panel rows line up with the parameter panel's rows.
|-
| SYNFIG_DISABLE_POPUP_WINDOWS || When set, this makes the splash screen and "one moment please" popup windows behave like regular windows - ie. they can be minimized, and covered by other windows.
|-
| SYNFIG_DISABLE_TILE_RENDER || When set, the workarea is always rendered using the scanline renderer, rather than being broken up into small square tiles which are rendered separately. This is overridden by SYNFIG_FORCE_TILE_RENDER.
|-
| SYNFIG_FORCE_TILE_RENDER || When set, the workarea is always rendered using the tile renderer, rather than being rendered in a single block. This overrides SYNFIG_DISABLE_TILE_RENDER.
|-
| SYNFIG_SHOW_TILE_OUTLINES || For debugging, this draws a red outline around each tile when using the tile renderer.
|-
| SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS || Allow the right-click context menu to be used in all the various tool states.
|-
| SYNFIG_MODULE_LIST || Specifies where to load the list of dynamic modules from.
|-
| SYNFIG_ROOT || Specifies the path to the synfig resources. It should be the directory which contains share/pixmaps/synfigstudio/ - usually /usr or /usr/local.
|-
| SYNFIG_USER_SETTINGS || Specifies the path user settings directory.
|-
| SYNFIG_TOOLS_CLEAR_SELECTION || When set, unselect all layers before creating a new layer in any of the tools (other than the {{l|Draw Tool}}, which always leaves selected layers selected so that their {{l|Handle|Handles}} can be linked to).
|-
| SYNFIG_TRANSIENT_DIALOGS || Some window managers fail to associate synfig's panels with the toolbox. Setting this can help. It seems to work quite well on Windows too, preventing the panels from taking up space on the task bar, but be careful not to minimize any of the panels, it can cause problems.
|-
| SYNFIG_DEBUG_DESTRUCTORS || Logs the sequence of destructions that go on when closing things down.
|-
| SYNFIG_SHOW_FULL_TIME_ON_FOCUS || When editing a Time field, start with the full formatted time, ie. "0h 0m 1s 0f" rather than "1s".
|-
| SYNFIG_WINDOW_POSITION_X_OFFSET<br/>SYNFIG_WINDOW_POSITION_Y_OFFSET || Added on to the stored position of each panel when studio starts up. Used to combat the pixel-by-pixel drifting that happens with some window managers.
|-
| SYNFIG_SHOW_CANVAS_PARAM_WAYPOINTS || In {{l|Group Layer|Group Layers}}, show waypoints for the Canvas parameter itself, rather than for the canvas that is the parameter's value. Experimental.
|-
| SYNFIG_KEEP_ABORTED_DRAW_LINES || In the {{l|Draw Tool}}, if you make a very fast stroke, it's not used. Synfig Studio always used to leave the unused stroke on the display until a longer stroke was made. SVN r1689 changed things so that these short strokes are immediately hidden. Setting this variable restores the previous behavior.
|-
| SYNFIG_DISABLE_OPTIMIZE_LAYER_TREE || Before starting to render a tree of layers, Synfig makes an optimized copy of the layer tree, omitting any layers that currently have an amount of 0. The aim is to make the render go faster, but it may introduce some instability into the application. Set this variable to disable the optimization step.
|}

Doc:Shiny Effects

2018-11-11T15:22:21Z

Zelgadis: test

{{Title|Shiny Effects}}
{{Category|Tutorials}}
{{Category|Tutorials Intermediate}}
{{NewTerminology}}

Somes of the screenshots needs to be updated

Shiny Effects #1 by Ceox

'''Skill Level:''' Intermediate

'''Length:''' About 30 minutes

'''Version of Synfig Studio:''' 0.61.07

In this tutorial we will make some shiny/glowy effects on your text.

It might seem long to you because there is a lot of text, but when I
first tried this out I did it in 5-10 minutes, so if you learn all the
stuff you'll be able to do it that fast as well.

== Part 1 - Designing ==

=== Step 1: Create New Document ===

We start by opening Synfig Studio and creating a new document with all
the default settings except these:
[[File:Shiny-tut_pic1.gif]]

=== Step 2: Create Text Layer ===

Now we create a new text layer. In this tutorial I'm going to use
the text "Ceox". That's not my real name, but it will have to
do. Start by adding the text layer:

[[File:Shiny-tut_pic2.gif]]

=== Step 3: Select Text Layer ===

Now you should see a "Text Layer" text in the middle of your
project. Select the text layer in the layers list, so that it is
highlighted, and you should see its parameters in the "Parameters" window,
which is on the bottom of your workspace if you haven't placed it
somewhere else. (Click on the image to enlarge it; it will open in a
new window).
[[File:Shiny-tut_pic3.gif]]

=== Step 4: Edit Text Layer ===

Now we are going to modify the text in the "Parameters" window. First
double-click on the color in the "Value" cell and choose the color you
want, with 100 "Alpha". I chose a darkish blue. Then double-click on
the "Text Layer" text, also in the "Value" cell and enter your name
into the pop-up window. After this, change the size to 50pt and the
font to Arial, both by double-clicking the field in the "Value"
cell. Here's a screenshot of all things need to be modified: (I have
darkened all the values that should be good to go by default, but if
you like you can check the others as well).
[[File:Shiny-tut_pic4.gif]]

=== Step 5: (OPTIONAL) ===

If you want some more "fancyness" on your text, create a stroke for
the text, like this step tells you. Right click on the text layer in
the layers list and choose "Duplicate Layer":
[[File:Shiny-tut_pic5.gif]]

Now you should have two "Text" layers on top of each other. Choose
the lower "Text" layer and change the color to something else what
you have on the top "Text" layer. Im am going to choose a simple
green. Now change the size of this layer to about 2-3 pt bigger than
the layer on the top, in this case to 52pt. (50pt 2pt, if you didn't
get it). Now we have a stroke for our text, though it might not be
perfectly around the text. You can fix this, my moving the lower layer
a bit. This is how my text looks like now:
[[File:Shiny-tut_pic6.gif]]

=== Step 6: ===

Now we create the first the shiny thing. Add a new layer just like we
added the text layer, by clicking on the little black arrow in the
corner of our canvas and choosing "Layer > New Layer > Gradients > Linear Gradient.
Now your canvas should be filled with
a some colored gradient. Don't worry, we will get your text back in
the next step. Which actually comes now. Choose the "Linear Gradient"
layer in the layers list and then double-click on the "Gradient"
value in the "Parameters" window, like we double-clicked in Step 4. Now
you should see a window which calls itself the "Gradient Editor". At
the bottom of this window you should see two black 'half-arrows', one
on the left side and one on the right side. Click on the one, which is
on the left side. (When the color of it changes to white, it is
selected.) Change the color to white and the "Alpha" value to 0. Now
select the arrow on the right side and do the same thing. Now insert a
new arrow (or Color Stop, what ever you want to call them) by clicking in
the center of the area, which is over the half-arrows with your right
mouse button and select "Insert Color Stop". Notice that the menu will
only appear when you keep the right mouse button pressed down. Now
select this arrow and change its color to white and its "Alpha" value
to 50. As you may have noticed by now, the alpha amount controls the
transparency of an object. Now your Gradient Editor should look like
this:

[[File:Shiny-tut_pic7.gif]]

and your canvas something like this:

[[File:Shiny-tut_pic8.gif]]

=== Step 7: ===

Rotate and scale the "Linear Gradient" layer with the "Normal Tool"
using the control points like the video shows.
[http://personal.inet.fi/musiikki/ceox/synfigtuto1/vid1.swf.html Click
here to view video. Opens up in new window.]

=== Step 8: ===

Select the "Linear Gradient" layer in the layers list and set its
"Blend Method" to "Onto" in the "Parameters" window. Now the Gradient
layer is visible only on the layers below it. Your gradient should
disappear if you placed like the video showed in the previous
step. (Not on top of the text)

[[File:Shiny-tut_pic9.gif]]

=== Step 9: ===

It's easier to do all the animations afterwards, so now we could make
the other shiny effect, which I prefer to call a 'shimmer'. We start
by taking the Spline tool ({{l|Image:draw-path_128sif.png}}) and zooming
in 400% into our canvas. You can zoom in and out in the "Navigator":
[[File:Shiny-tut_pic19.gif]]

Â Now we have to draw a new object with the Spline tool
({{l|Image:draw-path_128sif.png}}) in to some sharp corner of our
text. I chose the corner of the X, because this effect looks good on
the last character(s). So now draw a shape like this one:

(Insert a controller by pressing your left mouse button and close the
line by clicking on the first point with your right mouse button and
selecting "Loop Spline")
[[File:Shiny-tut_pic20.gif]]

=== Step 10: ===

Now zoom out to 100% again. You should now have a new layer in your
layers list:
[[File:Shiny-tut_pic10.gif]]

Select it by clicking on it. Now we have its parameters in the
"Parameters" window. Change its color to white, if it isn't it aleady. You
also have to set its "Feather" to 1pt and the "Type of Feather" to
"Box Blur". We don't want it to be visible yet so we also have to set
the "Alpha" value to 0 in the color editor. Now everything is ready
for the animation.
[[File:Shiny-tut_pic11.gif]]

== Part 2 - Animating ==

=== Step 1: ===

First we animate the "Linear Gradient" layer. Select it in the layers
list. Now you should have to have two green control points visible in
your canvas. Choose the "Normal Tool" ({{l|Image:normal_icon-full.jpg}})
and select both of those points by drawing an rectangle over
them. Open the keyframe- window by clicking on its icon (a golden key)
in the same window where the "Parameters" are. Make sure your timeline
indicator is at "0f" (the small orange line on a gray background) and
add a new keyframe by pressing on the blue icon. Move the timeline
indicator to "2s" and add a new keyframe. Now your window should look
like this:

[[File:Shiny-tut_pic12.gif]]

=== Step 2: ===

Move the time indicator to "0f" and press on the green ball in the
lower right corner of your canvas. After pressing on it, its color
changes to red, like it is in the screenshot. Now move the control
points up a bit (this doesn't affect the animation), just to create a
waypoint. Go back to "2s", where we inserted the second keyframe and
move the two green control points to the right side of your text. The
first animation has been created. You can move your timline indicator
around to see it. This should be your timeline and canvas now:
[[File:Shiny-tut_pic13.gif]]

=== Step 3: ===

Now let's group our "Linear Gradient" layer and the two "Text"
layers by selecting them all. (Select multiple layers by holding CTRL
down and selecting the layers). Then press on one of the selected
layers and choose "Group". The layers should now be grouped in
one layer with a box symbol and labeled "Group". You can open
all the layers by clicking on the small arrow on the left side of the
box- icon.

[[File:Shiny-tut_pic14.gif]]

=== Step 4: ===

I just noticed, that I screwed up and we have to make the whole
animation a bit longer. Click on the black arrow in the upper left
corner of your canvas, select "Edit" and then "Properties". A new
window should pop up. Go to the "Time" tab and then set the "End Time"
to 4s 2f.
[[File:Shiny-tut_pic15.gif]]

=== Step 5: ===

Select the "NewSpline(some number) Region" layer, place the timeline
indicator to "2s" and a add a keyframe, like in Step 2. Now repeat
this by adding keyframes also to "3s" and "4s". Move your timeline
indicator back to "2s" and press the green ball icon to get into the
animate editing mode. Now open the "Colors" window from the "Parameters"
window and set the "Alpha" value to 1. Close the window. Move the time
indicator to "3s" and set the "Alpha" value to 100 trough the
"Colors" window like before. Now move the time indicator to "4s" and
set "Alpha" to 0. Now we have the shimmer in the corner of our text
fading in and out in 2 seconds. Your timeline should now look like
this (without those texts, of course):

[[File:Shiny-tut_pic16.gif]]

=== Step 6: ===

Your animation is basically ready, but that shimmer needs some
enhancement. First add a new layer onto the "NewSpline(some number)
Region" layer, by left clicking on it and selecting "New Layer >
Transform > Rotate". A new layer named "Rotate" should appear. Now
lets group the "Rotate" and "NewSpline..." layer like in Step 3,
but just selecting the "Rotate" and "NewSpline..." layers this
time. If we wouldn't do this the rotation effect would affect our
text too, but that's not what we want. Now you should have 2 Group layers.
Open the first one by pressing on the small
white arrow next to the [box]- icon. This is what your layers list
should look like now:
[[File:Shiny-tut_pic17.gif]]

=== Step 7: ===

Select both of the layers in the opened "Inline canvas" and you should
see the outline of your shimmer and a new line, which has a green dot
and a blue dot in both ends. Move the green dot to the center of your
shimmer like this:
[[File:Shiny-tut_pic18.gif]]

=== Step 8: ===

Make sure, you're still in the "Animate Editing Mode" (the ball in the
bottom left corner of your canvas is red, if you are), place your
timeline indicator to "2s" and select only the "Rotate" layer. Now
you have to set the "Amount" value to 0.01 in the "Parameters" window,
just to set the waypoint. Move the timeline indicator to "3s" and set
the "Amount" value to 180 (for 180 degrees) and then move the
timeline indicator to "4s" and the "Amount" value to 359.

Congratulations, you are done!

Here's the Synfig Studio file:
[[File:Shiny_Effects_Tutorial_1_by_Ceox.sif]]

And here's the final result:

[[File:Shiny-tut_animation.gif]]

Hope this tutorial helped you with something :)

For further questions, contact me at ceoxmusic (at) gmail (dot) com

[http://ceox.urli.net Ceox] |
[http://personal.inet.fi/musiikki/ceox/synfigtuto1/ HTML version]

Doc:Troubleshooting Synfig on OSX

2018-05-15T16:35:07Z

Zelgadis: Update instructions

Some users have problems with running Synfig on OSX. If you downloaded our [http://www.synfig.org/cms/en/download/ official DMG package] and it doesn't start then you can troubleshoot the problem by following instructions on this page.

Follow these steps:

# Reboot your Mac.
# Open DMG package you downloaded and double-click SynfigStudio app to run it (this step is necessary even if nothing happens after that).
# If it doesn't run and no error message is given, then open terminal window and execute the following command:
/tmp/skl/SynfigStudio/Contents/Resources/synfig/bin/synfigstudio

You should get some messages. Please create an issue at [https://github.com/synfig/synfig/issues our bugtracker] and post them there.

Doc:Walk Cycle/ru

2018-04-07T14:22:40Z

Zelgadis: /* Создание цикла ходьбы */

{{Title|Анимация "Шагающего человечка"}}
{{Category|Tutorials}}
{{Category|Tutorials Advanced}}
{{Category|ImportArt}}


== Файл "Список" (List) ==

Одна из самых не очевидных возможностей Synfig кроется в использовании слоя "Импорт изображения" (Import Image layer). Помимо того что он позволяет просто импортировать основные графические форматы хранения изображений он также может работать с файлом ".lst". Этот файл "Список" простой текстовый файл хранящий информацию о "Частоте кадров" (framerate) и список файлов с изображениями которые будут использоваться (если частота кадров не будет указана то используется её значение равное 15 FPS (кадров в секунду)).

Вот пример от "Voria Studios", он содержит 4 неподвижных изображения персонажа в разных стадиях цикла ходьбы. Эта последовательность изображений по сути 4 кадра которые повторяясь создадут идущего персонажа.

Вот эти изображения<br>
<gallery widths="104px" heights="216px">
Image:frame_01.jpg|Frame 1
Image:frame_02.jpg|Frame 2
Image:frame_03.jpg|Frame 3
Image:frame_04.jpg|Frame 4
</gallery>

А вот начало файла "lst". <br>
<code>
FPS 4<br>
frame_01.jpg<br>
frame_02.jpg<br>
frame_03.jpg<br>
frame_04.jpg<br>
frame_01.jpg<br>
frame_02.jpg<br>
frame_03.jpg<br>
frame_04.jpg<br>
frame_01.jpg<br>
frame_02.jpg<br>
frame_03.jpg<br>
frame_04.jpg<br>
...</code><br>

== Создание цикла ходьбы ==

Давайте теперь разберёмся как использовать эти изображения для того чтобы создать законченный цикл ходьбы персонажа в Synfig.

Начните с создания нового холста, со стандартной частотой кадров в 24 FPS. В меню холста выберите Слой > Создать слой > Прочие > Импорт изображения (Caret > Layer, New layer, Other, Import Image).

Теперь у нас есть новый Слой "Импорт изображения", но он остаётся пустым до тех пор пока не указан путь к файлу для импорта. Найдите строку "Имя Файла" (Filename) на панели параметров и укажите в ней путь к файлу ".lst".
Теперь вы должны видеть первое изображение из списка. Продвигаясь вперёд по шкале кадров вы увидите расположенные последовательно изображения из списка на каждом 6 кадре. Вы можете сделать предпросмотр или визуализировать (отрендерить) эту последовательность в нынешнем виде и получите анимацию с низкой кадровой частотой.

Но результат не будет достаточно плавным, а изображения не изменяемы (их можно переместить, вращать и растягивать но детали самого изображения не могут быть изменены). Для создания полностью редактируемого персонажа мы должны его трассировать, то есть продублировать его форму векторными элементами Synfig такими как Blines (Кривые) или Векторный карандаш.

У меня графический планшет, поэтому для меня больше подойдёт Векторный карандаш {{l|Draw Tool}}. Вернитесь обратно на нулевой кадр, выберите инструмент которым будете трассировать персонаж. Проще всего создать отдельные элементы нескольких областей (Голова, Левая рука, Правая рука, Торс, Левая нога, Правая нога). Дам вам полезный совет, чтобы лучше видеть оригинал во время трассировки отключите слой заливки сняв соответствующий флажок на панели слоёв, это позволит вам видеть изображение внизу и правильней подогнать форму под оригинал с помощью контрольных точек.

{{l|Image:Synfig_walk.png|488x192px}}

Когда закончите на нулевом кадре, переместитесь по шкале времени на 6 кадр. Вместо того чтоб трассировать в этот раз мы переместим уже имеющиеся элементы так чтобы они совпали с изображением. Снова отключите слой заливки чтобы видеть изображение внизу и можете начинать. Используйте инструмент вращения и инструмент перемещения чтобы подогнать элементы персонажа, с помощью контрольных точек предайте им нужную форму. [Не забудьте перед этим переключиться в "Режим редактирования анимации" (Animate Editing Mode) как это сделать описано в {{L|Doc:Animation Basics}}]

Повторите эти действия на 12 и 18 кадрах, после чего вы можете отключить слой "импорт изображения"(сняв флажок с него на панели слоёв). Теперь, не смотря на то что мы нарисовали только четыре кадра, используя мощь Synfig мы можем отрендерить плавную (24 кадра в секунду) анимацию цикла ходьбы. Добавьте сверху слой "Петля времени" (timeloop layer) с длительностью 1 секунда и персонаж будет шагать на месте на всём протяжении анимации.

{{l|Image:walk.gif}}

Добавив слой "Перемещение" (Translation layer) вы сможете заставить персонаж двигаться вперёд от одной части холста к другой (или двигаться назад, лунной походкой, если так вам больше нравится)

{{l|media:walk.zip|Вот zip архив}} в котором находится файл (.lst), 4 неподвижных изображения (ключевых кадра), и готовый файл Synfig. Разархивируйте их в одну папку и откройте newwalk.sif с помощью synfig.

Template:Advertising

2017-05-17T04:46:37Z

Zelgadis: Tweak advertising block

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}
|
{{#ifexpr: {{#time: s }} < 15
| {{#widget:AdCourseEn}}
| {{#widget:AdSenseBlock}}
}}
|
{{#switch: {{SUBPAGENAME}}
| de = {{#widget:AdCourseDe}}
| fr = {{#widget:AdCourseFr}}
| ru = {{#widget:AdCourseRu}}
| {{#widget:AdSenseBlock}}
}}
}}

Dev:Build Instructions

2017-05-08T09:38:38Z

Zelgadis: /* Linux */ Update instructions for version > 1.3.3

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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
$ ./bootstrap.sh
$ ./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.:<br>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<br>
* 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 &&
./bootstrap.sh &&
./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 &&
./bootstrap.sh &&
./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 &&
./bootstrap.sh &&
./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:Build Instructions

2017-05-08T09:38:10Z

Zelgadis: /* synfig-core */ Update instructions for version > 1.3.3

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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
$ ./bootstrap.sh
$ ./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.:<br>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<br>
* 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 &&
./bootstrap.sh &&
./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:Build Instructions

2017-05-08T09:37:20Z

Zelgadis: /* Mac OSX */ Update instructions for version > 1.3.3

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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.:<br>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<br>
* 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 &&
./bootstrap.sh &&
./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:Build Instructions

2017-05-08T09:36:39Z

Zelgadis: Reverted edits by Zelgadis (talk) to last revision by BobSynfig

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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.:<br>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<br>
* 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:Build Instructions

2017-05-08T09:35:25Z

Zelgadis: /* Linux */ Update instructions for version > 1.3.3

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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
$ ./bootstrap.sh
$ ./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.:<br>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<br>
* 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 &&
./bootstrap.sh &&
./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:Build Instructions

2017-05-08T09:35:03Z

Zelgadis: /* synfig-core */ Update instructions for version > 1.3.3

{{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.

Note that <u>for Fedora 24 (at least), you must define a password for root user</u> in order to run ''synfigstudio-linux-build.sh'', otherwise su authentication failure will occur.
If needed add it with ''sudo su -'' then ''passwd''

===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<br>
* 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<br>
* 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)<br>
* 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
$ ./bootstrap.sh
$ ./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.:<br>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<br>
* 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:Release

2017-05-08T09:32:10Z

Zelgadis: /* Apply latest translations */ Update instructions

{{Category|Building}}

==Preparation==

Choose a release manager (RM) who will manage the release and do most of the work and co-ordination needed to get a release out.

The RM will be responsible for deciding when the code is ready to be released and which problems will block the release.

The RM must have a proper up to date copy of the sourcecode. Check out {{l|Dev:Source code|here}} to see how to obtain it.

The RM must be an administrative member of sourceforge and to have write access to the synfig git repository. Ask any of the current administrators about that. Also a wiki account and a forum account are necessary.

We would assume that the git local copy of the source code are in a separate folder in your local drive and they are: etl, synfig-core, and synfig-studio accordingly to the {{l|Dev:Source code|source code}} instructions.

== Splash ==

* Pick a date at least 5 weeks into the future.
* Post a splash screen challenge in the forums.
* After 4 weeks, close the challenge and post a poll.
* After one week close the poll and name the winnar!
* Obtain the source of the winner file and commit it:
** Add the new splash source file to synfig-studio/images/splash-screen-xx.xx.xx.sifz where xx.xx.xx is the released version number.
** Disable development splash [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=65a91a4d12c667144d2dbbee367665ac02d77b0c example]
** Modify synfig-studio/images/Makefile.am accordingly. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=0b73a062d497b08b3012b61eb48ab79d2f87a69d example]
** Update synfig-studio/AUTHORS, synfig-studio/README, and synfig-studio/src/gtkmm/about.cpp if needed.

== Freeze commits ==

It would be good if no one commit more changes/patches until the release is done. Mainly because at some point we need to stop polishing the current revision.

First should come the feature freeze, then the string freeze and then the final cutoff of translations & bug fixes just before the release.

There is no technical way to freeze commits with sourceforge, so the developers should be willing to play nice with the release.

Ping coders, artists and translators and advice them about the release preparation. Ask for last updates before freezing the commits. Give some time to update. Preferably no more than a week.

==Copyrights==

Make sure the copyrights in README, the AUTHORS file and the about dialog list of contributors are up to date.

Do a <code>grep -r Copyright README</code> in the three etl, synfig-core and synfig-studio folders. It would return all the people that have current copyrights. Review the list of commits and the patches authoring to update it properly. Review the AUTHORS in each folder and don't forget the artists and translators.

== Release candidates ==

Following {{l|#Create the tarball|this instructions}} to create a tarball of the current git release, {{l|#Upload tarball|upload them to sourceforge}} and tag them as Release Candidate number 1, 2 etc. Create as many Release candidates as you need or consider. Ask people to download and {{l|#Test before publishing|test them}}. The forum and the IRC is a good place.
When everything goes fine then continue the release.

== Apply latest translations ==
You need to fetch translations from transifex.
# install transifex-client ('yum install transifex-client' on Fedora)
# cd into synfig repository
# run 'bash ./autobuild/transifex-pull-translations.sh'
# fix lines marked as "TODO" in synfig-studio/src/languages.inc.c (if any)
# push edited .po files back to transifex - 'bash ./autobuild/transifex-push-translations.sh'
# commit changes

==Versioning==

*Update version in save file dialog
** synfig-core/src/synfig/releases.h
** synfig-studio/src/gui/app.cpp
*Finalise the dates and GIT ids in NEWS.
** You already know the release revision number and the date of the next commit. Place them correctly in the etl/NEWS, synfig-core/NEWS and synfig-studio/NEWS files. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=12b2c80e47fe97432acddd953354e5df6dc09ece example]

*Bump version numbers and ETL/synfig dependencies in the configure.ac files.
**This would imply increase the version number in the following files:
***etl/configure.ac: increase ETL version number
***synfig-core/src/synfig/version.h: change SYNFIG_VERSION and SYNFIG_LIBRARY_VERSION variables
***synfig-core/configure.ac: increase ETL version number dependence matching the previous one and the synfig version number.
***synfig-studio/configure.ac: Increase ETL and synfig version number dependence matching the previous ones and the synfigstudio version number. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=7a5f90dfd5d710571486eada173f50f34b4e31e5 example]

* Double check the version numbers in configure.ac and NEWS are correct. Fix them if are wrong.

* Double check the copyright years in the README files and the about dialog are correct. Fix them if are wrong.

== Create the tarball ==

Create a tarball to allow users to just compile and install. Run the following command from synfig source tree:
./autobuild/synfigstudio-release.sh
See script body for additional usage notes.

== Test before publishing ==
* Test installed stuff. To run the installed synfigstudio from the tarball you've created you have to run directly from the command line:

$HOME/local-synfig/bin/synfigstudio

At this point there should be some battery of test sifz files and scripts to run various error proof tests to be sure that the release don't have nasty bugs. Share the tarball with other people that have other OS and ask them to build and run the same tests. This point is important for testing the release in different platforms, specially if there has been some changes that can have cross effects.

== Make tags ==
*Make tags and update the unstable branch. Run the following commands in the repository with write access:
git tag ETL-0.04.12
git tag synfig-0.61.09
git tag synfigstudio-0.61.09
git tag -f stable
git push --tags
With the appropriate version number.

== Upload source tarballs ==
* Upload the three tarballs (ETL, synfig, synfigstudio) to SF by using [https://sourceforge.net/project/admin/explorer.php?group_id=144022 the online upload] or following the instructions from [https://sourceforge.net/apps/trac/sourceforge/wiki/Release%20files%20for%20download this link]. Place each tarball in the corresponding folder.
* Upload an proper release note file (ascii) to the Release Notes folder. Mark the Release Note checkbox from its properties.
* Create a single tarball file including the etl, synfig, synfigstudio and the release note text file with the name of Synfig-Studio-XXX.tar.gz, where XXX is the version. Upload it to the ETL-Synfig-SynfigStudio folder and mark it as platform downloads (linux, windows, Mac <sigh>, and other).
* For each file (etl, synfig, synfigstudio and Synfig-Studio) uploaded, select the Release Note you uploaded file as the release note for all them.

== Build and upload packages ==
* Build binaries
* Create MD5SUM file for binary and source files. Command:
find . -type f -print0 | sort -z | xargs -0 md5sum
* Upload binaries and sources to Sourceforge
* Upload binaries to [http://www.fosshub.com/Synfig.html FossHub]
* Update screenshots at FossHub (optional)
* Ping {{l|Distributions|distros}} to upgrade their packages by sending a mail to each of the people maintaining packages. Suggest that they send us patches and that they might want to do translations.

== Update the website ==
* Write release notes based on the NEWS files ([http://www.synfig.org/cms/en/news/releases/synfig-studio-0-63-03/ example ]).
* Update website pages:
** [http://www.synfig.org/cms/en/download/stable/ Download Stable] - change links
** [http://www.synfig.org/cms/en/download/development Download Development] - remove dev snapshots as outdated
** Mark Release Notes page as visible to public
** [http://www.synfig.org/cms/en/download/stable/ Download Stable] - change link to Release Notes
** Update [http://www.synfig.org/issues/thebuggenie/synfig/release_center releases list in the Bug Tracker ]
** Bug Tracker: For this release mark all "Ready for QA" bugs as closed.
* Post a release announcement on the [http://www.synfig.org/forums/ forums]
* Update quick URLs
** Update http://synfig.org/VERSION_NUMBER to point to http://www.fosshub.com/Synfig.html
** Update http://synfig.org/PREVIOUS_VERSION_NUMBER to point to https://sourceforge.net/projects/synfig/files/releases/PREVIOUS_VERSION_NUMBER/

== Spread the word ==
* Post update to Udemy
** Announcement
** Update required version in description/video/link (if needed)
* Update Gumroad Package
** Change description
** Change video / reupload
** Notify clients
* short writeup to the folks at LWN.net
* Synfig devl mailing list
* Synfig user mailing lint
* [https://sourceforge.net/projects/synfig/ Sourceforge site page] update & [http://sourceforge.net/p/synfig/news/ news]
* IRC topic
* Update [http://en.wikipedia.org/wiki/Synfig Wikipedia]
* Update Facebook/synfig & Google+/synfig pages.

== The rest ==
* Celebrate with a nice $BEVERAGE_OF_CHOICE
* Update the wiki with the new features and review the wiki with missing/uncomplete pages. <<< this is important!
* Start thinking about the {{l|Dev:Roadmap|Roadmap}} for the next release.

----

I DON'T KNOW WHAT STUFF BELOW IS ABOUT> ANY IDEA? --[[User:Zelgadis|Zelgadis]] 11:04, 10 December 2011 (UTC)

== Spread the Word ==

* write press release (PR) (todo: Genete)
* add PR to website (for linking)
* update all Wikipedias
** en
** es
** fr
** ru
** de (todo: Oho)
** it
** ...
* send PR to all win/linux/debian/ubuntu... user groups, again: en, es, fr... (see below)
* send PR to major magazines (OS independant, Win, Linux, Artists, Designers...) in all countries...
* update websites "promoting" synfig ([http://linux.softpedia.com/get/Multimedia/Graphics/Synfig-7939.shtml linux.softpedia] & [http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/Synfig.shtml softpedia], [http://alternativeto.net/software/synfig/ alternativeto.net] , ...)
* ...

=== Distribution packager ===
Contact distribution packager to have the chance of auto-update.

=== PR Distribution List ===
We want to develop a distribution list. Everyone can contribute with adresses of important magazines, user groups (see below, please add more if you have more). Please keep the alphabethical order for language and address. Thx.

==== English ====
* Animation Conversation podcast. - Weekly podcast about animation, mainly feature films: http://www.animationconversation.com/ : feedback [AT] animationconversation.com
* Libre Graphics World - Portal for open source creativity: http://www.libregraphicsworld.org/ : alexandre.prokoudine [AT] gmail.com
* Animation Magazine - Magazine for the (american) animation business: http://animationmagazine.net/ : edit [AT] animationmagazine.net
* OS Artist - Free software news for artists blog: http://osartist.com/
* Animation Reporter - Indian animation magazine: http://www.animationreporter.com/ : suresht [AT] fontandpixel.com
* Cinefex - Magazine about special effects: http://www.cinefex.com/contact/
* Frames Per Second magazine - Digital animation magazine: http://www.fpsmagazine.com/blog/index.php : news [AT] fpsmagazine.com
* Deviant art Synfig group - http://synfig.deviantart.com/

==== French ====
===== Webzines =====
* [http://www.fousdanim.org/ Fous d'anim] Magazine en ligne sur l'actualité du cinéma d'animation avec de nombreux liens sur la majorité des sites de références.
* [http://www.awn.com/folioscope/gazette/ La gazette du loup], webzine sur le cinéma d'animation.
* [http://www.objectif-cinema.com objectif cinéma], cinema plutôt qu'animation, leur forum discute cependant logiciels.
* [http://www.linuxgraphic.org/wp/ linuxgraphic], portail francophone sur l'infographie libre.

===== General info media =====
* http://www.paperblog.fr

===== Forums =====
* http://www.forum-2d.com/f/index.php
* http://www.videohelp.com/software/Synfig-Studio/version-history

===== Blogs =====
* http://www.polyloop.net/fr/
* http://www.digitalthink.fr/wordpress/

===== Technology =====
* http://www.siteduzero.com/ - IT tutorials
* Ubuntu-fr - http://www.ubuntu-fr.org/
* Linux.org (fr) - http://linuxfr.org/pub/
* http://www.korben.info/ - actualité informatique

==== German ====
Do German translation of PR: (todo: Oho)
send to German email addresses (todo: Oho)

IT Magazines:
* c't Magazin: redaktion [AT] ct.de
* Linux Magazin: presse-info [AT] linux-magazin.de
* Ubuntu-user Magazin: pr [AT] ubuntu-user.de
* Linux User Magazin: redaktion [AT] linux-user.de

Portals:
* ProLinux Portal: info [AT] pro-linux.de
* ubuntuusers.de: Ikhaya Artikel Vorschlag: http://ikhaya.ubuntuusers.de/suggest/ (todo: Oho)

Maybe:
* Download Platform: freeware.de: redaktion [AT] freeware.de

==== Spanish ====
* ...

Dev:Release

2017-04-28T04:26:17Z

Zelgadis: /* Apply latest translations */ Update instructions

{{Category|Building}}

==Preparation==

Choose a release manager (RM) who will manage the release and do most of the work and co-ordination needed to get a release out.

The RM will be responsible for deciding when the code is ready to be released and which problems will block the release.

The RM must have a proper up to date copy of the sourcecode. Check out {{l|Dev:Source code|here}} to see how to obtain it.

The RM must be an administrative member of sourceforge and to have write access to the synfig git repository. Ask any of the current administrators about that. Also a wiki account and a forum account are necessary.

We would assume that the git local copy of the source code are in a separate folder in your local drive and they are: etl, synfig-core, and synfig-studio accordingly to the {{l|Dev:Source code|source code}} instructions.

== Splash ==

* Pick a date at least 5 weeks into the future.
* Post a splash screen challenge in the forums.
* After 4 weeks, close the challenge and post a poll.
* After one week close the poll and name the winnar!
* Obtain the source of the winner file and commit it:
** Add the new splash source file to synfig-studio/images/splash-screen-xx.xx.xx.sifz where xx.xx.xx is the released version number.
** Disable development splash [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=65a91a4d12c667144d2dbbee367665ac02d77b0c example]
** Modify synfig-studio/images/Makefile.am accordingly. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=0b73a062d497b08b3012b61eb48ab79d2f87a69d example]
** Update synfig-studio/AUTHORS, synfig-studio/README, and synfig-studio/src/gtkmm/about.cpp if needed.

== Freeze commits ==

It would be good if no one commit more changes/patches until the release is done. Mainly because at some point we need to stop polishing the current revision.

First should come the feature freeze, then the string freeze and then the final cutoff of translations & bug fixes just before the release.

There is no technical way to freeze commits with sourceforge, so the developers should be willing to play nice with the release.

Ping coders, artists and translators and advice them about the release preparation. Ask for last updates before freezing the commits. Give some time to update. Preferably no more than a week.

==Copyrights==

Make sure the copyrights in README, the AUTHORS file and the about dialog list of contributors are up to date.

Do a <code>grep -r Copyright README</code> in the three etl, synfig-core and synfig-studio folders. It would return all the people that have current copyrights. Review the list of commits and the patches authoring to update it properly. Review the AUTHORS in each folder and don't forget the artists and translators.

== Release candidates ==

Following {{l|#Create the tarball|this instructions}} to create a tarball of the current git release, {{l|#Upload tarball|upload them to sourceforge}} and tag them as Release Candidate number 1, 2 etc. Create as many Release candidates as you need or consider. Ask people to download and {{l|#Test before publishing|test them}}. The forum and the IRC is a good place.
When everything goes fine then continue the release.

== Apply latest translations ==
You need to fetch translations from transifex.
# install transifex-client ('yum install transifex-client' on Fedora)
# cd into synfig repository
# run 'bash ./autobuild/transifex-pull-translations.sh'
# add new languages to configuration files (if any)
## synfig-core: edit configure.ac - ALL_LINGUAS variable
## synfig-studio: edit po/LINGUAS
## synfig studio: edit src/languages.inc.c
# push edited .po files back to transifex - 'bash ./autobuild/transifex-push-translations.sh'
# commit changes

==Versioning==

*Update version in save file dialog
** synfig-core/src/synfig/releases.h
** synfig-studio/src/gui/app.cpp
*Finalise the dates and GIT ids in NEWS.
** You already know the release revision number and the date of the next commit. Place them correctly in the etl/NEWS, synfig-core/NEWS and synfig-studio/NEWS files. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=12b2c80e47fe97432acddd953354e5df6dc09ece example]

*Bump version numbers and ETL/synfig dependencies in the configure.ac files.
**This would imply increase the version number in the following files:
***etl/configure.ac: increase ETL version number
***synfig-core/src/synfig/version.h: change SYNFIG_VERSION and SYNFIG_LIBRARY_VERSION variables
***synfig-core/configure.ac: increase ETL version number dependence matching the previous one and the synfig version number.
***synfig-studio/configure.ac: Increase ETL and synfig version number dependence matching the previous ones and the synfigstudio version number. [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=commitdiff;h=7a5f90dfd5d710571486eada173f50f34b4e31e5 example]

* Double check the version numbers in configure.ac and NEWS are correct. Fix them if are wrong.

* Double check the copyright years in the README files and the about dialog are correct. Fix them if are wrong.

== Create the tarball ==

Create a tarball to allow users to just compile and install. Run the following command from synfig source tree:
./autobuild/synfigstudio-release.sh
See script body for additional usage notes.

== Test before publishing ==
* Test installed stuff. To run the installed synfigstudio from the tarball you've created you have to run directly from the command line:

$HOME/local-synfig/bin/synfigstudio

At this point there should be some battery of test sifz files and scripts to run various error proof tests to be sure that the release don't have nasty bugs. Share the tarball with other people that have other OS and ask them to build and run the same tests. This point is important for testing the release in different platforms, specially if there has been some changes that can have cross effects.

== Make tags ==
*Make tags and update the unstable branch. Run the following commands in the repository with write access:
git tag ETL-0.04.12
git tag synfig-0.61.09
git tag synfigstudio-0.61.09
git tag -f stable
git push --tags
With the appropriate version number.

== Upload source tarballs ==
* Upload the three tarballs (ETL, synfig, synfigstudio) to SF by using [https://sourceforge.net/project/admin/explorer.php?group_id=144022 the online upload] or following the instructions from [https://sourceforge.net/apps/trac/sourceforge/wiki/Release%20files%20for%20download this link]. Place each tarball in the corresponding folder.
* Upload an proper release note file (ascii) to the Release Notes folder. Mark the Release Note checkbox from its properties.
* Create a single tarball file including the etl, synfig, synfigstudio and the release note text file with the name of Synfig-Studio-XXX.tar.gz, where XXX is the version. Upload it to the ETL-Synfig-SynfigStudio folder and mark it as platform downloads (linux, windows, Mac <sigh>, and other).
* For each file (etl, synfig, synfigstudio and Synfig-Studio) uploaded, select the Release Note you uploaded file as the release note for all them.

== Build and upload packages ==
* Build binaries
* Create MD5SUM file for binary and source files. Command:
find . -type f -print0 | sort -z | xargs -0 md5sum
* Upload binaries and sources to Sourceforge
* Upload binaries to [http://www.fosshub.com/Synfig.html FossHub]
* Update screenshots at FossHub (optional)
* Ping {{l|Distributions|distros}} to upgrade their packages by sending a mail to each of the people maintaining packages. Suggest that they send us patches and that they might want to do translations.

== Update the website ==
* Write release notes based on the NEWS files ([http://www.synfig.org/cms/en/news/releases/synfig-studio-0-63-03/ example ]).
* Update website pages:
** [http://www.synfig.org/cms/en/download/stable/ Download Stable] - change links
** [http://www.synfig.org/cms/en/download/development Download Development] - remove dev snapshots as outdated
** Mark Release Notes page as visible to public
** [http://www.synfig.org/cms/en/download/stable/ Download Stable] - change link to Release Notes
** Update [http://www.synfig.org/issues/thebuggenie/synfig/release_center releases list in the Bug Tracker ]
** Bug Tracker: For this release mark all "Ready for QA" bugs as closed.
* Post a release announcement on the [http://www.synfig.org/forums/ forums]
* Update quick URLs
** Update http://synfig.org/VERSION_NUMBER to point to http://www.fosshub.com/Synfig.html
** Update http://synfig.org/PREVIOUS_VERSION_NUMBER to point to https://sourceforge.net/projects/synfig/files/releases/PREVIOUS_VERSION_NUMBER/

== Spread the word ==
* Post update to Udemy
** Announcement
** Update required version in description/video/link (if needed)
* Update Gumroad Package
** Change description
** Change video / reupload
** Notify clients
* short writeup to the folks at LWN.net
* Synfig devl mailing list
* Synfig user mailing lint
* [https://sourceforge.net/projects/synfig/ Sourceforge site page] update & [http://sourceforge.net/p/synfig/news/ news]
* IRC topic
* Update [http://en.wikipedia.org/wiki/Synfig Wikipedia]
* Update Facebook/synfig & Google+/synfig pages.

== The rest ==
* Celebrate with a nice $BEVERAGE_OF_CHOICE
* Update the wiki with the new features and review the wiki with missing/uncomplete pages. <<< this is important!
* Start thinking about the {{l|Dev:Roadmap|Roadmap}} for the next release.

----

I DON'T KNOW WHAT STUFF BELOW IS ABOUT> ANY IDEA? --[[User:Zelgadis|Zelgadis]] 11:04, 10 December 2011 (UTC)

== Spread the Word ==

* write press release (PR) (todo: Genete)
* add PR to website (for linking)
* update all Wikipedias
** en
** es
** fr
** ru
** de (todo: Oho)
** it
** ...
* send PR to all win/linux/debian/ubuntu... user groups, again: en, es, fr... (see below)
* send PR to major magazines (OS independant, Win, Linux, Artists, Designers...) in all countries...
* update websites "promoting" synfig ([http://linux.softpedia.com/get/Multimedia/Graphics/Synfig-7939.shtml linux.softpedia] & [http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/Synfig.shtml softpedia], [http://alternativeto.net/software/synfig/ alternativeto.net] , ...)
* ...

=== Distribution packager ===
Contact distribution packager to have the chance of auto-update.

=== PR Distribution List ===
We want to develop a distribution list. Everyone can contribute with adresses of important magazines, user groups (see below, please add more if you have more). Please keep the alphabethical order for language and address. Thx.

==== English ====
* Animation Conversation podcast. - Weekly podcast about animation, mainly feature films: http://www.animationconversation.com/ : feedback [AT] animationconversation.com
* Libre Graphics World - Portal for open source creativity: http://www.libregraphicsworld.org/ : alexandre.prokoudine [AT] gmail.com
* Animation Magazine - Magazine for the (american) animation business: http://animationmagazine.net/ : edit [AT] animationmagazine.net
* OS Artist - Free software news for artists blog: http://osartist.com/
* Animation Reporter - Indian animation magazine: http://www.animationreporter.com/ : suresht [AT] fontandpixel.com
* Cinefex - Magazine about special effects: http://www.cinefex.com/contact/
* Frames Per Second magazine - Digital animation magazine: http://www.fpsmagazine.com/blog/index.php : news [AT] fpsmagazine.com
* Deviant art Synfig group - http://synfig.deviantart.com/

==== French ====
===== Webzines =====
* [http://www.fousdanim.org/ Fous d'anim] Magazine en ligne sur l'actualité du cinéma d'animation avec de nombreux liens sur la majorité des sites de références.
* [http://www.awn.com/folioscope/gazette/ La gazette du loup], webzine sur le cinéma d'animation.
* [http://www.objectif-cinema.com objectif cinéma], cinema plutôt qu'animation, leur forum discute cependant logiciels.
* [http://www.linuxgraphic.org/wp/ linuxgraphic], portail francophone sur l'infographie libre.

===== General info media =====
* http://www.paperblog.fr

===== Forums =====
* http://www.forum-2d.com/f/index.php
* http://www.videohelp.com/software/Synfig-Studio/version-history

===== Blogs =====
* http://www.polyloop.net/fr/
* http://www.digitalthink.fr/wordpress/

===== Technology =====
* http://www.siteduzero.com/ - IT tutorials
* Ubuntu-fr - http://www.ubuntu-fr.org/
* Linux.org (fr) - http://linuxfr.org/pub/
* http://www.korben.info/ - actualité informatique

==== German ====
Do German translation of PR: (todo: Oho)
send to German email addresses (todo: Oho)

IT Magazines:
* c't Magazin: redaktion [AT] ct.de
* Linux Magazin: presse-info [AT] linux-magazin.de
* Ubuntu-user Magazin: pr [AT] ubuntu-user.de
* Linux User Magazin: redaktion [AT] linux-user.de

Portals:
* ProLinux Portal: info [AT] pro-linux.de
* ubuntuusers.de: Ikhaya Artikel Vorschlag: http://ikhaya.ubuntuusers.de/suggest/ (todo: Oho)

Maybe:
* Download Platform: freeware.de: redaktion [AT] freeware.de

==== Spanish ====
* ...

MediaWiki:Grouppage-editor

2017-02-23T15:34:13Z

Zelgadis: Created page with "Project:Editors"

Project:Editors

MediaWiki:Group-editor-member

2017-02-23T15:33:35Z

Zelgadis: Created page with "editor"

editor

MediaWiki:Group-editor

2017-02-23T15:32:59Z

Zelgadis: Name of trusted group, who can skip captcha

Editors

Template:Languages

2017-02-03T14:59:48Z

Zelgadis: Fixed Czech language code

<includeonly><div class="languages"><table width="100%" style="border:1px solid #AAAAAA;border-collapse:collapse;clear:both;font-size:85%;margin:0px 1px 5px 1px;padding:0.2em;">
<tr valign="top" style="background: #EEF3E2">
<td style="width: 25px; padding-left: 0.5em;">[[Image:Geographylogo.png|25px|Languages|link=]]</td>
<td style="width: 100px; white-space: nowrap; padding: 4px 1em 0 0.5em; border-right: 1px solid #aaaaaa;">'''[[Meta:Translation|Language:]]''' </td><td style="padding: 1px 1em 0; background: #F6F9ED;">
{{Languages/Lang|en}}{{Languages/Lang|ar}}{{Languages/Lang|bg}}{{Languages/Lang|br}}{{Languages/Lang|ca}}{{Languages/Lang|cs}}{{Languages/Lang|de}}{{Languages/Lang|dk}}{{Languages/Lang|es}}{{Languages/Lang|fa}}{{Languages/Lang|fi}}{{Languages/Lang|fr}}{{Languages/Lang|id}}{{Languages/Lang|it}}{{Languages/Lang|ja}}{{Languages/Lang|ko}}{{Languages/Lang|nl}}{{Languages/Lang|pl}}{{Languages/Lang|pt}}{{Languages/Lang|ro}}{{Languages/Lang|ru}}{{Languages/Lang|sr}}{{Languages/Lang|sv}}{{Languages/Lang|tr}}{{Languages/Lang|zh-cn}}{{Languages/Lang|zh-tw}}
</td></tr></table></div></includeonly><noinclude>
== Syntax ==
<nowiki>{{Languages}}</nowiki>

== Usage ==

The template is displayed automatically on documentation pages with the help of PageNotice extension. See:
* [[MediaWiki:Top-notice-ns-0]] - Main namespace (top)
* [[MediaWiki:Bottom-notice-ns-0]] - Main namespace (bottom)
* [[MediaWiki:Top-notice-ns-14]] - Category namespace (top)
* [[MediaWiki:Bottom-notice-ns-14]] - Category namespace (bottom)
* [[MediaWiki:Top-notice-ns-100]] - Doc namespace (top)
* [[MediaWiki:Bottom-notice-ns-100]] - Doc namespace (bottom)

See [[Meta:Guides/i18n]] for further details about translating pages.

{{Subpages}}
</noinclude>

Template:Advertising

2017-01-07T09:42:36Z

Zelgadis:

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}
|
{{#ifexpr: {{#time: s }} < 10
| {{#widget:AdCourseEn}}
| {{#widget:AdSenseBlock}}
}}
|
{{#switch: {{SUBPAGENAME}}
| de = {{#widget:AdCourseDe}}
| fr = {{#widget:AdCourseFr}}
| ru = {{#widget:AdCourseRu}}
| {{#widget:AdSenseBlock}}
}}
}}

Template:Advertising

2016-12-16T14:56:23Z

Zelgadis: Language-specific ads

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}
|
{{#ifexpr: {{#time: s }} > 30
| {{#widget:AdCourseEn}}
| {{#widget:AdSenseBlock}}
}}
|
{{#switch: {{SUBPAGENAME}}
| de = {{#widget:AdCourseDe}}
| fr = {{#widget:AdCourseFr}}
| ru = {{#widget:AdCourseRu}}
| {{#widget:AdSenseBlock}}
}}
}}

Widget:AdCourseRu

2016-12-16T14:49:04Z

Zelgadis: Created page with "<noinclude>__NOTOC__ Synfig Training Course advertising (Russian) </noinclude><includeonly> <div align="center"><a href="https://gumroad.com/l/synfig-training-1" target="_blan..."

<noinclude>__NOTOC__
Synfig Training Course advertising (Russian)
</noinclude><includeonly>
<div align="center"><a href="https://gumroad.com/l/synfig-training-1" target="_blank"><img src="http://www.synfig.org/banners/banner-728x90-v4-ru.sifz.png" width=728 height=90></a></div></includeonly>

Widget:AdCourseFr

2016-12-16T14:47:20Z

Zelgadis: Created page with "<noinclude>__NOTOC__ Synfig Training Course advertising (French) </noinclude><includeonly> <div align="center"><a href="https://gumroad.com/l/synfig-training-1-fr" target="_bl..."

<noinclude>__NOTOC__
Synfig Training Course advertising (French)
</noinclude><includeonly>
<div align="center"><a href="https://gumroad.com/l/synfig-training-1-fr" target="_blank"><img src="http://www.synfig.org/banners/banner-728x90-v4-fr.sifz.png" width=728 height=90></a></div></includeonly>

Widget:AdCourseDe

2016-12-16T14:45:59Z

Zelgadis: Created page with "<noinclude>__NOTOC__ Synfig Training Course advertising (German) </noinclude><includeonly> <div align="center"><a href="https://gumroad.com/l/synfig-training-1-de" target="_bl..."

<noinclude>__NOTOC__
Synfig Training Course advertising (German)
</noinclude><includeonly>
<div align="center"><a href="https://gumroad.com/l/synfig-training-1-de" target="_blank"><img src="http://www.synfig.org/banners/banner-728x90-v4-de.sifz.png" width=728 height=90></a></div></includeonly>

Widget:AdCourseEn

2016-12-16T12:59:42Z

Zelgadis: Fix image link

<noinclude>__NOTOC__
Synfig Training Course advertising (English)
</noinclude><includeonly>
<div align="center"><a href="https://gumroad.com/l/synfig-training-1-en" target="_blank"><img src="http://www.synfig.org/banners/banner-728x90-v4-en.sifz.png" width=728 height=90></a></div></includeonly>

Template:Advertising

2016-12-08T11:48:57Z

Zelgadis: Random

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}
|
{{#ifexpr: {{#time: s }} > 30
| {{#widget:AdCourseEn}}
| {{#widget:AdSenseBlock}}
}}
|{{#widget:AdSenseBlock}}}}

Template:Advertising

2016-12-08T11:46:38Z

Zelgadis:

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}
|{{#widget:AdCourseEn}}
|{{#widget:AdSenseBlock}}}}

MediaWiki:Bottom-notice-ns-102

2016-12-08T08:47:38Z

Zelgadis:

MediaWiki:Top-notice-ns-102

2016-12-08T08:47:29Z

Zelgadis:

MediaWiki:Bottom-notice-ns-101

2016-12-08T08:46:52Z

Zelgadis:

MediaWiki:Top-notice-ns-101

2016-12-08T08:46:45Z

Zelgadis:

MediaWiki:Bottom-notice-ns-100

2016-12-08T08:46:24Z

Zelgadis:

<br />{{Advertising}}
{{Languages}}

MediaWiki:Bottom-notice-ns-100

2016-12-08T08:46:06Z

Zelgadis: Undo revision 22390 by Zelgadis (talk)

<br />{{#widget:AdSenseBlock}}
{{Languages}}

MediaWiki:Bottom-notice-ns-100

2016-12-08T08:45:44Z

Zelgadis:

<br />{{#widget:AdSenseBlock}}
{{Advertising}}

MediaWiki:Bottom-notice-ns-1

2016-12-08T08:43:21Z

Zelgadis:

MediaWiki:Bottom-notice-ns-0

2016-12-08T08:42:48Z

Zelgadis:

<br />
{{Advertising}}
{{Languages}}

MediaWiki:Top-notice-ns-1

2016-12-08T08:42:38Z

Zelgadis:

MediaWiki:Top-notice-ns-100

2016-12-08T08:42:04Z

Zelgadis:

MediaWiki:Top-notice-ns-0

2016-12-08T08:40:32Z

Zelgadis:

Template:Advertising

2016-12-08T08:40:25Z

Zelgadis: Created page with "{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}|{{#widget:AdCourseEn}}|{{#widget:AdSenseBlock}}}}"

{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}|{{#widget:AdCourseEn}}|{{#widget:AdSenseBlock}}}}

Widget:AdCourseEn

2016-12-08T08:38:59Z

Zelgadis: Fix description

<noinclude>__NOTOC__
Synfig Training Course advertising (English)
</noinclude><includeonly>
<div align="center"><a href="https://gumroad.com/l/synfig-training-1-en" target="_blank"><img src="http://www.synfig.org/banners/banner-728x90-v4.sifz.png" width=728 height=90></a></div></includeonly>

MediaWiki:Top-notice-ns-0

2016-12-08T07:33:45Z

Zelgadis:

{{Languages}}
{{Warnings}}
{{#ifeq: {{PAGENAME}} | {{BASEPAGENAME}}|{{#widget:AdCourseEn}}|{{#widget:AdSenseBlock}}}}