Skip to content

Commit af4e1e7

Browse files
committed
Updates documentation
1 parent dfc3a4c commit af4e1e7

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Script runner for Adobe applications right from VSCode. Extension available for
1515

1616
## Features
1717

18-
Adobe Script Runner executes script in the active viewer by default. However, when working with multi-file scripts, it is common to set a path to execute a master file, i.e `index.js`, from within a file that's in the active view. Such behavior can be modified using [Token](#token) or setting up [execute this](#execute-this) file in the settings.
19-
2018
Run commands are accessible via `Command Palette`. Simply click `F1` or `Cmd+Shift+P` and start typing the name of `supported applications`. Click enter to run the script inside the selected application.
2119

2220
The extension will open host application first if it's not running, and then execute the script.
@@ -25,6 +23,8 @@ The extension will open host application first if it's not running, and then exe
2523
2624
Map keyboard shortcuts to execute a script even faster - `Cmd+R` is bind to run a script inside After Effects by default. Read how to change it in [Key bindings](#key-bindings).
2725

26+
Adobe Script Runner executes script in the active viewer by default. However, when working with multi-file scripts, it is common to set a path to execute a master file, i.e `index.js`, from within a file that's in the active view. Such behavior can be modified using [Token](#token) or setting up [execute this](#execute-this) file in the settings.
27+
2828
## Installation
2929

3030
- ### From VSCode application
@@ -41,27 +41,6 @@ Map keyboard shortcuts to execute a script even faster - `Cmd+R` is bind to run
4141
- Click `Cmd+R` on Mac or `Ctrl+R` on Windows, or launch `Command Palette` with keyboard shortcut `F1` or `Cmd+Shift+P`, and type `Adobe After Effects` and click enter.
4242
- Hopefully After Effects will fire up and execute your script 🙏
4343

44-
## Token
45-
46-
Use token to execute a different file, rather than the one in the viewer. Add `Adobe-script-runner "path/to/file.jsx"` at the beginning of the file in the active document to always execute the file between quotes.
47-
48-
```javascript
49-
/*
50-
Adobe-script-runner '../../index.js'
51-
Executes file between quotes rather than the one in the active viewer.
52-
*/
53-
54-
alert('Hello World'); // This line never gets executed, unless `index.js` is referencing the file in viewer.
55-
```
56-
57-
The file path gets resolved by joining the path of the file in the viewer and the file within the quotes.
58-
59-
## Execute this
60-
61-
Use this option to set-up a path to a file to execute always, ignoring the file in the viewer, globally or per-project basis. To do so, open settings (`Cmd+,` on Mac or `Ctrl+,` on Windows) and set the path to a file in **Extensions -> Adobe Script Runner -> Execute This**.
62-
63-
The file path gets resolved by joining this path and the Workspace (or Root `/`) folder.
64-
6544
## Key bindings
6645

6746
Keyboard shortcut `Cmd+R` is bind to `adobeScriptRunner.ae` command, which will run a script inside Adobe After Effects. To change the command or assign a different shortcut, do the following:
@@ -83,6 +62,27 @@ The result should look something like this:
8362

8463
For more information about keybinding check official [Key Bindings for Visual Studio Code](https://code.visualstudio.com/docs/getstarted/keybindings).
8564

65+
## Token
66+
67+
Use token to execute a different file, rather than the one in the viewer. Add `Adobe-script-runner "path/to/file.jsx"` at the beginning of the file in the active document to always execute the file between quotes.
68+
69+
```javascript
70+
/*
71+
Adobe-script-runner '../../index.js'
72+
Executes file between quotes rather than the one in the active viewer.
73+
*/
74+
75+
alert('Hello World'); // This line never gets executed, unless `index.js` is referencing the file in viewer.
76+
```
77+
78+
The file path gets resolved by joining the path of the file in the viewer and the file within the quotes.
79+
80+
## Execute this
81+
82+
Use this option to set-up a path to a file to execute always, ignoring the file in the viewer, globally or per-project basis. To do so, open settings (`Cmd+,` on Mac or `Ctrl+,` on Windows) and set the path to a file in **Extensions -> Adobe Script Runner -> Execute This**.
83+
84+
The file path gets resolved by joining this path and the Workspace (or Root `/`) folder.
85+
8686
## Settings
8787

8888
Click `Cmd+,` on Mac or `Ctrl+,` on Windows to modify settings. Extension exposes the following settings:

0 commit comments

Comments
 (0)