nuzzles / nuzzles/bevy_async_task

README needs clarification, Limitations / FAQ

Open
#14 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
92
Forks
11
PR merge metrics
No merged PRs in 30d

Description

While reading the README.md I still have basically two questions:

  1. Does this crate really allow for multithreading on WASM targets, despite Bevy does not support this at the moment?

  2. What are the limitations of this crate? Can you do anything you want? Can you access ECS inside the thread? Resources?

So, in general, I am asking to update the README in the following way:

  1. State more clearly what kind of parallelism this enables in WASM
  2. Specify/make it clear what this does in contrast with regular Bevy.
  3. Add some Limitations section or FAQ section to explain what is this crate good for and not so good for.

Otherwise anyone interested on anything remotely similar has to guess and try for themselves, spending hours to find out if their use case is supported or not.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md and verify the crate's WASM parallelism behavior, how it differs from regular Bevy, and whether ECS or resources are accessible from the thread. Done means the README includes clear explanations plus a Limitations or FAQ section covering supported and unsupported use cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, wasm
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.