Update README.md

IvanMurzak · Aug 9, 2024 · eb0e2fb · eb0e2fb
1 parent b290230
commit eb0e2fb
Showing 1 changed file with 88 additions and 0 deletions.
diff --git a/Assets/_PackageRoot/Documentation~/README.md b/Assets/_PackageRoot/Documentation~/README.md
@@ -117,3 +117,91 @@ namespace Unity.Theme.Binders
 ## Other
 
 - **[Color palette builder](https://m3.material.io/theme-builder#/custom)** by Google's Material Design V3
+
+---
+
+## Migration from 2.x.x version
+
+> ❗❗❗**WARNING**
+> Before you start the migration, please close Unity project to avoid any data loss.
+> When you finished, you need to delete the `Assets/Resources/Unity-Theme Database.asset` file.
+
+The version 3.x.x has a different database structure, so you need to migrate your data manually if you want to keep existed binders to still be connected to a right color. The binders are using GUIDs to connect to colors.
+
+### To do
+
+**You need to copy GUIDs** from `Assets/Resources/Unity-Theme Database.asset`  to `Assets/Resources/Unity-Theme-Database.json`. To do that, please take a look at the samples below. You may see what is data format of old and new databases, and how to copy GUIDs.
+
+#### Sample of `Assets/Resources/Unity-Theme Database.asset` - old file (source)
+
+Take a look at the `guid: 6b934efb-0b9b-42fd-82fd-7a0dbd1de53c`, the file contains it 3 times, depends on your setup. You would need to copy the guid to the `Unity-Theme-Database.json` file.
+
+```
+  colors:
+  - guid: 6b934efb-0b9b-42fd-82fd-7a0dbd1de53c
+    name: Primary
+  - guid: 520b0288-c5e4-4106-95ae-095ad2dcceb8
+    name: Primary Text
+  - guid: 465741bc-25d8-4722-a981-7e4a18074d83
+    name: Primary Container
+  themes:
+  - guid: 6d1fce4e-1938-4d6d-93b0-b4b9f6497293
+    expanded: 1
+    themeName: Light
+    colors:
+    - guid: 6b934efb-0b9b-42fd-82fd-7a0dbd1de53c
+      color: {r: 0.40392157, g: 0.3137255, b: 0.6431373, a: 1}
+    - guid: 520b0288-c5e4-4106-95ae-095ad2dcceb8
+      color: {r: 1, g: 1, b: 1, a: 1}
+    - guid: 465741bc-25d8-4722-a981-7e4a18074d83
+      color: {r: 0.91764706, g: 0.8666667, b: 1, a: 1}
+  - guid: 54c71f36-6023-4d84-bce7-c8192cf7ba40
+    expanded: 1
+    themeName: Dark
+    colors:
+    - guid: 6b934efb-0b9b-42fd-82fd-7a0dbd1de53c
+      color: {r: 0, g: 0.4784314, b: 1, a: 1}
+    - guid: 520b0288-c5e4-4106-95ae-095ad2dcceb8
+      color: {r: 1, g: 1, b: 1, a: 1}
+    - guid: 465741bc-25d8-4722-a981-7e4a18074d83
+      color: {r: 0.15294118, g: 0.15294118, b: 0.15686275, a: 1}
+```
+
+### Sample of `Assets/Resources/Unity-Theme-Database.json` - new file (destination)
+
+That is the file that you need to make in the end of the migration process.
+When you done, you may need to close & open Unity project to let Unity-Theme to reload the data.
+
+```json
+{
+  "debugLevel": 2,
+  "currentThemeIndex": 1,
+  "colors": [
+    { "guid": "6b934efb-0b9b-42fd-82fd-7a0dbd1de53c", "name": "Primary" },
+    { "guid": "520b0288-c5e4-4106-95ae-095ad2dcceb8", "name": "Primary Text" },
+    { "guid": "465741bc-25d8-4722-a981-7e4a18074d83", "name": "Primary Container" }
+  ],
+  "themes": [
+    {
+      "guid": "4cfe4185-bc3e-4247-969f-1da1d3f2bdec",
+      "expanded": false,
+      "themeName": "Light",
+      "colors": [
+        { "guid": "6b934efb-0b9b-42fd-82fd-7a0dbd1de53c", "colorHex": "#6750A4FF" },
+        { "guid": "520b0288-c5e4-4106-95ae-095ad2dcceb8", "colorHex": "#FFFFFFFF" },
+        { "guid": "465741bc-25d8-4722-a981-7e4a18074d83", "colorHex": "#EADDFFFF" }
+      ]
+    },
+    {
+      "guid": "dca52c83-4f79-4fee-854e-0defe9ccbe07",
+      "expanded": true,
+      "themeName": "Dark",
+      "colors": [
+        { "guid": "6b934efb-0b9b-42fd-82fd-7a0dbd1de53c", "colorHex": "#007AFFFF" },
+        { "guid": "520b0288-c5e4-4106-95ae-095ad2dcceb8", "colorHex": "#FFFFFFFF" },
+        { "guid": "465741bc-25d8-4722-a981-7e4a18074d83", "colorHex": "#272728FF" }
+      ]
+    }
+  ]
+}
+```