From cf65750bdcce685ec52ec7b0429e7a7298c0eead Mon Sep 17 00:00:00 2001 From: Warchamp7 Date: Fri, 31 Jul 2026 17:58:22 -0400 Subject: [PATCH] frontend: Add info notices to theme files --- frontend/data/themes/System.obt | 19 ++++++++++--------- frontend/data/themes/Yami.obt | 23 +++++++++++++++++++++++ frontend/data/themes/Yami_Acri.ovt | 18 ++++++++++++++++++ frontend/data/themes/Yami_Classic.ovt | 18 ++++++++++++++++++ frontend/data/themes/Yami_Default.ovt | 17 +++++++++++++++++ frontend/data/themes/Yami_Grey.ovt | 18 ++++++++++++++++++ frontend/data/themes/Yami_Light.ovt | 18 ++++++++++++++++++ frontend/data/themes/Yami_Rachni.ovt | 18 ++++++++++++++++++ 8 files changed, 140 insertions(+), 9 deletions(-) diff --git a/frontend/data/themes/System.obt b/frontend/data/themes/System.obt index f989350f6eddde..a4478aa47441fb 100644 --- a/frontend/data/themes/System.obt +++ b/frontend/data/themes/System.obt @@ -1,12 +1,13 @@ -/* Intentionally left blank */ -/* Themes are created using Qt CSS, you can visit */ -/* http://doc.qt.io/qt-5/stylesheet-reference.html and */ -/* http://doc.qt.io/qt-5/stylesheet-examples.html for examples. */ - -/* OBS will use the theme filename for the settings. */ -/* You can ship images using relative paths in qss. */ -/* Dark Theme is a good place to start if you need */ -/* a template. */ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a special theme that is not normally selectable by the user. It + * exists only for certain accessibility scenarios but is otherwise unused. + * * + * ------------------------------------------------------------------------- */ @OBSThemeMeta { name: 'System'; diff --git a/frontend/data/themes/Yami.obt b/frontend/data/themes/Yami.obt index e1f26ef14606ad..4e3b34469d3fa2 100644 --- a/frontend/data/themes/Yami.obt +++ b/frontend/data/themes/Yami.obt @@ -1,3 +1,26 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * Yami contains many core definitions for the appearance of widgets + * throughout the app. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * Creating your own Base Theme means you are opting out of the default + * appearance for all widgets and will be responsible for keeping your base + * theme up to date with every new release! + * + * Do NOT copy Yami into a new base theme only to make minor changes or + * adjustments. Your theme will likely break with every OBS Studio update. + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Yami'; id: 'com.obsproject.Yami'; diff --git a/frontend/data/themes/Yami_Acri.ovt b/frontend/data/themes/Yami_Acri.ovt index ce189d7bd4ac5f..fc2f1e3d2cad99 100644 --- a/frontend/data/themes/Yami_Acri.ovt +++ b/frontend/data/themes/Yami_Acri.ovt @@ -1,3 +1,21 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a Variant Theme (Style) for Yami named Acri. Variant themes + * override variable values and append additional style rules to the end of + * the final composed stylesheet. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Acri'; id: 'com.obsproject.Yami.Acri'; diff --git a/frontend/data/themes/Yami_Classic.ovt b/frontend/data/themes/Yami_Classic.ovt index 58e4bc4b9cee82..5054b8c10f6521 100644 --- a/frontend/data/themes/Yami_Classic.ovt +++ b/frontend/data/themes/Yami_Classic.ovt @@ -1,3 +1,21 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a Variant Theme (Style) for Yami named Classic. Variant themes + * override variable values and append additional style rules to the end of + * the final composed stylesheet. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Classic'; id: 'com.obsproject.Yami.Classic'; diff --git a/frontend/data/themes/Yami_Default.ovt b/frontend/data/themes/Yami_Default.ovt index c248cec93acf61..9d8c60aa7e78eb 100644 --- a/frontend/data/themes/Yami_Default.ovt +++ b/frontend/data/themes/Yami_Default.ovt @@ -1,3 +1,20 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a stub Variant Theme for Yami named Default to populate the style + * dropdown. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Default'; id: 'com.obsproject.Yami.Original'; diff --git a/frontend/data/themes/Yami_Grey.ovt b/frontend/data/themes/Yami_Grey.ovt index 645b51b90619e1..47a0b6f2e06d4e 100644 --- a/frontend/data/themes/Yami_Grey.ovt +++ b/frontend/data/themes/Yami_Grey.ovt @@ -1,3 +1,21 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a Variant Theme (Style) for Yami named Grey. Variant themes + * override variable values and append additional style rules to the end of + * the final composed stylesheet. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Grey'; id: 'com.obsproject.Yami.Grey'; diff --git a/frontend/data/themes/Yami_Light.ovt b/frontend/data/themes/Yami_Light.ovt index 82ff22fccd16dc..368e30809b34ca 100644 --- a/frontend/data/themes/Yami_Light.ovt +++ b/frontend/data/themes/Yami_Light.ovt @@ -1,3 +1,21 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a Variant Theme (Style) for Yami named Light. Variant themes + * override variable values and append additional style rules to the end of + * the final composed stylesheet. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Light'; id: 'com.obsproject.Yami.Light'; diff --git a/frontend/data/themes/Yami_Rachni.ovt b/frontend/data/themes/Yami_Rachni.ovt index d271517b4ed46f..b05cf67c3276de 100644 --- a/frontend/data/themes/Yami_Rachni.ovt +++ b/frontend/data/themes/Yami_Rachni.ovt @@ -1,3 +1,21 @@ +/* ------------------------------------------------------------------------- * + * * + * IMPORTANT * + * * + * ------------------------------------------------------------------------- * + * * + * This is a Variant Theme (Style) for Yami named Rachni. Variant themes + * override variable values and append additional style rules to the end of + * the final composed stylesheet. + * + * If you are developing a custom theme it is HIGHLY RECOMMENDED that you + * use Yami as a Base and apply your changes in a Variant Theme (.ovt). + * + * You can learn more about OBS Studio's theme system on our GitHub wiki: + * https://github.com/obsproject/obs-studio/wiki/OBS-Studio-Theme-System + * * + * ------------------------------------------------------------------------- */ + @OBSThemeMeta { name: 'Rachni'; id: 'com.obsproject.Yami.Rachni';