Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update wording on README to match newer instructions [flame_3d] #3399

Merged
merged 5 commits into from
Dec 14, 2024
Merged

docs: Update wording on README to match newer instructions [flame_3d] #3399

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eb6f3a7
docs: Update wording on README [flame_3d]
luanpotter Dec 14, 2024
1001655
Merge branch 'main' into luan.f3d-readme
luanpotter Dec 14, 2024
dad7ed6
Support other platforms
luanpotter Dec 14, 2024
030fd61
Improve wording
luanpotter Dec 14, 2024
58c2f71
Merge branch 'main' into luan.f3d-readme
wolfenrain Dec 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions packages/flame_3d/README.md
View file
Open in desktop
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.
luanpotter marked this conversation as resolved.
Show resolved Hide resolved

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
Loading