Add bevy_dev_tools crate #11341

matiqo15 · 2024-01-14T15:46:07Z

Objective

Resolves Create bevy_debug crate #11309

Solution

Add bevy_dev_tools crate as a default feature.
Add DevToolsPlugin and add it to an app if the bevy_dev_tools feature is enabled.

bevy_dev_tools is reserved by @alice-i-cecile, should we wait until it gets transferred to cart before merging?

alice-i-cecile · 2024-01-14T15:48:31Z

Added the A-Editor label: I'm going to group the dev-tools and editor PRs and issues together for triage until that proves to be a bad idea.

I'm going to wait on @cart's sign-off before merging this, but I think we're starting to get a clearer vision of what this crate might look like and can unblock editor-adjacent work now.

crates/bevy_dev_tools/src/lib.rs

alice-i-cecile

I think we can make the docs clearer, by focusing on a well-defined niche. That's non-blocking though, and I think this is the right step at this time.

crates/bevy_dev_tools/src/lib.rs

Cargo.toml

mockersf · 2024-01-14T21:41:32Z

should we wait until it gets transferred to cart before merging?

Not necessarily, but I think we should have something in those tools before merging. You could try moving https://github.com/bevyengine/bevy/blob/main/crates/bevy_app/src/ci_testing.rs

alice-i-cecile · 2024-01-14T21:44:33Z

I'm fine to move that into here as part of the initial PR. There's a number of other things I want to move and add, but this is a good uncontroversial first option.

matiqo15 · 2024-01-15T21:39:23Z

Probably, we also want an option to enable only some tools

1st solution

We remove bevy_dev_tools from default features and lock every tool under a new feature - this is a simple solution but could grow out of control over time.

2nd solution

We create a resource to store information about dev tools (see DiagnosticsStore). There are a few reasons why I think this is better:

Easier for users to add their own tools
We could mark it as an editor/non-editor tool
Show every enabled tool in the editor
Possibly in the future, add/remove tool at runtime

I believe this could be done in a follow-up PR, to make it easier for review.

alice-i-cecile · 2024-01-15T23:59:17Z

Yep, IMO we add a few tools first, then start thinking about how to abstract them. I'd prefer to have it runtime configured too.

cart · 2024-01-19T20:16:25Z

Just left some thoughts in this thread: https://github.com/bevyengine/bevy/pull/11341/files#r1459692523

crates/bevy_dev_tools/src/lib.rs

BD103 · 2024-03-05T12:26:09Z

#12305 is a feature that fits the best in bevy_dev_tools. What needs to be done for this PR to be merged, to unblock the simplified backtraces one?

BD103

A few changes requested, mainly with the bump to 0.14.0-dev.

crates/bevy_dev_tools/Cargo.toml

crates/bevy_dev_tools/src/lib.rs

crates/bevy_internal/Cargo.toml

crates/bevy_render/Cargo.toml

crates/bevy_time/Cargo.toml

alice-i-cecile · 2024-03-05T19:55:17Z

#12305 is a feature that fits the best in bevy_dev_tools. What needs to be done for this PR to be merged, to unblock the simplified backtraces one?

So, IMO:

Resolve merge conflicts.
Bump to 0.14.0-dev.
Add a tool or two.
Get the final sign-off from @cart.

If there's no movement on this PR in the next week or so I'll adopt it and get it through :)

pablo-lua · 2024-03-05T21:04:23Z

If we want more tools here, maybe we can move Aabb gizmos here, or merge some tools that are not merged yet, like #11237, and move here. I think gizmos has a lot of tools hanging out there that can be moved.

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

matiqo15 · 2024-03-06T18:20:17Z

I've rebased onto main

Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>

cart

I'm happy with where this landed and how it is communicated to users in the documentation. Still slightly worried about the "grab bag" nature of this. We should pay careful attention to what ends up in here and consider spinning specific features out into their own crates as they mature / expand.

# Objective - #11341 broke running code using `MinimalPlugins` in CI ## Solution - include `DevToolsPlugin` in `MinimalPlugins`

@alice-i-cecile

# Objective - Resolves bevyengine#11309 ## Solution - Add `bevy_dev_tools` crate as a default feature. - Add `DevToolsPlugin` and add it to an app if the `bevy_dev_tools` feature is enabled. `bevy_dev_tools` is reserved by @alice-i-cecile, should we wait until it gets transferred to cart before merging? --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>

# Objective - bevyengine#11341 broke running code using `MinimalPlugins` in CI ## Solution - include `DevToolsPlugin` in `MinimalPlugins`

# Objective Fixes typo by #11341. Functionally doesn't change anything other than naming consistency and stop IDE's from screaming at you.

matiqo15 added the C-Enhancement A new feature label Jan 14, 2024

alice-i-cecile requested a review from cart January 14, 2024 15:47

alice-i-cecile added X-Controversial There is active debate or serious implications around merging this PR A-Editor Graphical tools to make Bevy games labels Jan 14, 2024

alice-i-cecile reviewed Jan 14, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jan 14, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jan 14, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

alice-i-cecile approved these changes Jan 14, 2024

View reviewed changes

alice-i-cecile reviewed Jan 14, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

pablo-lua reviewed Jan 14, 2024

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

alice-i-cecile mentioned this pull request Jan 14, 2024

Move crate-level lint config to Cargo.toml lints table #11346

Closed

JMS55 mentioned this pull request Jan 15, 2024

Add a gizmo-based overlay to show UI node outlines (Adopted) #11237

Merged

matiqo15 force-pushed the bevy-dev-tools branch from afd5663 to ea86fe0 Compare January 16, 2024 20:47

pablo-lua mentioned this pull request Jan 17, 2024

Multiple Configurations for Gizmos #10342

Merged

alice-i-cecile reviewed Jan 20, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jan 20, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Show resolved Hide resolved

alice-i-cecile reviewed Jan 20, 2024

View reviewed changes

crates/bevy_dev_tools/src/lib.rs Outdated Show resolved Hide resolved

doonv approved these changes Jan 22, 2024

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 22, 2024

SpecificProtagonist mentioned this pull request Mar 4, 2024

Simplified backtraces #12305

Merged

BD103 suggested changes Mar 5, 2024

View reviewed changes

matiqo15 and others added 9 commits March 6, 2024 18:46

Add bevy_dev_tools crate

860856d

move ci_testing to bevy_dev_tools

dbb4b92

rephrase docs

294a078

add example how to turn off DevToolsPlugin

9d32bd9

remove bevy_dev_tools from default features

a02e2ac

rephrase doc

3333728

Update crates/bevy_dev_tools/src/lib.rs

1f9bdc7

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

add docs about another way to enable bevy_dev_tools

8932b96

fix ci

dd6d998

matiqo15 force-pushed the bevy-dev-tools branch from f1de6e6 to dd6d998 Compare March 6, 2024 18:19

matiqo15 and others added 3 commits March 6, 2024 19:21

Update crates/bevy_dev_tools/src/lib.rs

73757ec

Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>

Merge branch 'main' into bevy-dev-tools

7bd5c0b

run taplo

b4f2202

cart approved these changes Mar 6, 2024

View reviewed changes

cart added this pull request to the merge queue Mar 6, 2024

Merged via the queue into bevyengine:main with commit 6533170 Mar 6, 2024
29 checks passed

alice-i-cecile added the C-Needs-Release-Note Work that should be called out in the blog due to impact label Mar 6, 2024

pablo-lua mentioned this pull request Mar 6, 2024

Move the already existent tools into bevy_dev_tools and creation of new ones #12351

Open

9 tasks

chompaa mentioned this pull request Mar 6, 2024

Move aabb gizmos to bevy_dev_tools #12354

Open

pablo-lua mentioned this pull request Mar 7, 2024

CiTestingConfig is blocking bevy_dev_tools from using bevy_render #12356

Closed

mockersf mentioned this pull request Mar 7, 2024

Fix minimal plugins in ci #12370

Merged

github-merge-queue bot pushed a commit that referenced this pull request Mar 7, 2024

Fix minimal plugins in ci (#12370)

0baedcf

# Objective - #11341 broke running code using `MinimalPlugins` in CI ## Solution - include `DevToolsPlugin` in `MinimalPlugins`

spectria-limina pushed a commit to spectria-limina/bevy that referenced this pull request Mar 9, 2024

Fix minimal plugins in ci (bevyengine#12370)

ec88110

# Objective - bevyengine#11341 broke running code using `MinimalPlugins` in CI ## Solution - include `DevToolsPlugin` in `MinimalPlugins`

s-puig mentioned this pull request Mar 17, 2024

Fix typo in bevy_internal/Cargo.toml #12535

Merged

github-merge-queue bot pushed a commit that referenced this pull request Mar 17, 2024

Fix typo in bevy_internal/Cargo.toml (#12535)

1067eaa

# Objective Fixes typo by #11341. Functionally doesn't change anything other than naming consistency and stop IDE's from screaming at you.

alice-i-cecile removed the C-Needs-Release-Note Work that should be called out in the blog due to impact label May 27, 2024

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add bevy_dev_tools crate #11341

Add bevy_dev_tools crate #11341

matiqo15 commented Jan 14, 2024

alice-i-cecile commented Jan 14, 2024

alice-i-cecile left a comment

mockersf commented Jan 14, 2024

alice-i-cecile commented Jan 14, 2024

matiqo15 commented Jan 15, 2024 •

edited

Loading

alice-i-cecile commented Jan 15, 2024

cart commented Jan 19, 2024

BD103 commented Mar 5, 2024

BD103 left a comment

alice-i-cecile commented Mar 5, 2024

pablo-lua commented Mar 5, 2024 •

edited

Loading

matiqo15 commented Mar 6, 2024

cart left a comment

Add bevy_dev_tools crate #11341

Add bevy_dev_tools crate #11341

Conversation

matiqo15 commented Jan 14, 2024

Objective

Solution

alice-i-cecile commented Jan 14, 2024

alice-i-cecile left a comment

Choose a reason for hiding this comment

mockersf commented Jan 14, 2024

alice-i-cecile commented Jan 14, 2024

matiqo15 commented Jan 15, 2024 • edited Loading

1st solution

2nd solution

alice-i-cecile commented Jan 15, 2024

cart commented Jan 19, 2024

BD103 commented Mar 5, 2024

BD103 left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Mar 5, 2024

pablo-lua commented Mar 5, 2024 • edited Loading

matiqo15 commented Mar 6, 2024

cart left a comment

Choose a reason for hiding this comment

matiqo15 commented Jan 15, 2024 •

edited

Loading

pablo-lua commented Mar 5, 2024 •

edited

Loading