Skip to content

Commit

Permalink
docs: Update wording on README [flame_3d]
Browse files Browse the repository at this point in the history
  • Loading branch information
luanpotter committed Dec 14, 2024
1 parent 8352ad8 commit eb6f3a7
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions packages/flame_3d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ This package provides 3D support for Flame but it depends on the still experimen
[Flutter GPU](https://github.com/flutter/flutter/wiki/Flutter-GPU), which in turn depends on
Impeller.

Because of that, this package is also highly experimental. Our long term goal is to
eventually merge this branch into Flame's `main`, but we currently need to depend on Flutter's `main`
(Flame depends on `stable`). For more information on this, check out our
[Roadmap](https://github.com/flame-engine/flame/blob/main/packages/flame_3d/ROADMAP.md).
Therefore, this package is also experimental; you can check our
[Roadmap](https://github.com/flame-engine/flame/blob/main/packages/flame_3d/ROADMAP.md)
for more details on our plans and what is currently supported.

This package does not guarantee that it will follow correct [semver](https://semver.org/) versioning
rules, nor does it assure that its APIs wont break. Be ready to constantly have to refactor your
Expand All @@ -66,8 +65,8 @@ ecosystem.

## Prerequisites

In order to use flame_3d, you will need to ensure a few things. First of all, you need to be on
the `main` channel of Flutter, and on MacOS, the only currently supported platform.
In order to use flame_3d, you will need to ensure a few things. Sadly, you need to be on
MacOS - the only currently supported platform.

Then, you need to enable Impeller; to do that, add the following to the
`Info.plist` in your `macos/` directory:
Expand All @@ -80,6 +79,12 @@ Then, you need to enable Impeller; to do that, add the following to the
</dict>
```

You can also run Flutter with the flag:

```bash
flutter run --enable-impeller
```

Now everything is set up you can start doing some 3D magic! You can check out the
[example](https://github.com/flame-engine/flame/tree/main/packages/flame_3d/example) to see how you
can set up a simple 3D environment using Flame.
Expand Down

0 comments on commit eb6f3a7

Please sign in to comment.