Type1 (injection based replacements)

Form of XML files located at the root of each overlay folder /overlays/packagename/*, e.g. type1a_Red_Accent

A type 1 overlay is used to hotswap an existing file inside the res/values/* folder. This means you can change your bools, colors, dimens and styles. To add a space in the name, use the underscore symbol, Substratum will handle the rest.

By default, the spinners will say “type1a variant…” depending on your type1 spinner. You can change this text by creating a file “type1a” (or b or c) on the root of your overlays/packagename/* folder and add the default text you would like to show instead. Color previews default to the first hex available in each xml.

assets/overlays/packagename/type1a.xml  → res/values/type1a.xml (both must be present)
assets/overlays/packagename/type1b.xml  → res/values/type1b.xml (both must be present)
assets/overlays/packagename/type1c.xml  → res/values/type1c.xml (both must be present)

Type2 (resource (/res) base extensions)

Form of folders on the root of each overlay folder /overlays/packagename/*, e.g. type2_DarkMode

These are folders that will be built on top of the /res (default) folder. What this means is that if you have a type2 option, you don’t have to add everything from /res into the /type2_name folder. During compile, if your /res folder exists, it will build together and merge them together. To add a space in the name, use the underscore symbol, Substratum will handle the rest.

By default, the spinners will say “type2 variant…”. You can change this text by creating a file “type2” at the root of your overlays/packagename/* folder and add the default text you would like to show instead.

Type3 (resource base)

Form of folders on the root of each overlay folder /overlays/packagename/* based on Framework, e.g. type3_DarkFramework

These are folders that will be built as a replacement for the /res (default) folder. This is completely dependent on the framework containing the exactly named folder (e.g. overlays/android/type3_DarkTheme). Once this is selected, any overlay that is chosen to be built will build their own overlay type3 folders (overlays/packagename/type3_DarkTheme) without selecting any spinner options. If this folder does not exist, you will see the LogChar. To add a space in the name, use the underscore symbol, Substratum will handle the rest.

By default, the spinners will say “default base variant…”. You can change this text by creating a file “type3” at the root of your overlays/packagename/* folder and add the default text you would like to show instead.

Type4 (asset base)

Form of folders on the root of each overlay folder /overlays/packagename/*, e.g. type4_Telegram_Android_Emojis

These are folders that will be built as the /assets folder of your target application. You should safely assume that anything you name your type4_name folder, will be named assets when it builds with Substratum. To add a space in the name, use the underscore symbol, Substratum will handle the rest.

By default, the spinners will say “type4 variant…”. You can change this text by creating a file “type4” at the root of your overlays/packagename/* folder and add the default text you would like to show instead.