@@ -8,6 +8,97 @@ This release includes a major refactoring to use **nested YAML configuration**.
88
99All section-specific configuration options now live under nested section keys (` player ` , ` favorites ` , ` groups ` , ` grouping ` , ` volumes ` , ` queue ` ).
1010
11+ ### Quick Migration Guide
12+
13+ If your card stopped working after upgrading to v10, follow these steps:
14+
15+ #### Step 1: Identify prefixed options
16+
17+ Look for any options in your config that start with these prefixes:
18+ - ` player... ` → move under ` player: `
19+ - ` mediaBrowser... ` → rename to remove prefix and move under ` favorites: `
20+ - ` favorites... ` → move under ` favorites: `
21+ - ` groups... ` → move under ` groups: `
22+ - ` grouping... ` → move under ` grouping: `
23+ - ` volumes... ` → move under ` volumes: `
24+ - ` queue... ` → move under ` queue: `
25+
26+ #### Step 2: Remove the prefix and nest under the section
27+
28+ For each prefixed option:
29+ 1 . Remove the section prefix (e.g., ` playerHideArtwork ` → ` hideArtwork ` )
30+ 2 . Move it under the appropriate section key
31+
32+ #### Step 3: Rename mediaBrowser to favorites
33+
34+ If you used ` mediaBrowser... ` options, rename them to use ` favorites ` instead.
35+
36+ #### Migration Examples
37+
38+ ** Volume controls not showing?**
39+ ``` yaml
40+ # Before (v9)
41+ playerHideVolume : false
42+ playerShowVolumeUpAndDownButtons : true
43+
44+ # After (v10)
45+ player :
46+ hideVolume : false
47+ showVolumeUpAndDownButtons : true
48+ ` ` `
49+
50+ **Favorites/Media Browser missing?**
51+ ` ` ` yaml
52+ # Before (v9)
53+ mediaBrowserItemsPerRow : 3
54+ mediaBrowserHideTitleForThumbnailIcons : true
55+ favoritesTopItems :
56+ - My Playlist
57+
58+ # After (v10)
59+ favorites :
60+ itemsPerRow : 3
61+ hideTitleForThumbnailIcons : true
62+ topItems :
63+ - My Playlist
64+ ` ` `
65+
66+ **Groups section broken?**
67+ ` ` ` yaml
68+ # Before (v9)
69+ groupsTitle : My Speakers
70+ groupsCompact : true
71+
72+ # After (v10)
73+ groups :
74+ title : My Speakers
75+ compact : true
76+ ` ` `
77+
78+ **Grouping section broken?**
79+ ` ` ` yaml
80+ # Before (v9)
81+ groupingButtonColor : " #ff0000"
82+ groupingCompact : true
83+
84+ # After (v10)
85+ grouping :
86+ buttonColor : " #ff0000"
87+ compact : true
88+ ` ` `
89+
90+ #### Options that stay at root level
91+
92+ These options do NOT need to be nested (they affect multiple sections):
93+ - ` entities`, `entityId`, `entityPlatform`
94+ - ` predefinedGroups`
95+ - ` sections` , `startSection`
96+ - ` title` , `baseFontSize`, `heightPercentage`, `widthPercentage`
97+ - ` volumeStepSize` , `dynamicVolumeSlider`, `changeVolumeOnSlide`
98+ - All `entityName...` and `mediaTitle...` regex options
99+
100+ See the full list in "Cross-Section Options" below.
101+
11102# ### Media Browser → Favorites (Section Rename)
12103
13104The "Media Browser" section has been renamed to "Favorites" throughout the codebase and configuration.
0 commit comments