From e0de8ad5ecbd69cd80e902bf595540c60973ba64 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 12:30:31 -0700 Subject: [PATCH 1/7] Add `README-TOOLS.md` --- README-TOOLS.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README-TOOLS.md diff --git a/README-TOOLS.md b/README-TOOLS.md new file mode 100644 index 00000000..bda2b1b1 --- /dev/null +++ b/README-TOOLS.md @@ -0,0 +1,34 @@ +# Useful 3rd-party tools + +Check out the [Bevy Assets](https://bevyengine.org/assets/) page to see more options. + +## Libraries + +The following libraries will likely be useful for most games: + +| Name | Category | Description | +| -------------------------------------------------------------------------------------- | ------------- | ------------------------------------- | +| [`leafwing-input-manager`](https://github.com/Leafwing-Studios/leafwing-input-manager) | Input | Input -> Action mapping | +| [`bevy_mod_picking`](https://github.com/aevyrie/bevy_mod_picking) | Input | Advanced mouse interaction | +| [`bevy_editor_pls`](https://github.com/jakobhellermann/bevy_editor_pls) | Debugging | Live entity inspector | +| [`bevy_mod_debugdump`](https://github.com/jakobhellermann/bevy_mod_debugdump) | Debugging | Schedule inspector | +| [`bevy_rapier`](https://github.com/dimforge/bevy_rapier) | Physics | Physics engine | +| [`avian`](https://github.com/Jondolf/avian) | Physics | Physics engine (ECS-driven) | +| [`bevy_common_assets`](https://github.com/NiklasEi/bevy_common_assets) | Asset loading | Asset loaders for common file formats | +| [`bevy_asset_loader`](https://github.com/NiklasEi/bevy_asset_loader) | Asset loading | Asset management tools | +| [`iyes_progress`](https://github.com/IyesGames/iyes_progress) | Asset loading | Progress tracking | +| [`bevy_kira_audio`](https://github.com/NiklasEi/bevy_kira_audio) | Audio | Advanced audio | +| [`sickle_ui`](https://github.com/UmbraLuminosa/sickle_ui) | UI | UI widgets | +| [`bevy_hanabi`](https://github.com/djeedai/bevy_hanabi) | VFX | GPU particle system | + +## VS Code extensions + +If you're using [VS Code](https://code.visualstudio.com/), the following extensions are highly recommended: + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------|-------------------------| +| [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) | Rust support | +| [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) | TOML support | +| [vscode-ron](https://marketplace.visualstudio.com/items?itemName=a5huynh.vscode-ron) | RON support | +| [crates](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) | `Cargo.toml` support | +| [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) | `.editorconfig` support | From 7f1b9839a3a4711893155179823295e966d1d5a5 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 12:33:12 -0700 Subject: [PATCH 2/7] "see more" -> "browse more" --- README-TOOLS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index bda2b1b1..77ba4507 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -1,6 +1,6 @@ # Useful 3rd-party tools -Check out the [Bevy Assets](https://bevyengine.org/assets/) page to see more options. +Check out the [Bevy Assets](https://bevyengine.org/assets/) page to browse more options. ## Libraries From 52192d98d3fa8682e4b5fd6aa5c3fcde5f29dc5e Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 12:34:18 -0700 Subject: [PATCH 3/7] "to browse" -> "for" --- README-TOOLS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index 77ba4507..98a8f4be 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -1,6 +1,6 @@ # Useful 3rd-party tools -Check out the [Bevy Assets](https://bevyengine.org/assets/) page to browse more options. +Check out the [Bevy Assets](https://bevyengine.org/assets/) page for more options. ## Libraries From 566cd30ab8d8ba88f9565337d0fca674a9f39335 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 13:02:04 -0700 Subject: [PATCH 4/7] Make wording more clear on subjectivity --- README-TOOLS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index 98a8f4be..3bee5fe3 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -1,10 +1,10 @@ # Useful 3rd-party tools -Check out the [Bevy Assets](https://bevyengine.org/assets/) page for more options. +Check out the [Bevy Assets](https://bevyengine.org/assets/) page for more great options. ## Libraries -The following libraries will likely be useful for most games: +A few libraries that the authors of this template have vetted and think you might find useful: | Name | Category | Description | | -------------------------------------------------------------------------------------- | ------------- | ------------------------------------- | From bb6e03d0241f86deda630f75c1439650b82b497e Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 13:43:34 -0700 Subject: [PATCH 5/7] Add `bevy_egui` and elaborate more on some libraries --- README-TOOLS.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index 3bee5fe3..2dca80a7 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -6,20 +6,28 @@ Check out the [Bevy Assets](https://bevyengine.org/assets/) page for more great A few libraries that the authors of this template have vetted and think you might find useful: -| Name | Category | Description | -| -------------------------------------------------------------------------------------- | ------------- | ------------------------------------- | -| [`leafwing-input-manager`](https://github.com/Leafwing-Studios/leafwing-input-manager) | Input | Input -> Action mapping | -| [`bevy_mod_picking`](https://github.com/aevyrie/bevy_mod_picking) | Input | Advanced mouse interaction | -| [`bevy_editor_pls`](https://github.com/jakobhellermann/bevy_editor_pls) | Debugging | Live entity inspector | -| [`bevy_mod_debugdump`](https://github.com/jakobhellermann/bevy_mod_debugdump) | Debugging | Schedule inspector | -| [`bevy_rapier`](https://github.com/dimforge/bevy_rapier) | Physics | Physics engine | -| [`avian`](https://github.com/Jondolf/avian) | Physics | Physics engine (ECS-driven) | -| [`bevy_common_assets`](https://github.com/NiklasEi/bevy_common_assets) | Asset loading | Asset loaders for common file formats | -| [`bevy_asset_loader`](https://github.com/NiklasEi/bevy_asset_loader) | Asset loading | Asset management tools | -| [`iyes_progress`](https://github.com/IyesGames/iyes_progress) | Asset loading | Progress tracking | -| [`bevy_kira_audio`](https://github.com/NiklasEi/bevy_kira_audio) | Audio | Advanced audio | -| [`sickle_ui`](https://github.com/UmbraLuminosa/sickle_ui) | UI | UI widgets | -| [`bevy_hanabi`](https://github.com/djeedai/bevy_hanabi) | VFX | GPU particle system | +| Name | Category | Description | +| -------------------------------------------------------------------------------------- | -------------- | ------------------------------------- | +| [`leafwing-input-manager`](https://github.com/Leafwing-Studios/leafwing-input-manager) | Input | Input -> Action mapping | +| [`bevy_mod_picking`](https://github.com/aevyrie/bevy_mod_picking) | Input | Advanced mouse interaction | +| [`bevy-inspector-egui`](https://github.com/jakobhellermann/bevy-inspector-egui) | Debugging | Live entity inspector | +| [`bevy_mod_debugdump`](https://github.com/jakobhellermann/bevy_mod_debugdump) | Debugging | Schedule inspector | +| [`bevy_rapier`](https://github.com/dimforge/bevy_rapier) | Physics | Physics engine | +| [`avian`](https://github.com/Jondolf/avian) | Physics | Physics engine (ECS-driven) | +| [`bevy_common_assets`](https://github.com/NiklasEi/bevy_common_assets) | Asset loading | Asset loaders for common file formats | +| [`bevy_asset_loader`](https://github.com/NiklasEi/bevy_asset_loader) | Asset loading | Asset management tools | +| [`iyes_progress`](https://github.com/IyesGames/iyes_progress) | Asset loading | Progress tracking | +| [`bevy_kira_audio`](https://github.com/NiklasEi/bevy_kira_audio) | Audio | Advanced audio | +| [`sickle_ui`](https://github.com/UmbraLuminosa/sickle_ui) | UI | UI widgets | +| [`bevy_egui`](https://github.com/mvlabat/bevy_egui) | UI / Debugging | UI framework (great for debug UI) | +| [`bevy_hanabi`](https://github.com/djeedai/bevy_hanabi) | VFX | GPU particle system | + +In particular: + +- `leafwing-input-manager` and `bevy_mod_picking` are very likely to be upstreamed into Bevy in the near future. +- `bevy-inspector-egui` and `bevy_mod_debugdump` help fill the gap until Bevy has its own editor. +- `bevy_rapier` or `avian` helps fill the gap until Bevy has its own physics engine. +- `sickle_ui` is well-aligned with `bevy_ui` and helps fill the gap until Bevy has a full collection of UI widgets. ## VS Code extensions From 9b304ac4333e83cd8bbae327367b8247386295b7 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Mon, 15 Jul 2024 14:06:18 -0700 Subject: [PATCH 6/7] Remove `bevy_hanabi` from list --- README-TOOLS.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index 2dca80a7..031fe3bb 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -20,7 +20,6 @@ A few libraries that the authors of this template have vetted and think you migh | [`bevy_kira_audio`](https://github.com/NiklasEi/bevy_kira_audio) | Audio | Advanced audio | | [`sickle_ui`](https://github.com/UmbraLuminosa/sickle_ui) | UI | UI widgets | | [`bevy_egui`](https://github.com/mvlabat/bevy_egui) | UI / Debugging | UI framework (great for debug UI) | -| [`bevy_hanabi`](https://github.com/djeedai/bevy_hanabi) | VFX | GPU particle system | In particular: From 5b8f74b28b7d65402033f8a9585c28a2a348d91b Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Tue, 16 Jul 2024 16:49:28 -0700 Subject: [PATCH 7/7] Update header --- README-TOOLS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README-TOOLS.md b/README-TOOLS.md index 031fe3bb..371bd36b 100644 --- a/README-TOOLS.md +++ b/README-TOOLS.md @@ -1,4 +1,4 @@ -# Useful 3rd-party tools +# Bevy Quickstart recommended 3rd-party tools Check out the [Bevy Assets](https://bevyengine.org/assets/) page for more great options.