# Mouse Picking for Bevy
[](https://crates.io/crates/bevy_mod_picking)
[](https://docs.rs/bevy_mod_picking)
[](https://github.com/aevyrie/bevy_mod_picking/actions?query=workflow%3A%22CI%22+branch%3Amaster)
[](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
A [Bevy](https://github.com/bevyengine/bevy) plugin for picking, making it easy to interact
with meshes in Bevy. Built with [`bevy_mod_raycast`](https://github.com/aevyrie/bevy_mod_raycast).
Features
- Mouse intersection coordinates in world space
- Mouseover and mouseclick events
- Configurable highlighting
- Selection state management
- 3D debug cursor
- Touch support
- Common keybindings (Ctrl+A, Ctrl+Click multi-select)
Quickstart
It only takes a few lines to get mouse picking working in your Bevy application using this plugin.
Add the plugin to your app:
rs
.add_plugins(DefaultPickingPlugins);
Mark your camera as the picking source with the PickingCameraBundle component:
rs
.insert_bundle(PickingCameraBundle::default());
Add the PickableBundle component to any meshes you want to make pickable:
rs
.insert_bundle(PickableBundle::default())
That's all there is to it! Read the docs and look at the provided examples to learn more.
Demo
To run a minimal demo, clone this repository and run:
console
cargo run --example minimal
Bevy Version Support
I intend to track the main branch of Bevy. PRs supporting this are welcome!
| bevy | bevymodpicking |
| ---- | ---------------- |
| 0.9 | 0.10 |
| 0.8 | 0.8, 0.9 |
| 0.7 | 0.6, 0.7 |
| 0.6 | 0.5 |
| 0.5 | 0.4 |
| 0.4 | 0.3 |
| 0.3 | 0.2 |
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in bevymodpicking by you, shall be licensed as MIT, without any additional terms or conditions.