Skip to content

Commit 4ca12d7

Browse files
committed
Update Readme with fork and migration info.
1 parent 782b233 commit 4ca12d7

File tree

1 file changed

+68
-39
lines changed

1 file changed

+68
-39
lines changed

README.md

Lines changed: 68 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,74 @@
1-
# flutter_unity_widget
2-
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
1+
# flutter_unity_widget_2
2+
This plugin is a fork of [flutter_unity_widget](https://pub.dev/packages/flutter_unity_widget), which is outdated on pub.dev.
33

4-
[![version][version-badge]][package]
5-
[![MIT License][license-badge]][license]
6-
[![PRs Welcome][prs-badge]](https://makeapullrequest.com)
4+
The aim of this fork is to publish bug fixes and improve compatibility with newer Flutter and Unity versions.
5+
These changes come from the master branch of the original [Github repo](https://github.com/juicycleff/flutter-unity-view-widget), which is far ahead of it's latest pub.dev release.
76

8-
[![Watch on GitHub][github-watch-badge]][github-watch]
9-
[![Star on GitHub][github-star-badge]][github-star]
107

11-
[![Gitter](https://badges.gitter.im/flutter-unity/community.svg)](https://gitter.im/flutter-unity/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
8+
Don't expect major new features or rewrites for now, as this plugin will try to stick close to the original.
9+
If you are looking for a full rewrite of the Unity integration, try [flutter_embed_unity](https://pub.dev/packages/flutter_embed_unity) instead.
10+
11+
12+
* Plugin versions `2022.x.y` should support Unity 2019.4 up to Unity 2022.3.
13+
The main focus is on Unity 2022.3 LTS.
14+
* Plugin versions `6000.x.y` support Unity 6 and up.
15+
16+
17+
This plugin works with the same [unitypackages](https://github.com/juicycleff/flutter-unity-view-widget/tree/master/unitypackages) as the original plugin.
18+
19+
<br />
20+
21+
22+
23+
For now, most of the original readme is included below for documentation.
24+
I might expand on this later.
25+
26+
27+
## Migration from flutter_unity_widget
28+
I've tried to keep most internal classes identical, to keep migrating to the fork simple.
29+
30+
You just need to rename the plugin by adding `_2` in several files in your project:
31+
32+
1. `pubspec.yaml`
33+
```diff
34+
dependencies:
35+
- flutter_unity_widget: ^2022.2.1
36+
+ flutter_unity_widget_2: ^2022.2.2
37+
```
38+
39+
2. Dart files in your Flutter project.
40+
```diff
41+
- import 'package:flutter_unity_widget/flutter_unity_widget.dart';
42+
+ import 'package:flutter_unity_widget_2/flutter_unity_widget_2.dart';
43+
```
44+
45+
3. Your `android/app/build.gradle`file.
46+
```diff
47+
// android/app/build.gradle
48+
- implementation project(':flutter_unity_widget')
49+
+ implementation project(':flutter_unity_widget_2')
50+
51+
// android/app/build.gradle.kts (Flutter 3.29+)
52+
- implementation(project(":flutter_unity_widget"))
53+
+ implementation(project(":flutter_unity_widget_2"))
54+
```
55+
56+
4. Your `ios/Runner/AppDelegate.swift`.
57+
```diff
58+
- import flutter_unity_widget
59+
+ import flutter_unity_widget_2
60+
```
61+
62+
<br />
63+
<br />
64+
<br />
65+
<br />
66+
<br />
67+
68+
69+
70+
# Original Readme
71+
1272
[![Discord](https://img.shields.io/badge/Discord-blue?style=for-the-badge)](https://discord.gg/KmMqD7Sv3K)
1373

1474
Flutter unity 3D widget for embedding unity in flutter. Now you can make awesome gamified features of your app in Unity and get it rendered in a Flutter app both in fullscreen and embeddable mode. Works great on `Android, iPad OS, iOS, Web`.
@@ -19,14 +79,10 @@ Flutter unity 3D widget for embedding unity in flutter. Now you can make awesome
1979
- Use Windows or Mac to export and build your project.
2080
Users on Ubuntu have reported a lot of errors in the Unity export.
2181
- Emulator support is limited and requires special setup. Please use a physical device for Android and iOS.
22-
- Supports Unity 2019.4.3 up to 2022.3.x, we recommend the latest 2022.3 LTS.
23-
Check [this github issue](https://github.com/juicycleff/flutter-unity-view-widget/issues/967) for support of Unity 6.
2482
- Use only OpenGLES3 as Graphics API on Android for AR compatibility.
2583
- Windows isn't supported because of the lack of [Flutter PlatformView support](https://github.com/flutter/flutter/issues/31713).
2684

2785
## Notice
28-
Need me to respond, tag me [Rex Isaac Raphael](https://github.com/juicycleff).
29-
3086
This plugin expects you to atleast know how to use Unity Engine. If you have issues with how unity widget is presented, you can please modify your unity project build settings as you seem fit.
3187

3288
Moving forward, versioning of the package will change to match unity releases after proper test. Mind you this does not mean the package
@@ -180,7 +236,6 @@ Check the **Minimum API Level** setting in the Unity player settings, and match
180236
The Unity widget will function without this step, but some Unity plugins like ArFoundation will throw `mUnityPlayer` errors on newer Unity versions.
181237

182238
This is needed for Unity 2020.3.46+, 2021.3.19 - 2021.3.20 and 2022.2.4 - 2022.3.18.
183-
This requires a flutter_unity_widget version that is newer than 2022.2.1.
184239

185240

186241
- 3.1. Open the `android/app/build.gradle` file and add the following:
@@ -1021,32 +1076,6 @@ Stack(
10211076
We already integrated this into our [Examples](/example/lib/screens/) in the `/example` folder.
10221077

10231078

1024-
#### Sponsors
1025-
1026-
Support this project with your organization. Your donations will be used to help children first and then those in need. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/ultimate-backend/contribute)]
1027-
1028-
<a href="https://opencollective.com/ultimate-backend/sponsor/0/website"><img src="https://opencollective.com/ultimate-backend/sponsor/0/avatar.svg"></a>
1029-
<a href="https://opencollective.com/ultimate-backend/sponsor/1/website"><img src="https://opencollective.com/ultimate-backend/sponsor/1/avatar.svg"></a>
1030-
<a href="https://opencollective.com/ultimate-backend/sponsor/2/website"><img src="https://opencollective.com/ultimate-backend/sponsor/2/avatar.svg"></a>
1031-
<a href="https://opencollective.com/ultimate-backend/sponsor/3/website"><img src="https://opencollective.com/ultimate-backend/sponsor/3/avatar.svg"></a>
1032-
<a href="https://opencollective.com/ultimate-backend/sponsor/4/website"><img src="https://opencollective.com/ultimate-backend/sponsor/4/avatar.svg"></a>
1033-
<a href="https://opencollective.com/ultimate-backend/sponsor/5/website"><img src="https://opencollective.com/ultimate-backend/sponsor/5/avatar.svg"></a>
1034-
<a href="https://opencollective.com/ultimate-backend/sponsor/6/website"><img src="https://opencollective.com/ultimate-backend/sponsor/6/avatar.svg"></a>
1035-
<a href="https://opencollective.com/ultimate-backend/sponsor/7/website"><img src="https://opencollective.com/ultimate-backend/sponsor/7/avatar.svg"></a>
1036-
<a href="https://opencollective.com/ultimate-backend/sponsor/8/website"><img src="https://opencollective.com/ultimate-backend/sponsor/8/avatar.svg"></a>
1037-
<a href="https://opencollective.com/ultimate-backend/sponsor/9/website"><img src="https://opencollective.com/ultimate-backend/sponsor/9/avatar.svg"></a>
1038-
1039-
[version-badge]: https://img.shields.io/pub/v/flutter_unity_widget.svg?style=flat-square
1040-
[package]: https://pub.dartlang.org/packages/flutter_unity_widget/
1041-
[license-badge]: https://img.shields.io/github/license/juicycleff/flutter-unity-view-widget.svg?style=flat-square
1042-
[license]: https://github.com/juicycleff/flutter-unity-view-widget/blob/master/LICENSE
1043-
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
1044-
[prs]: https://makeapullrequest.com
1045-
[github-watch-badge]: https://img.shields.io/github/watchers/juicycleff/flutter-unity-view-widget.svg?style=social
1046-
[github-watch]: https://github.com/juicycleff/flutter-unity-view-widget/watchers
1047-
[github-star-badge]: https://img.shields.io/github/stars/juicycleff/flutter-unity-view-widget.svg?style=social
1048-
[github-star]: https://github.com/juicycleff/flutter-unity-view-widget/stargazers
1049-
10501079
## Contributors ✨
10511080

10521081
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)