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.

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

Switch from trunk to bevy run web #312

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

TimJentzsch
Copy link

Closes #297.

This PR prepares the project to use the Bevy CLI, mainly the bevy run command.
It simplifies especially running for the web target, which previously required use of trunk (and a bunch of additional configuration).

TODO

The CI builds won't work yet. We probably need TheBevyFlock/bevy_cli#68 to make them work.

TimJentzsch added a commit to TheBevyFlock/bevy_cli that referenced this pull request Oct 3, 2024
Add a `bevy run` command which conveniently runs your Bevy app.

It mostly wraps `cargo run`, but also provides a `web` sub command,
which makes it a lot easier to target the browser.

This option will compile your app for WASM, create JS bindings, add an
`index.html` file if you don't provide one yourself and serves the build
locally to open it in your browser.
The default `index.html` file is mostly what we had in
`bevy_quickstart`.

This is the last part of #24.
Closes #8.

# Testing

1. Checkout the `bevy-run` branch.
2. Run `cargo install --path .` to install this version of the Bevy CLI.
3. Navigate to your Bevy app.
4. Run `bevy run web`.

Note that your app must be compatible with WASM. If you have features or
profiles enabled by default which are not compatible with WASM, you need
to disable them. E.g. `bevy run --no-default-features web`.
If you have a custom `index.html` configured for `trunk`, it might also
not work out of the box. You can try removing the entire `web` folder to
try the default setup.

A good example project is of course `bevy_new_2d`, which you can test on
this branch: <TheBevyFlock/bevy_new_2d#312>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch from Trunk to bevy run web
1 participant