Special Folders and Portability

There are a variety of special folders which can be configured for use with Visual Micro, to allow your project to be more portable (available from version 23.0424.3 onwards).

This is useful when you want to share your project, along with all libraries in use.  Board packages can also be distributed with the project when using Portable Mode.

Note iconNote:

When using special folders it is best to have the solution folder, with the project in a subfolder

(i.e. ensure the "Create Project and Solution in the same folder" is unchecked when creating the solution).

Note iconNote:

When using special folders you can navigate the source code and view files in Solution Explorer using the vMicro > Show/Hide Hidden Files.

Complementary Special Folders

These special folders can be used alongside your normal Sketchbook location, and board package installations.

All of these folders can work together in a single solution.

YourSolutionFolder/arduino-solution/libraries

Override existing config with one or more libraries

These libraries appear on the "Add Library" menu

These libraries have highest priority, regardless of what other libraries are installed in either the sketchbook or Arduino IDE folder.

These libraries continue to follow the standard rules when being discovered, architectures= applies as normal

 

YourSolutionFolder/arduino-ide/libraries

Override existing config with one or more libraries

These libraries appear on the "Add Library" menu

These libraries have a higher priority than IDE libs but lower than sketchbook

These libraries continue to follow the standard rules when being discovered, architectures= applies as normal

 

Overriding Special Folders

These special folders will override your current configuration completely, making a more isolated environment.

Only one of the below approaches should be used at a time, and should not be used in conjunction with the complementary special folders above.

YourSolutionFolder/arduino-solution/sketchbook

This folder will replace all the functionality of a sketchbook folder

File>OpenArduinoProject will show this folder

ALL sketchbook functionality is supported including library and hardware sub folder

New libraries will be installed into /Libraries sub folder

Everything is same as simply changing the sketchbook folder in arduino ide or visual micro IDE locations.

 

YourSolutionFolder/arduino-portable

Works to same rules as the Arduino IDE Portable folder (Read More Here).

New toolchains are installed into it.

The sketchbook, is not specified elsewhere, will be located as a sub folder