👉🏼 TIP: With Avocode 2.24 (and higher) you can import Sketch designs also directly - just by drag & drop. It works on Windows, Linux, macOS (without Sketch app) and even on the web. Learn more.
Set up the Sketch plugin
Make sure you have the latest version of the Avocode desktop app for macOS.
If you still have the old Avocode Sketch plugin, installing the latest version of Avocode should automatically overwrite it.
Open a design in the Sketch app
NOTE: Uploading Sketch designs to Avocode requires to have a macOS 10.9 and higher and with Sketch 41 and higher.
Sync selected Sketch artboards to Avocode
Go to the window menu bar to Plugins, select Avocode/Hand-off/Sync Selected Artboards
TIP: Press CMD + J in Sketch to upload selected artboards to Avocode.
Sync all Sketch artboards (entire design file) to Avocode
Go to the window menu bar to Plugins, select Avocode/Sync changes.
TIP: Press CMD + OPTION + J in Sketch to upload all artboards to Avocode.
You can exclude Pages or Artboards from syncing to Avocode by renaming them:
- just add _ at the beginning of the _Page or _Artboard name.
- or just add - at the beginning of the -Page or -Artboard name.
This workflow should speed things up when you’re syncing bigger Sketch files.
FYI: The same thing works with Adobe XD designs.
Quickly access your projects
Go to the window menu bar to Plugins, select Avocode/Open Avocode.
TIP: Press CMD + P in Sketch to switch to Avocode Project Manager. It will be opened in a new tab.
Add Sketch artboards to a project in Avocode
Your Avocode app will automatically open so you can add the designs to a particular project.
You can also create a new project where you will upload this design.
NOTE: You can keep working in Sketch during the upload. You can watch the upload progress on the Avocode icon in your Dock. Please don't close the Avocode app during the design upload.
Once the design upload is finished and you see that it is "processing" in the popup notification, you can close your Sketch app.
In order to access the uploaded design, open the project where you uploaded it.
How to sync Sketch Symbols?
Symbols are synced automatically with artboards. You are then able to open all the symbols in Avocode automatically, instead of having to sync them manually again.
NOTE: If you're syncing via Sync selected artboards:
- when syncing an unchanged Sketch artboard which uses a changed Symbol, the artboard and all Symbols on the path from the artboard to the (nested) Symbol are included in the version tracking.
- when syncing a changed Sketch Symbol, any unselected artboards which use the symbol are NOT automatically included in the version tracking.
NOTE: If you're syncing via Sync changes:
- when there is a changed Symbol in the synced file, all artboards (and Symbols) which use it are included in the version tracking (including Symbols on the path from the artboard to the (nested) Symbol).
How to sync Sketch Libraries?
Whenever you sync a Sketch file with library symbols, the plugin will automatically sync the symbols as if they were normal symbols, so you don't need to do anything yourself.
How to upload new Sketch design versions?
Make sure uploaded artboards are named exactly as they were in the previous version and that they are located on the same page as they were previously. Avocode will take care of the rest.
If some artboards already exist in the project, they are synced and added as new versions.
If the artboard has a different name than in the previous version, it will be added as a new design.
NOTE: If you duplicate a Sketch artboard and sync it, it will be uploaded as a new design to Avocode.
- Please make sure you're using our latest Sketch plugin - at best v. 50.0.0 or higher.
If you don't see the plugin in your Sketch...
That means that the automatic installation must have failed somehow. Please make sure your Sketch app is named "Sketch" and that it is located in your Applications or Downloads folder. Then go to your Avocode app and reinstall the plugin from the Help menu:
The upload takes way too long
That might happen when there are too many layers in the design. The reason may vary, but usually, it is some form of a pattern formed from a lot of vector layers (stripes, world map made of vector dots,...).You can combine all the path layers which form that shape to be exported as one layer with Layer -> Combine -> Union - this will create a single layer out of them that should export correctly and much faster.
You get a "Processing failed" error
First of all make sure that the Sketch file actually contains at least one artboard. We cannot display layers which are not inside of any artboard at the moment, so if we can't find at least one artboard in the design, the upload fails.
Second thing that might cause this issue is when all your artboards are prefixed with “-“ or “_” in the artboard name. These symbols (“-“ or “_”) are our syntax marks for skipping artboards in case you do not want to sync them with your file, therefore if all artboards are prefixed with it, the upload fails.
In case of any other problems
Please do let us know in the in-app chat or at firstname.lastname@example.org.