From 5bf21ceaf9b04926f2c22e87b2b6fa743eeffa1e Mon Sep 17 00:00:00 2001 From: Nick Fisher Date: Tue, 17 Oct 2023 00:54:19 +1100 Subject: [PATCH 1/2] update README --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e77323a6..29ce37be 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,10 @@ Cross-platform, 3D PBR rendering and animation for [Flutter](https://github.com/ Wraps the [the Filament rendering library](https://github.com/google/filament). -Powers the Polyvox and odd-io engines. +Powers the [Polyvox](https://polyvox.app) and [odd-io](https://github.com/odd-io/) engines. This is still in beta: bugs/missing features are to be expected. - https://github.com/nmfisher/polyvox_filament/assets/7238578/abaed1c8-c97b-4999-97b2-39e85e0fa7dd @@ -21,7 +20,7 @@ https://github.com/nmfisher/polyvox_filament/assets/7238578/abaed1c8-c97b-4999-9 |Animation|✅ Embedded glTF skinning animations
✅ Embedded glTF morph animations
✅ Runtime/dynamic morph animations
⚠️ Runtime/dynamic skinning animations
|Entity manipulation|✅ Viewport selection
⚠️ Entity/transform parenting (planned)
⚠️ Transform manipulation (mouse/gesture to rotate/translate/scale object) (partial)
⚠️ Runtime material changes (planned)| -Special thanks to odd-io for sponsoring work on supporting Windows, raycasting, testing and documentation. +Special thanks to [odd-io](https://github.com/odd-io/) for sponsoring work on supporting Windows, raycasting, testing and documentation. PRs are welcome but please create a placeholder PR to discuss before writing any code. This will help with feature planning, avoid clashes with existing work and keep the project structure consistent. From 771888578189dacdcd2f7450e869635b29806df9 Mon Sep 17 00:00:00 2001 From: Nick Fisher Date: Tue, 17 Oct 2023 00:55:51 +1100 Subject: [PATCH 2/2] update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29ce37be..95d73f64 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,13 @@ PRs are welcome but please create a placeholder PR to discuss before writing any ## Getting Started -This package is currently only tested on Flutter >= `3.16.0-0.2.pre`, so you will need to first switch to the `beta` channel: +This package requires Flutter >= `3.16.0-0.2.pre`, so you will need to first switch to the `beta` channel: ``` flutter channel beta flutter upgrade ``` -Earlier versions have specific issues that will prevent them from working on Windows/MacOS! +There are specific issues with earlier versions on Windows/MacOS (mobile should actually be fine, so if you want to experiment on your own you're free to remove the minimum version from `pubspec.yaml`). Next, clone this repository and pull the latest binaries from Git LFS: