Skip to content

Commit 4bd9c3b

Browse files
rodlierodlie
committed
Doc update
1 parent 924e9d5 commit 4bd9c3b

6 files changed

Lines changed: 128 additions & 19 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ tmp*
99
pdf/friction.md
1010
pdf/friction.pdf
1111
*.friction_backup
12-
12+
offline.old
1313
.DS_Store

‎documentation/shortcuts.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,19 @@ Shortcuts for objects are valid on active timeline and viewer.
7575
| Invert Selection | `Alt` + `A`
7676
| Pivot local/global | `P`
7777

78+
## Paths
79+
80+
| Action | Shortcut |
81+
| ------ | -------- |
82+
| Object to Path | `Shift` + `Ctrl` + `C`
83+
| Stroke to Path | `Ctrl` + `Alt` + `C`
84+
| Union | `Ctrl` + `+`
85+
| Difference | `Ctrl` + `-`
86+
| Intersection | `Ctrl` + `*`
87+
| Exclusion | `Ctrl` + `^`
88+
| Combine | `Ctrl` + `K`
89+
| Break Apart | `Ctrl` + `Shift` + `K`
90+
7891
## Timeline
7992

8093
Shortcuts are valid on active timeline.
@@ -95,7 +108,8 @@ Shortcuts are valid on active timeline.
95108
| Frame In | `I`
96109
| Frame Out | `O`
97110
| Add Marker | `M`
98-
| Add Key(s) | `Insert`
111+
| Add Key(s) | `Alt` + `K`
112+
| Split Clip | `K`
99113

100114
## Viewer/Canvas
101115

‎offline/assets/screenshots/100/friction-100-linux-screenshot.png‎

173 KB
Loading

‎offline/faq.html‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ <h1 id="frequently-asked-questions-faq">Frequently Asked Questions (FAQ)</h1>
2929
</li>
3030
</ul>
3131

32-
<h3 id="what-is-friction">What is Friction?</h3>
32+
<h2 id="what-is-friction">What is Friction?</h2>
3333

3434
<p>Friction is an open-source 2D animation and motion graphics software. It is designed for animators and graphic designers who need a powerful and flexible tool for vector and bitmap animation.</p>
3535

36-
<h3 id="is-friction-open-source">Is Friction open source?</h3>
36+
<h2 id="is-friction-open-source">Is Friction open source?</h2>
3737

3838
<p>Yes, Friction is licensed under the <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL version 3</a> (<code class="language-plaintext highlighter-rouge">GPL-3.0-only</code>).</p>
3939

40-
<h3 id="can-i-use-friction-for-commercial-projects">Can I use Friction for commercial projects?</h3>
40+
<h2 id="can-i-use-friction-for-commercial-projects">Can I use Friction for commercial projects?</h2>
4141

4242
<p>Yes, there are no restrictions, you can use Friction for anything you want.</p>
4343

44-
<h3 id="what-operating-systems-does-friction-support">What operating systems does Friction support?</h3>
44+
<h2 id="what-operating-systems-does-friction-support">What operating systems does Friction support?</h2>
4545

4646
<p>Friction is available for Linux, Windows and macOS.</p>
4747

@@ -54,7 +54,7 @@ <h3 id="what-operating-systems-does-friction-support">What operating systems doe
5454

5555
<p>See <a href="/download.html#requirements">download</a> section for updated information.</p>
5656

57-
<h3 id="can-i-contribute-to-frictions-development">Can I contribute to Friction’s development?</h3>
57+
<h2 id="can-i-contribute-to-frictions-development">Can I contribute to Friction’s development?</h2>
5858

5959
<p>Absolutely! Contributions are welcome in the form of code, documentation, bug reports, and feature suggestions. You can check our repositories at:</p>
6060

@@ -63,19 +63,19 @@ <h3 id="can-i-contribute-to-frictions-development">Can I contribute to Friction
6363
<li><a href="https://codeberg.org/friction/friction">CodeBerg</a></li>
6464
</ul>
6565

66-
<h3 id="does-friction-support-scripting">Does Friction support scripting?</h3>
66+
<h2 id="does-friction-support-scripting">Does Friction support scripting?</h2>
6767

6868
<p>Yes, Friction supports scripting through <a href="https://en.wikipedia.org/wiki/ECMAScript">ECMAScript</a>. You can create custom scripts to automate tasks and control animations dynamically.</p>
6969

70-
<h3 id="how-can-i-report-a-bug-or-request-a-feature">How can I report a bug or request a feature?</h3>
70+
<h2 id="how-can-i-report-a-bug-or-request-a-feature">How can I report a bug or request a feature?</h2>
7171

7272
<p>You can report bugs or request new features on the <a href="https://github.com/friction2d/friction/issues">GitHub Issues page</a>. Please provide as much detail as possible, including steps to reproduce the issue.</p>
7373

74-
<h3 id="does-friction-support-gpu-acceleration">Does Friction support GPU acceleration?</h3>
74+
<h2 id="does-friction-support-gpu-acceleration">Does Friction support GPU acceleration?</h2>
7575

7676
<p>Yes, Friction uses <a href="https://skia.org/">Skia</a> for rendering, which takes advantage of GPU acceleration when available.</p>
7777

78-
<h3 id="is-friction-an-after-effects-alternative">Is Friction an After Effects alternative?</h3>
78+
<h2 id="is-friction-an-after-effects-alternative">Is Friction an After Effects alternative?</h2>
7979

8080
<p>Friction is a specialized vector-based animation tool designed for motion graphics. While it shares some conceptual similarities with tools like Adobe After Effects or Adobe Animate, it is built from the ground up with its own unique workflow.</p>
8181

@@ -84,21 +84,21 @@ <h3 id="is-friction-an-after-effects-alternative">Is Friction an After Effects a
8484
<li><strong>For Visual Effects (VFX):</strong> If your work focuses on compositing and VFX, we recommend exploring Natron and/or Blender.</li>
8585
</ul>
8686

87-
<h3 id="do-the-expression-editor-has-a-valueattime-function">Do the Expression Editor has a valueAtTime() function?</h3>
87+
<h2 id="do-the-expression-editor-has-a-valueattime-function">Do the Expression Editor has a valueAtTime() function?</h2>
8888

89-
<p>At the moment <strong>Friction</strong> has not option to retrieve information from another frame but the actual but I will may be introduced in the next <code class="language-plaintext highlighter-rouge">v1.1</code>.</p>
89+
<p>At the moment Friction has not option to retrieve information from another frame but the actual but I will may be introduced in the next <code class="language-plaintext highlighter-rouge">v1.1</code>.</p>
9090

91-
<h3 id="does-friction-support-lottie-animations">Does Friction support Lottie animations?</h3>
91+
<h2 id="does-friction-support-lottie-animations">Does Friction support Lottie animations?</h2>
9292

9393
<p>No, while Lottie has its great advantages, <strong>Friction</strong> uses SVG animations with <a href="https://www.w3.org/TR/REC-smil/"><strong>SMIL</strong></a> <em>(Synchronized Multimedia Integration Language)</em> supported by the W3 Consortium.</p>
9494

9595
<p>Currently we have no plans to support Lottie, we only support/promote web standards.</p>
9696

97-
<h3 id="is-friction-a-fork-of-enve">Is Friction a fork of enve?</h3>
97+
<h2 id="is-friction-a-fork-of-enve">Is Friction a fork of enve?</h2>
9898

9999
<p>Yes, <strong>Friction</strong> forked from <a href="https://maurycyliebner.github.io/">enve</a> in February 2023. Most users of enve should be able to move to <strong>Friction</strong>, note that some features have been removed or changed. enve was a starting point for <strong>Friction</strong>, the codebase will change/differ more and more with each release.</p>
100100

101-
<h3 id="why-is-memory-usage-higher-on-apple-silicon-vs-intel">Why is memory usage higher on Apple Silicon vs. Intel?</h3>
101+
<h2 id="why-is-memory-usage-higher-on-apple-silicon-vs-intel">Why is memory usage higher on Apple Silicon vs. Intel?</h2>
102102

103103
<p>On Apple Silicon, macOS uses a Unified Memory Architecture. In this system, the system RAM is shared dynamically between the CPU and the GPU.</p>
104104

@@ -108,7 +108,6 @@ <h3 id="why-is-memory-usage-higher-on-apple-silicon-vs-intel">Why is memory usag
108108

109109
<p>If you have more questions, feel free to ask in our <strong><a href="https://friction.graphics/community.html">Friction community</a></strong> or open an issue on our repos.</p>
110110

111-
112111

113112

114113

‎offline/shortcuts.html‎

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,51 @@ <h2 id="objects">Objects</h2>
216216
</tbody>
217217
</table>
218218

219+
<h2 id="paths">Paths</h2>
220+
221+
<table>
222+
<thead>
223+
<tr>
224+
<th>Action</th>
225+
<th>Shortcut</th>
226+
</tr>
227+
</thead>
228+
<tbody>
229+
<tr>
230+
<td>Object to Path</td>
231+
<td><code class="language-plaintext highlighter-rouge">Shift</code> + <code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">C</code></td>
232+
</tr>
233+
<tr>
234+
<td>Stroke to Path</td>
235+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">Alt</code> + <code class="language-plaintext highlighter-rouge">C</code></td>
236+
</tr>
237+
<tr>
238+
<td>Union</td>
239+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">+</code></td>
240+
</tr>
241+
<tr>
242+
<td>Difference</td>
243+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">-</code></td>
244+
</tr>
245+
<tr>
246+
<td>Intersection</td>
247+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">*</code></td>
248+
</tr>
249+
<tr>
250+
<td>Exclusion</td>
251+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">^</code></td>
252+
</tr>
253+
<tr>
254+
<td>Combine</td>
255+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">K</code></td>
256+
</tr>
257+
<tr>
258+
<td>Break Apart</td>
259+
<td><code class="language-plaintext highlighter-rouge">Ctrl</code> + <code class="language-plaintext highlighter-rouge">Shift</code> + <code class="language-plaintext highlighter-rouge">K</code></td>
260+
</tr>
261+
</tbody>
262+
</table>
263+
219264
<h2 id="timeline">Timeline</h2>
220265

221266
<p>Shortcuts are valid on active timeline.</p>
@@ -286,7 +331,11 @@ <h2 id="timeline">Timeline</h2>
286331
</tr>
287332
<tr>
288333
<td>Add Key(s)</td>
289-
<td><code class="language-plaintext highlighter-rouge">Insert</code></td>
334+
<td><code class="language-plaintext highlighter-rouge">Alt</code> + <code class="language-plaintext highlighter-rouge">K</code></td>
335+
</tr>
336+
<tr>
337+
<td>Split Clip</td>
338+
<td><code class="language-plaintext highlighter-rouge">K</code></td>
290339
</tr>
291340
</tbody>
292341
</table>

‎shortcuts.html‎

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,49 @@ <h2 id="objects">Objects</h2>
200200
</tr>
201201
</tbody>
202202
</table>
203+
<h2 id="paths">Paths</h2>
204+
<table>
205+
<thead>
206+
<tr class="header">
207+
<th>Action</th>
208+
<th>Shortcut</th>
209+
</tr>
210+
</thead>
211+
<tbody>
212+
<tr class="odd">
213+
<td>Object to Path</td>
214+
<td><code>Shift</code> + <code>Ctrl</code> + <code>C</code></td>
215+
</tr>
216+
<tr class="even">
217+
<td>Stroke to Path</td>
218+
<td><code>Ctrl</code> + <code>Alt</code> + <code>C</code></td>
219+
</tr>
220+
<tr class="odd">
221+
<td>Union</td>
222+
<td><code>Ctrl</code> + <code>+</code></td>
223+
</tr>
224+
<tr class="even">
225+
<td>Difference</td>
226+
<td><code>Ctrl</code> + <code>-</code></td>
227+
</tr>
228+
<tr class="odd">
229+
<td>Intersection</td>
230+
<td><code>Ctrl</code> + <code>*</code></td>
231+
</tr>
232+
<tr class="even">
233+
<td>Exclusion</td>
234+
<td><code>Ctrl</code> + <code>^</code></td>
235+
</tr>
236+
<tr class="odd">
237+
<td>Combine</td>
238+
<td><code>Ctrl</code> + <code>K</code></td>
239+
</tr>
240+
<tr class="even">
241+
<td>Break Apart</td>
242+
<td><code>Ctrl</code> + <code>Shift</code> + <code>K</code></td>
243+
</tr>
244+
</tbody>
245+
</table>
203246
<h2 id="timeline">Timeline</h2>
204247
<p>Shortcuts are valid on active timeline.</p>
205248
<table>
@@ -268,7 +311,11 @@ <h2 id="timeline">Timeline</h2>
268311
</tr>
269312
<tr class="odd">
270313
<td>Add Key(s)</td>
271-
<td><code>Insert</code></td>
314+
<td><code>Alt</code> + <code>K</code></td>
315+
</tr>
316+
<tr class="even">
317+
<td>Split Clip</td>
318+
<td><code>K</code></td>
272319
</tr>
273320
</tbody>
274321
</table>

0 commit comments

Comments
 (0)