You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 7, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+35-16Lines changed: 35 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,9 @@ UIWidgets is mainly derived from [Flutter](https://github.com/flutter/flutter).
11
11
the powerful Unity Engine, it offers developers many new features to improve their Apps
12
12
as well as the develop workflow significantly.
13
13
14
-
As the latest version, UIWidgets 2.0 aims to optimize the overall performance of the package. Specifically, a performance gain around 10% is observed on mobile devices like iPhone 6 after upgrading to UIWidgets 2.0. However, if you still want to use the original UIWidgets 1.0, please download the archived packages from Releases or switch your working branch to uiwidgets_1.0.
14
+
**UIWidgets 2.0** is developed for **Unity China version** deliberately and aims to **optimize the overall performance of the package**. Specifically, a performance gain around **10%** is observed on mobile devices like iPhone 6 after upgrading to UIWidgets 2.0.
15
+
16
+
If you still want to use the original UIWidgets 1.0, please download the archived packages from Releases or switch your working branch to uiwidgets_1.0.
15
17
16
18
#### Efficiency
17
19
Using the latest Unity rendering SDKs, a UIWidgets App can run very fast and keep >60fps in most times.
The Unity Connect App is created using UIWidgets and available for both Android (https://unity.cn/connectApp/download)
55
+
The Unity Connect App is created using **UIWidgets 2.0** and available for both Android (https://unity.cn/connectApp/download)
54
56
and iOS (Searching for "Unity Connect" in App Store). This project is open-sourced @https://github.com/UnityTech/ConnectAppCN.
55
57
56
58
#### Unity Chinese Doc
57
-
The official website of Unity Chinese Documentation (https://connect.unity.com/doc) is powered by UIWidgets and
59
+
The official website of Unity Chinese Documentation (https://connect.unity.com/doc) is powered by UIWidgets 1.0 and
58
60
open-sourced @https://github.com/UnityTech/DocCN.
59
61
60
62
## Requirements
61
63
62
64
#### Unity
63
65
64
-
The compatible Unity versions for each UIWidgets release are listed below. You can download the latest Unity on [https://unity.cn/releases](https://unity.cn/releases).
66
+
:warning:**UIWidgets 2.0 are only compatible with Unity China version**
67
+
68
+
Specifically, the compatible Unity versions for each UIWidgets release are listed below. You can download the latest Unity on [https://unity.cn/releases](https://unity.cn/releases).
In PackageManger of unity, select add local file. select ```package.json``` under ```/com.unity.uiwidgets```
89
+
Note that there are many native libraries we built for UIWidget 2.0 to boost its performance, which are large files and hosted by
90
+
**Git Large File Storage**. You need to install [this service](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) first and then use it to fetch these libraries.
91
+
92
+
Finally, in PackageManger of unity, select add local file. select ```package.json``` under ```/com.unity.uiwidgets```
86
93
87
94
#### Runtime Environment
88
95
89
-
Currently UIWidgets only supports MacOS(Metal), iOS(Metal), Android(Armv7, OpenGLes) and Windows(Direct3D11). More devices will be supported in the future.
96
+
:warning: Though UIWidgets 1.0 is compatible to all platforms, currently **UIWidgets 2.0**only supports MacOS(Metal), iOS(Metal), Android(OpenGLes) and Windows(Direct3D11). More devices will be supported in the future.
90
97
91
98
## Getting Start
92
99
@@ -267,16 +274,28 @@ Meanwhile, you can join our [discussion channel](https://unity.cn/plate/uiwidget
| Can I create standalone App using UIWidgets? |**Yes**|
273
-
| Can I use UIWidgets to build game UIs? |**Yes**|
274
-
| Can I develop Unity Editor plugins using UIWidgets? |**Yes**|
275
-
| Is UIWidgets a extension of UGUI/NGUI? |**No**|
276
-
| Is UIWidgets just a copy of Flutter? |**No**|
277
-
| Can I create UI with UIWidgets by simply drag&drop? |**No**|
278
-
| Do I have to pay for using UIWidgets? |**No**|
279
-
| Any IDE recommendation for UIWidgets? |**Rider, VSCode(Open .sln)**|
277
+
1. The editor crashes when openning a UIWidgets 2.0 project, e.g., the Sample projects.
278
+
279
+
Please make sure that you are using campatible Unity versions to the specific UIWidgets version. For example, **UIWidgets 2.0.3** is only supported on Unity China version between 2019.4.26f1c1 and 2019.4.29f1c1. You can find the detailed information in
280
+
this [section](#unity).
281
+
282
+
283
+
2. After openning a UIWidgets 2.0 project I receive an error **DllNotFoundException: libUIWidgets**.
284
+
285
+
Please make sure that the native libraries are correctly downloaded to your project. You can find them under *UIWidgetsPackageRoot*/Runtime/Plugins. For example, the libUIWidgets.dll under the sub folder *X86_64* is the native library for Windows and the libUIWidgets.dylib under *osx* is for Mac.
286
+
287
+
If the libraries are not there or their sizes are small (<1MB), please ensure that you have installed **Git Large File Storage** in your computer and then try the following command line inside the UIWidgets repository.
288
+
```
289
+
git lfs pull
290
+
```
291
+
292
+
3. What is the difference between UIWidgets 2.0 and UIWidgets 1.0 ?
293
+
294
+
In UIWidgets 1.0 we used Unity [Graphics API](https://docs.unity3d.com/ScriptReference/Graphics.html) for the rendering and all rendering codes are writen in C#. Therefore it is able to run freely on all platforms that Unity supports but relatively slow. The rendering result is also not exactly the same as in flutter due to the difference between the Unity rendering engine and flutter engine.
295
+
296
+
In UIWidgets 2.0, we wrapped the flutter engine inside a native library which is writen in C++ and used it to render on Unity Textures. Its rendering result is the same as in flutter and the performance is also better. However, in order to ensure that the flutter engine works properly along with Unity, we modified both the flutter and Unity Engine. As the result, currently UIWidgets 2.0 can only run on specific Unity versions, i.e., Unity China version and supports only part of the build targets of Unity.
297
+
298
+
For better rendering result, performance and continuous upgrade and support, you are always suggested to use UIWidgets 2.0 for your project. Use UIWidgets 1.0 only if you need to support specific target platforms like webgl.
0 commit comments