@Include option


The @Include option loads the content of an external .ini at the position it is defined. The loaded file is treated as if the contents were included in the actual skin .ini file. A frequent use case is to have an include file with a [Variables] section in order to share variables between multiple skins.

Options

@Include, @Include2, @IncludeN

Path to the INI formatted file to include. It is recommended that include files use the .inc extension (rather than .ini) and are placed in the @Resources folder.

The N in @IncludeN can also represent text. For example: @Include2, @Include3, @IncludeVariables, and @IncludeMeters are all valid.

Remarks

The statement may be placed in any section. When the skin is loaded, all new sections from the included file are inserted immediately after the section where the statement is placed. Rainmeter treats these sections - whether they're measures, meters, MeterStyles, etc. - exactly as if they had been written in the skin .ini itself, and appropriately determines things like layering, relative positions and referenced measure values.

You may also include files within files. Once again, the ordering is determined by placement: when any file includes another file, the new contents are added within its own sections, immediately after the section where the statement is made.

If there is a conflict - that is, if the same section exists in more than one file - Rainmeter will treat whichever one comes first in the ordering as the "real" section. Any options on the later instances will be added to the first one, and otherwise the later instances are simply ignored. If there are different values given for the same key, the last value is taken. Unlike new sections, options on pre-existing sections are added in their original order, so the calling section may overwrite values from the included file if they are placed below the @include statement.

See also: @Include Guide

Example

IncludeFile.inc:

[Variables]
Color=255,255,255,255

Skin.ini:

[Variables]
Font=Arial
@Include=IncludeFile.inc

[SomeMeter]
FontFace=#Font#
FontColor=#Color#