Skip to content

Commit f95dbdd

Browse files
Fix: convert docs from submodule to normal folder
1 parent 52f052b commit f95dbdd

File tree

106 files changed

+855
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+855
-1
lines changed

docs

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/.DS_Store

6 KB
Binary file not shown.

docs/Loopy/Installation.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Installation and Support
2+
3+
## Installation
4+
5+
### **aescripts Manager app**
6+
7+
The easiest way to install and license is by using the [aescripts + aeplugins manager](https://aescripts.com/learn/aescripts-aeplugins-manager-app/).
8+
9+
To install a trial you can select ‘Add Trial’ from the ‘Account’ menu.
10+
11+
### **Manual installation**
12+
13+
To manually install Loopy, place the `Loopy.jsxbin` file into the 'ScriptUI Panels' folder in your version of After Effects.
14+
15+
**If you’re using macOS, this can be found here:**
16+
17+
`Applications/Adobe After Effects/Scripts/ScriptUI Panels`
18+
19+
**If you’re using Windows, this can be found here:**
20+
21+
`Program Files/Adobe/Adobe After Effects/Support Files/Scripts/ScriptUI Panels`
22+
23+
## Support
24+
25+
If the user guide doesn’t answer your questions, or you have any feedback that you’d like to give, please open
26+
a support ticket at [aescripts.com](https://aescripts.com/contact/?direct=1&product_id=1996).

docs/Loopy/Instructions.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# How to Use Loopy
2+
3+
Loopy can be used to loop almost anything within After Effects.
4+
5+
Select the properties and/or layers that you want to loop, and press one of the four Loop buttons to apply a loop to these (*Continue*, *Ping pong*, *Offset* or *Continue* loop types). Loop expressions can be applied to multiple selected layers and/or properties at the same time.
6+
7+
!!! note "Note"
8+
9+
Some properties and effects don't support all loop types.
10+
11+
## Looping paths and masks
12+
13+
The native `loopIn()` and `loopOut()` expressions do not work when applied to shape or mask paths. When one of these properties is selected, Loopy detects this and automatically applies a custom loop expression instead.
14+
15+
The Loop Direction button toggles between 'Loop In', 'Loop Out', and both 'Loop In' and 'Loop Out' together.
16+
17+
## Looping audio-visual layers and pre-comps
18+
19+
When an AV layer or pre-comp is selected, without selecting any properties on that layer, Loopy will apply Time Remap, place keyframes at the trimmed In and Out point, and loop this property. (If the layer does not support Time Remap, the layer will be skipped, with a warning shown.)
20+
21+
If the Time Remap property is already active and has an expression applied, Loopy will only replace the expression, without modifying keyframes.
22+
23+
Alt/Option-clicking the '*Cycle Loop*' button will apply Time Remap and place keyframes at the trimmed In and Out points, but will not apply any expressions. If the Time Remap property is already active, the layer will be unaffected.
24+
25+
## Loop direction
26+
27+
The '*Loop Direction*' button toggles between 'Loop In' (loop before any keyframes), 'Loop Out' (loop after any keyframes), and both 'Loop In' and 'Loop Out' together (loop before and after any keyframes).
28+
29+
## Keyframe modifier
30+
31+
The Set Keyframe Modifier field limits the loop behaviour to a specific number of keyframes (layer selections will be ignored). Alt-click this field to revert to its default value of 0.
32+
33+
The Keyframe Modifier toggle ensures that the Keyframe Modifier value doesn't exceed the number of existing keyframes.
34+
35+
!!! note "Note"
36+
37+
The '*Continue*' loop type doesn't support the keyframe modifier parameter.
38+
39+
## Keep expressions
40+
41+
The Keep Expressions toggle will comment out and retain any existing expression on a property.

docs/Loopy/KBar.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Using Loopy with KBar
2+
3+
Loopy is configured for use with KBar — simply change the ‘Script function or argument’ value (see screenshot below) to change the function of the KBar button. You will need to relink the script file field to point to the installed `Loopy.jsxbin` file. There are provided icons for each of these functions.
4+
5+
If you are using KBar3, there is a `.kbar` file included for easy import of the toolbar buttons.
6+
7+
![Screenshot of a KBar settings panel](../assets/loopy/kbar.png){ width="600" }
8+
9+
| | Function | Script argument | Suggested key modifier |
10+
| --- | ----------- | ----------- | ----------- |
11+
| ![Icon for Loopy panel](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loopy.png){width="32"} | Open Loopy panel | (None) ||
12+
| ![Icon for 'Cycle loop'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loop%20Cycle.png){width="32"} | Apply a 'Cycle' loop | 1 | Mac: **Cmd**</br >Windows: **Ctrl** |
13+
| ![Icon for 'Ping Pong loop'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loop%20Ping%20Pong.png){width="32"} | Apply a 'Ping Pong' loop | 2 | Mac: **Option**</br >Windows: **Alt** |
14+
| ![Icon for 'Offset loop'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loop%20Offset.png){width="32"} | Apply an 'Offset' loop | 3 | Mac / Windows: **Shift** |
15+
| ![Icon for 'Continue loop'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loop%20Continue.png){width="32"} | Apply a 'Continue' loop | 4 | Mac: **Cmd + Shift**</br >Windows: **Ctrl + Shift** |
16+
| ![Icon for 'Change loop direction'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Loop%20Direction.png){width="32"} | Change loop direction | 5 | Mac: **Option + Shift**</br >Windows: **Alt + Shift** |
17+
| ![Icon for 'Apply Time Remap'](../assets/loopy/Loopy%20-%20KBar%20Blue%20-%20Time%20Remap.png){width="32"} | Apply Time Remap without applying an expression | 6 | Mac: **Cmd + Option**</br >Windows: **Ctrl + Alt** |

docs/Loopy/Loop Examples.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Loop Examples
2+
3+
Rive below
4+
5+
<canvas id="voting" width="200" height="80" role="spinbutton" aria-valuenow="994" aria-valuetext="994 likes"></canvas>
6+
<script>
7+
8+
</script>
9+
10+
Rive above
11+
12+
## Cycle
13+
14+
=== "Loop In"
15+
16+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
17+
18+
```jsx
19+
loopIn("continue");
20+
```
21+
22+
=== "Loop Out"
23+
24+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
25+
26+
```jsx
27+
loopOut("continue");
28+
```
29+
30+
=== "Loop In + Out"
31+
32+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
33+
34+
```jsx
35+
loopIn("continue") + loopOut("continue") - value;
36+
```
37+
38+
## Cycle (with Keyframe Modifier)
39+
40+
=== "Loop In (with Keyframe Modifier)"
41+
42+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Cycle%20-%20In%20-%20Keyframe.gif )
43+
44+
```jsx
45+
loopIn("cycle", 2);
46+
```
47+
48+
=== "Loop Out (with Keyframe Modifier)"
49+
50+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
51+
52+
```jsx
53+
loopOut("cycle", 2);
54+
```
55+
56+
=== "Loop In + Out (with Keyframe Modifier)"
57+
58+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
59+
60+
```jsx
61+
loopIn("cycle", 2) + loopOut("cycle", 2) - value;
62+
```
63+
64+
## Continue
65+
66+
=== "Loop In"
67+
68+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In.gif)
69+
70+
```jsx
71+
loopIn("continue");
72+
```
73+
74+
=== "Loop Out"
75+
76+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20Out.gif)
77+
78+
```jsx
79+
loopOut("continue");
80+
```
81+
82+
=== "Loop In + Out"
83+
84+
![Loopy panel with Cycle button highlighted](../assets/loopy/example_loops/Continue%20-%20In%20Out.gif)
85+
86+
```jsx
87+
loopIn("continue") + loopOut("continue") - value;
88+
```
89+
90+
!!! note "Note"
91+
92+
The '*Continue*' loop type does not support keyframe modifiers.

docs/Loopy/Panel.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Panel Functions
2+
3+
## Cycle
4+
5+
![Loopy panel with Cycle button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Cycle.png){ width="240" }
6+
7+
Click to apply a 'Cycle' loop. These are loops that will repeat the animation from the beginning.
8+
9+
```jsx
10+
loopOut();
11+
```
12+
13+
!!! info "Note"
14+
15+
This is the default loop type, so no parameter is needed in the `loopIn()` or `loopOut()` expression.
16+
17+
## Ping Pong
18+
19+
![Loopy panel with Offset button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Ping%20Pong.png){ width="240" }
20+
21+
Click to apply a 'Ping Pong' loop. These are loops that will run in reverse before repeating from the beginning.
22+
23+
```jsx
24+
loopOut("pingpong");
25+
```
26+
27+
## Offset
28+
29+
![Loopy panel with Offset button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Offset.png){ width="240" }
30+
31+
Click to apply an 'Offset' loop. These are loops that will increment in value each time they repeat.
32+
33+
```jsx
34+
loopOut("offset");
35+
```
36+
37+
## Continue
38+
39+
![Loopy panel with Continue button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Continue.png){ width="240" }
40+
41+
Click to apply a 'Continue' loop. These are loops that will continue the movement of the animation at the speed of the last keyframe.
42+
43+
```jsx
44+
loopOut("continue");
45+
```
46+
47+
## Time Remap
48+
49+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Time%20Remap.png){ width="240" }
50+
51+
Alt/Option-click this button to apply time remapping to a layer without a loop expression. This is useful for when you've trimmed a layer and want to quickly create Time Remap keyframes at the In and Out points of the layer.
52+
53+
## Change Loop Direction
54+
55+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Direction.png){ width="240" }
56+
57+
Click to set the direction of the loop applied by the buttons above. Toggle between: Loop In; Loop Out; Loop In + Loop Out.
58+
59+
## Keyframe Modifier
60+
61+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Keyframes.png){ width="240" }
62+
63+
When set to a value greater than zero, a parameter is added to the loop expression to limit the loop to this number of keyframes before the last (or after the first, for a Loop In).
64+
65+
```jsx
66+
loopOut("cycle", 3);
67+
```
68+
69+
For example, if this value were set to 3, and the property has 10 keyframes, when applying Loop Out, the animation will loop between the 7th and 10th keyframes.
70+
71+
![Screenshot of keyframes in an After Effects timeline](../assets/loopy/Loopy%20-%20Timeline%20Keyframes%20Modifier.png)
72+
73+
If this value is set to zero, it is ignored and the keyframe modifier is not added to the expression.
74+
75+
Alt/Option-click to reset the value to zero.
76+
77+
## Limit Keyframe Modifier
78+
79+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Limit%20Keyframes.png){ width="240" }
80+
81+
When active, the value set in the Keyframe Modifier field will be modified before being used in the loop expression. It will ensure that the value used is no greater than the highest valid value for a property.
82+
83+
For example, if the Keyframe Modifier value is 10, but the selected property only has five keyframes, this would cause an error. With this toggle active, the Keyframe Modifier value will be adjusted to 4 before being used in the expression.
84+
85+
```jsx
86+
loopOut("cycle", 4); // With 5 keyframes, this is valid
87+
```
88+
89+
When inactive, the value set in the Keyframe Modifier field will be used as-is. In some versions of After Effects, this may result in an expression error if this value greater than the highest valid value on a property; in later versions, the animation will simply loop between the first and last keyframes. This might be desirable if you are applying loop expressions to properties that you will later add sufficient keyframes to.
90+
91+
```jsx
92+
loopOut("cycle", 10);
93+
/* With 5 keyframes, this is invalid and will loop between
94+
all keyframes, or possibly throw an expression error */
95+
```
96+
97+
## Keep Expressions
98+
99+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Expression.png){ width="240" }
100+
101+
When active, any existing expression on a property will be retained and commented out below the new loop expression.
102+
103+
When inactive, any existing expressions are removed before applying the loop expression.
104+
105+
```jsx
106+
loopOut("pingpong");
107+
108+
// == PREVIOUS EXPRESSION: ==
109+
//
110+
// value * 360
111+
```
112+
113+
## Information Panel
114+
115+
![Loopy panel with Time Remap button highlighted](../assets/loopy/Loopy%20-%20Panel%20-%20Info.png){ width="240" }
116+
117+
Click to open the Information panel. This panel contains:
118+
119+
- Version details of the script
120+
- Link to support on the aescripts website
121+
- Instructions on how to use Loopy
122+
- Licence registration information
123+
- Option and button to check for script updates
124+
- Licence the script, or deactivate your licence
125+
- Reset the Loopy panel to the default state.

docs/Loopy/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Loopy
2+
3+
<div class="video-wrapper">
4+
<iframe width="560" height="315" src="https://www.youtube.com/embed/qaXCFFhMkKY?si=Nm3FtLolH9_rZI9L" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
5+
</div>
6+
7+
Loopy is the handy panel for looping keyframes, paths, pre-comps and footage.
8+
9+
[Learn more and buy now at **aescripts.com**](https://aescripts.com/loopy/)

docs/Loopy/src/LoopExamples.riv

443 KB
Binary file not shown.

docs/Loopy/src/Loopy_Examples2.riv

170 KB
Binary file not shown.

0 commit comments

Comments
 (0)