| Installation | Updating | Usage | Known Issues | Development |
Adobe Wakatime brings Wakatime's time-tracking functionality to Adobe products.
It works by using Adobe's CEP API to retrieve details like the application name, version, operating system, and machine info. The plugin detects activity by monitoring changes to the active project file every 30 seconds and sending a heartbeat if any change is detected!
Currently supported features:
- Tracking time (every 30 seconds)
- Tracking file path
- Tracking file name
- Tracking machine name
- Tracking editor name
- Tracking OS name
Note > t; 💡 This plugin requires an internet connection and will not track time while offline.
💡 You can modify the project name, language, category, etc. using the Custom rules in your dashboard.
This plugin uses Adobe Manifest v5 and Adobe CEP 11.
- Photoshop (only if
legacyis available) - After Effects
- Audition
- Illustrator
- Premiere Pro
- Please note: these applications have been tested with this plugin, there may be other compatible Adobe applications that are not listed here.
Warning You must Enable loading of unsigned panels. You can find the tutorial on how to do it here.
-
Download the latest version of
wakatime-adobe-cep.zipfrom the Releases page or click here to download directly. -
Locate the extensions folder (CEP supports 2 types of folders for unsigned extensions):
-
IMPORTANT > t; If the directory does not exist, you must create it manually.
-
System extension folder
- Win(x86):
C:\Program Files (x86)\Common Files\Adobe\CEP\extensions\ - Win(x64):
C:\Program Files\Common Files\Adobe\CEP\extensions\ - macOS:
~/Library/Application Support/Adobe/CEP/extensions/
- Win(x86):
-
Per-user extension folder
- Windows:
C:\Users\\AppData\Roaming\Adobe\CEP\extensions\sions\ - macOS:
~/Library/Application Support/Adobe/CEP/extensions/
- Windows:
-
-
Extract the
wakatime-adobefolder from the downloaded zip file into theextensionsfolder.
To update, follow the same steps as the initial installation.
Then remove the previous wakatime-adobe folder and replace it with the latest version from the zip file.
Important > t; THE PANEL WINDOW MUST NOT BE CLOSED. > t; YOU CAN EXPAND/COLLAPSE/DOCK OR JUST KEEP IT AS A FLOATING WINDOW BUT NEVER CLOSE THE PANEL.
-
Open the Adobe application after you install this plugin.
Important > t; A project must be open for the plugin to work! Open a project first before launching the plugin.
-
Select in the toolbar:
(CEP) Window > Extensions > Wakatimekatime
-
Paste your API key into the input field and click the Save button (Get your API key here).
3.5. If you want to track time using Hackatime, update the API URL to:
https://hackatime.hackclub.com/api/hackatime/v1
-
The
statusshould automatically update after 30 seconds if the plugin is tracking time (it sends data every 30 seconds)- If it still shows "Disconnected," make sure you have an open file for the plugin to work. Don't worry if it initially shows "Disconnected" before you open a file.
-
To disable the plugin, uncheck the "Plugin enabled" checkbox.
-
Select in the toolbar:
Windows: Edit > Preferences > Autosavetosave
macOS: {Application Name} > Preferences > Autosavetosave
And make sure "Automatically save projects" is checked and the auto-save time is set to <= 2 minutes.es.
Connected - The plugin is working as intended.
Unauthorized - The provided API key is likely invalid, or you do not have permission to access the resource.
Disconnected - The plugin only works when you have an open file and an internet connection. Make sure you have an open file and you are not on the Home screen.
Unavailable - The server responded with an
error 500and is currently unavailable.Disconnected (despite being working before) - The plugin may have sent too many requests in a short period and hit a rate limit.
Note > t; The status may show "Disconnected" for any connection error or bad request.
-
Config is randomly cleared when you close the application.
Sometimes the plugin storage may be completely cleared when updating the extension or the application. There's no fix from my side for this.
-
The connection status always shows as Disconnected
Arrr. If you're sailing with the Caribbean version of the application, check if there are no rules in your Firewall that are blocking connections.
-
The CEP panel may not allow writing while holding the
⇧ Shiftkey.Workaround: use
⇪ Caps Lockkey. -
The CEP panel may not allow writing into input fields.
Workaround: simply copy and paste the text.
-
The CEP panel may not allow copy and pasting into input fields.
Workaround: simply type into the input fields.
- Install the project dependencies, execute:
npm install - Run the CEP watch mode to automatically rebuild the plugin whenever changes are made. Execute:
npm run watch:cep
To use the CEP plugin with the supported Adobe applications (listed in plugin/CSXS/manifest.xml), you need to copy the dist folder to the appropriate location. The CEP.sh shell script automates this process.
Follow the steps below to correctly debug the plugin:
- Locate the
CEP.shfile in thescriptsfolder. - Open the
CEP.shfile and specify the destination folder path for theextensionsfolder. Update the script accordingly (see Installation for the default paths) - Save the changes to the
CEP.shfile. - Run the
CEP.shscript. It will automatically copy thedistfolder to the defined path. - Open any of the supported applications and open the plugin panel. Select Window > Extensions > Wakatimekatime in the toolbar.
- Open your browser, a Chromium-based browser is recommended for the best experience, and navigate to default host port
localhost:7778(you can manually update all hosts debugging ports inplugin/.debugfile) - Whenever you make changes to the CEP plugin code, run the
CEP.shscript again. In the DevTools, click the reload button (located at the top-left corner) to load the updated version of the CEP plugin.
To build the CEP plugin, execute the following command:
npm run build:cepThis command will compile the CEP. The generated files will be packaged into a zip file located in the release folder as wakatime-adobe-cep. Code optimizations will be applied and some debugging files removed.
Warning Sometimes Typescript loses track of CSInterface library. To fix any errors, copy the file from
plugin/lib/CSInterface.jsto thesrcfolder.
You can find all CEP 11 documentation here.
Made with ❤️ by Irtaza
Please star the repo!!
Slack: @Irtaza