Skip to content

World HUD style proposed

Schema reference / World HUD style / proposed

Proposed bounded, declarative HUD style a world package may ship (colours, corners, font, icons, stroke, warp).

Status
Proposed
Published
2026-10-08
Title
“Proposed world HUD style 1”
Dialect
JSON Schema 2020-12 · unknown fields rejected unless marked
Raw schemahud-style.schema.json · 118 lines · 2.6 KB
DownloadOpen rawsha256 7ffd094df592…
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://hyprune.com/schema/extensions/hud-style.schema.json",
"title": "Proposed world HUD style 1",
"type": "object",
"additionalProperties": false,
"required": [
"version"
],
"properties": {
"version": {
"const": 1
},
"colors": {
"type": "object",
"additionalProperties": false,
"properties": {
"accent": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"foreground": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"muted": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"tile": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"outline": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"scrim": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
}
}
},
"stroke": {
"type": "object",
"additionalProperties": false,
"properties": {
"width": {
"type": "number",
"minimum": 1,
"maximum": 3
},
"style": {
"enum": [
"outline",
"shadow"
]
}
}
},
"corners": {
"enum": [
"square",
"bevel",
"round"
]
},
"font": {
"type": "string",
"maxLength": 200,
"pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.(ttf|otf)$"
},
"icons": {
"type": "object",
"additionalProperties": false,
"properties": {
"navigate": {
"type": "string",
"maxLength": 200,
"pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
},
"window": {
"type": "string",
"maxLength": 200,
"pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
},
"path": {
"type": "string",
"maxLength": 200,
"pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
},
"position": {
"type": "string",
"maxLength": 200,
"pattern": "^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\\.svg$"
}
}
},
"warp": {
"enum": [
"default",
"ribbons",
"soft"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9][a-z0-9.-]*$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
}

Fields

FieldTypeConstraints
versionrequired1
colorsobject
accentstringpattern ^#[0-9a-fA-F]{6}$
foregroundstringpattern ^#[0-9a-fA-F]{6}$
mutedstringpattern ^#[0-9a-fA-F]{6}$
tilestringpattern ^#[0-9a-fA-F]{6}$
outlinestringpattern ^#[0-9a-fA-F]{6}$
scrimstringpattern ^#[0-9a-fA-F]{6}$
strokeobject
widthnumber≥ 1 · ≤ 3
style"outline" | "shadow"
corners"square" | "bevel" | "round"
fontstringlength ≤ 200 · pattern ^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(ttf|otf)$
iconsobject
navigatestringlength ≤ 200 · pattern ^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.svg$
windowstringlength ≤ 200 · pattern ^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.svg$
pathstringlength ≤ 200 · pattern ^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.svg$
positionstringlength ≤ 200 · pattern ^hud/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.svg$
warp"default" | "ribbons" | "soft"
idstringlength 1–128 · pattern ^[a-z0-9][a-z0-9.-]*$
namestringlength 1–128

Mirrored byte-for-byte from hyprune/schema at 34849da45183 (2026-10-15). SHA-256 7ffd094df592c85259c1de9f1cd93b2bbcf8cb7fc9486a3496b0bac4b54d09a5.