2.4. Configuration of paths

2.4. Configuration of paths

In KiCad, one can define some paths using an environment variable. A few environment variables are internally defined by KiCad, and can be used to define paths (for libraries, 3D shapes, etc).

This is useful when absolute paths are not known or are subject to change. This is the case for “official” libraries built for KiCad:

  • for the path of these libraries, when installed on your disk
  • for the path of 3D shapes files used in footprint definitions.

For instance, the full path of connect.pretty footprint library is defined like this, when using the KISYSMOD environment variable to define the full path: ${KISYSMOD}/connect.pretty

Obviously, one can use a usual full path definition, if this full path is well known, and never changes.

This option allows you to define some paths from an environment variable, and add your own environment variables, to define personal paths, if needed.

KIGITHUB

frequently used in footprint lib tables examples. If you are using this variable, it must be defined.

KISYS3DMOD

default base path of 3D shapes files, and must be defined, because an absolute path is not usually used.

KISYSMOD

default base path of footprint library folders, and must be defined, if an absolute path is not used in footprint library names.

images/configure_path_dlg.png

Note also the environment variable

  • KIPRJMOD

is always internally defined by KiCad, and is the current project absolute path.

For instance, ${KIPRJMOD}/connect.pretty is always the connect.pretty folder (the pretty footprint library) found inside the current project folder.

  • If you modify the configuration of paths, please quit and rerun KiCad, to avoid any issues in path handling.