Theme Structure

A theme is a folder of files. Shared files live in its root, and you only add a resolution folder when a particular screen size needs something different. A small theme can be as little as one scheme, a wallpaper and a few glyphs.

How MustardOS finds a file

Resolution folderIt looks in the folder for the device's resolution first, such as 1920x1080.
Theme rootIf the file is not there, it uses the copy in the theme root.
Bundled themeAnything your theme leaves out comes from the bundled MustardOS theme.

Resolution folders can be named:

640x480720x480720x576720x7201024x768 1280x7201920x1080

What goes in a theme

schemeColours, sizes and layout, globally, by default and for each screen. Scheme Files
fontTrueType fonts for the whole theme, a screen, a language or an area of the screen. Custom Fonts
glyphIcons for lists, the header, the footer, status and navigation. Glyph Gallery
image/wallWallpapers, shared or for a single screen. Images and Video
image/staticArtwork drawn over a screen, or shown for one list item.
alternateSelectable variations of the theme. Theme Alternatives
soundInterface sounds supplied by the theme.

A theme root can also hold these files:

name.txtThe theme's name.
version.txtThe theme's version.
credits.txtWho made it.
active.txtWhich alternative is selected when the theme is first used.
assets.muxzipExtra files, such as matching catalogue artwork, installed when the theme is selected. Theme Assets

Here is a fuller example. Only include the folders and files your theme needs.

.
├── name.txt
├── version.txt
├── credits.txt
├── active.txt
├── assets.muxzip
├── alternate
│   ├── Dark.ini
│   ├── Light.muxalt
│   └── rgb
│       └── Dark
│           └── rgbconf.sh
├── font
│   ├── default.ttf
│   ├── header
│   │   └── default.ttf
│   ├── footer
│   │   └── default.ttf
│   └── panel
│       └── default.ttf
├── glyph
│   └── muxlaunch
│       ├── explore.svg
│       └── config.svg
├── image
│   ├── background.mp4
│   ├── static
│   │   └── muxlaunch
│   │       └── explore.png
│   └── wall
│       ├── default.png
│       └── muxlaunch.png
├── scheme
│   ├── global.ini
│   ├── default.ini
│   └── muxlaunch.ini
├── sound
└── 1920x1080
    ├── font
    ├── glyph
    ├── image
    └── scheme

Files for one screen

Each screen has a module name, shown in its Grand Tour page address. Name a file after the module to use it only on that screen, and use default for everything without its own file.

muxlaunchMain Menu
muxploreExplore Content
muxconfigConfiguration
muxcustomCustomisation
muxretroPickles

Use the same name everywhere:

scheme/muxlaunch.ini
font/muxlaunch.ttf
glyph/muxlaunch/explore.svg
image/wall/muxlaunch.png
image/static/muxlaunch/explore.png

Files for a single list item use that item’s internal glyph or content name.

How schemes are layered

Each layer is applied in order, and later layers win:

GlobalThe root scheme/global.ini.
Defaultscheme/default.ini, from the resolution folder or root.
Screenscheme/{module}.ini, from the resolution folder or root.
AlternativeThe alternative the user selected.
User overrideThe user's own MUOS/theme/override/{module}.ini.

Scheme Files lists every supported setting.

Use the bundled MustardOS theme as the reference for glyph names. Missing glyphs fall back to the bundled theme, so set a glyph’s alpha to zero in the scheme when it should stay hidden.