Updated the 2D examples to make them uniform #17237

chamaloriz · 2025-01-08T16:44:46Z

Objective

Make the examples look more uniform and more polished.
following the issue #17167

Solution

Added a minimal UI explaining how to interact with the examples only when needed.
Used the same notation for interactions ex : "Up Arrow: Move Forward \nLeft / Right Arrow: Turn"
Set the color to GRAY when it's not visible enough
Changed some colors to be easy on the eyes
removed the //camera comment
Unified the use of capital letters in the examples.
Simplified the mesh2d_arc offset calculations.

...

…ons at the top of the window, choosing better colors, and centering the props.

github-actions · 2025-01-08T16:44:58Z

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

rparrett

I like most of the tweaks, but feel like most of the added Text is not useful.

(Feel free to wait for some consensus on that point before making any related changes)

examples/2d/cpu_draw.rs

examples/2d/bounding_2d.rs

examples/2d/mesh2d_vertex_color_texture.rs

examples/2d/move_sprite.rs

rparrett · 2025-01-08T17:40:13Z

examples/2d/pixel_grid_snap.rs

@@ -118,6 +132,7 @@ fn setup_camera(mut commands: Commands, mut images: ResMut<Assets<Image>>) {
            // render before the "main pass" camera
            order: -1,
            target: RenderTarget::Image(image_handle.clone().into()),
+            clear_color: ClearColorConfig::Custom(GRAY.into()),


We should try to keep the default clear color unless it's totally necessary to change it.

We may want to discuss a "standard light clear color" for situations like this. The default clear color was chosen for branding reasons and isn't quite just "dark gray."

We should keep the standard clear color when possible. A standard light clear color is a good idea: we should consider adding a bevy::color::palettes::bevy_branding for this in another PR.

To be clear, I think GRAY is fine for now while we discuss.

I applied the same method used in 'mesh2d_arcs' and set GRAY as the default color in both this example and there. I only changed it because it wasn't legible enough. :)

We should keep the standard clear color when possible. A standard light clear color is a good idea: we should consider adding a bevy::color::palettes::bevy_branding for this in another PR.

I'll try to work on that when I finish this pull request :)

We should keep the standard clear color when possible. A standard light clear color is a good idea: we should consider adding a bevy::color::palettes::bevy_branding for this in another PR.

I found this pull request talking about a bevy palette

examples/2d/sprite_animation.rs

examples/2d/transparency_2d.rs

examples/2d/rotation.rs

examples/2d/sprite.rs

rparrett · 2025-01-08T17:58:13Z

I would suggset keeping this PR scoped to the 2d examples and opening another later.

mockersf · 2025-01-08T18:33:42Z

I like most of the tweaks, but feel like most of the added Text is not useful.

I agree on that. Text is useful for instructions, not for explanations

chamaloriz · 2025-01-09T10:52:28Z

I like most of the tweaks, but feel like most of the added Text is not useful.

I agree on that. Text is useful for instructions, not for explanations

I gave my bevy beginner opinion here, would love to know what you think :)

…lanation & made better instruction texts

examples/2d/sprite_flipping.rs

examples/2d/2d_viewport_to_world.rs

examples/2d/mesh2d_arcs.rs

examples/2d/rotation.rs

examples/2d/sprite_animation.rs

Co-authored-by: Rob Parrett <[email protected]>

alice-i-cecile · 2025-01-22T19:22:53Z

Almost there :) Let me know when you've fixed @rparrett's last round of review and I think this will be good to merge.

chamaloriz · 2025-01-23T11:10:41Z

Almost there :) Let me know when you've fixed @rparrett's last round of review and I think this will be good to merge.

I don't mind taking the time, since my plan is to apply these changes to the other examples :)

examples/2d/mesh2d_arcs.rs

…on out of the loop

alice-i-cecile · 2025-01-23T16:47:21Z

Thanks for your patience here, and thanks @rparrett for the thorough review :)

Updated the 2D examples to match each other by adding small explanati…

d88ee7a

…ons at the top of the window, choosing better colors, and centering the props.

chamaloriz changed the title ~~Updated the 2D examples to match each other by adding small explanati…~~ Updated the examples to match each other by adding small explanati… Jan 8, 2025

chamaloriz changed the title ~~Updated the examples to match each other by adding small explanati…~~ Updated the examples to make them uniform Jan 8, 2025

rparrett suggested changes Jan 8, 2025

View reviewed changes

rparrett reviewed Jan 8, 2025

View reviewed changes

examples/2d/rotation.rs Outdated Show resolved Hide resolved

rparrett reviewed Jan 8, 2025

View reviewed changes

examples/2d/sprite.rs Outdated Show resolved Hide resolved

ran linter command 'cargo fmt --all'

8693d32

chamaloriz changed the title ~~Updated the examples to make them uniform~~ Updated the 2D examples to make them uniform Jan 9, 2025

chamaloriz added 3 commits January 21, 2025 17:02

reverted changes made to examples where the text info was only an exp…

1078351

…lanation & made better instruction texts

fixed centering issue

93acb7e

Merge branch 'main' into uniformize-and-clarify-examples

8fd3d08

chamaloriz marked this pull request as ready for review January 21, 2025 16:27

chamaloriz requested a review from rparrett January 21, 2025 16:28

alice-i-cecile reviewed Jan 21, 2025

View reviewed changes

examples/2d/sprite_flipping.rs Outdated Show resolved Hide resolved

BenjaminBrienen added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 22, 2025

removed the //camera comment on every example

9143ac1

chamaloriz requested a review from alice-i-cecile January 22, 2025 11:09

BenjaminBrienen approved these changes Jan 22, 2025

View reviewed changes

rparrett reviewed Jan 22, 2025

View reviewed changes

Circle following cursor

35700f8

Co-authored-by: Rob Parrett <[email protected]>

BenjaminBrienen added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 23, 2025

chamaloriz added 4 commits January 23, 2025 11:44

centered the mesh2D_arcs example vertically

529e377

removed a space in the explanation for the rotation2d example

f2970c4

removed a space in the explanation for the sprite_animation example

2fc987a

Unified the use of capital letters in the examples.

79287e5

chamaloriz requested a review from rparrett January 23, 2025 11:14

rparrett reviewed Jan 23, 2025

View reviewed changes

examples/2d/mesh2d_arcs.rs Outdated Show resolved Hide resolved

made the mesh2d_arcs example centering more readable

b537b52

BenjaminBrienen added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 23, 2025

chamaloriz requested a review from rparrett January 23, 2025 15:53

chamaloriz added 2 commits January 23, 2025 17:19

Truly centered the mesh2d_arcs example and moved the offset calculati…

0881387

…on out of the loop

removed useless parentheses

007b88e

rparrett approved these changes Jan 23, 2025

View reviewed changes

rparrett added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 23, 2025

alice-i-cecile added this pull request to the merge queue Jan 23, 2025

Merged via the queue into bevyengine:main with commit 94e0e1f Jan 23, 2025
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated the 2D examples to make them uniform #17237

Updated the 2D examples to make them uniform #17237

chamaloriz commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025

rparrett left a comment

rparrett Jan 8, 2025

alice-i-cecile Jan 8, 2025

rparrett Jan 8, 2025

chamaloriz Jan 9, 2025

chamaloriz Jan 9, 2025

chamaloriz Jan 23, 2025 •

edited

Loading

rparrett commented Jan 8, 2025 •

edited

Loading

mockersf commented Jan 8, 2025

chamaloriz commented Jan 9, 2025 •

edited

Loading

alice-i-cecile commented Jan 22, 2025

chamaloriz commented Jan 23, 2025

alice-i-cecile commented Jan 23, 2025

Updated the 2D examples to make them uniform #17237

Updated the 2D examples to make them uniform #17237

Conversation

chamaloriz commented Jan 8, 2025 • edited Loading

Objective

Solution

github-actions bot commented Jan 8, 2025

rparrett left a comment

Choose a reason for hiding this comment

rparrett Jan 8, 2025

Choose a reason for hiding this comment

alice-i-cecile Jan 8, 2025

Choose a reason for hiding this comment

rparrett Jan 8, 2025

Choose a reason for hiding this comment

chamaloriz Jan 9, 2025

Choose a reason for hiding this comment

chamaloriz Jan 9, 2025

Choose a reason for hiding this comment

chamaloriz Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

rparrett commented Jan 8, 2025 • edited Loading

mockersf commented Jan 8, 2025

chamaloriz commented Jan 9, 2025 • edited Loading

alice-i-cecile commented Jan 22, 2025

chamaloriz commented Jan 23, 2025

alice-i-cecile commented Jan 23, 2025

chamaloriz commented Jan 8, 2025 •

edited

Loading

chamaloriz Jan 23, 2025 •

edited

Loading

rparrett commented Jan 8, 2025 •

edited

Loading

chamaloriz commented Jan 9, 2025 •

edited

Loading