Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergioribera/virtual_joystick
Bevy virtual Joystick for mobile games (Works with mouse on desktop)
https://github.com/sergioribera/virtual_joystick
bevy bevy-engine bevy-plugin bevy-ui hacktoberfest rust ui ui-components
Last synced: about 2 months ago
JSON representation
Bevy virtual Joystick for mobile games (Works with mouse on desktop)
- Host: GitHub
- URL: https://github.com/sergioribera/virtual_joystick
- Owner: SergioRibera
- License: apache-2.0
- Created: 2023-04-07T05:45:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-25T06:03:22.000Z (9 months ago)
- Last Synced: 2024-04-25T17:42:29.168Z (8 months ago)
- Topics: bevy, bevy-engine, bevy-plugin, bevy-ui, hacktoberfest, rust, ui, ui-components
- Language: Rust
- Homepage:
- Size: 286 KB
- Stars: 33
- Watchers: 3
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Bevy Virtual Joystick
Create and use a Virtual Joystick in a UI for [bevy](https://bevyengine.org/) Game Engine.
# Versions
Aviable and compatible versions
| bevy | VirtualJoystick |
|--------|-----------------|
| 0.14 | 2.3.0 |
| 0.13 | 2.2.0 |
| 0.12 | 2.1.0 |
| 0.11 | 2.0.1 |
| 0.10.1 | 1.1.2 |
# Features
- Support Mouse and Touch
- Easy usage
- Multiple Joysticks on screen
- Multiple types of joystick behaviour
- Track events on Joystick (Press, Drag and Up)
- Support Axis block (Horizontal, Vertical or Both)
> **NOTE:** To compile android projects you can use [cargo-apk](https://crates.io/crates/cargo-apk) or the [docker-rust-android](https://github.com/SergioRibera/docker-rust-android) project container where you don't have to install or prepare any sdk, for more details see the readme of the mobile projects
### Axis
| Both (Default) | Horizontal | Vertical |
|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
|  |  |  |
### Joystick Types
| Fixed | Floating (Default) | Dynamic (TODO: Fix movement feel) |
|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
|  |  |  |
# Examples
- [Mobile](./examples/simple_mobile)
- [Desktop](./examples/simple.rs)
- [Multiple Joysticks Mobile](./examples/multiple_joysticks_mobile)
- [Multiple Joysticks Desktop](./examples/multiple.rs)
# Features
- inspect: for world inspect with egui inspector
- [`serde`](https://serde.rs) (default): for serialization support for all types (usable for save and load settings)
```toml
virtual_joystick = {
version = "*",
default-features = false,
features = [ "inspect", "serde" ]
}
```
# Usage
Check out the [examples](./examples) for details.
```sh
# to run example
cargo run --example simple -F=inspect
```
Add to Cargo.toml
```toml
[dependencies]
bevy = "0.12"
virtual_joystick = "*" # Add your version
```
The minimal requirement:
```rust
use bevy::prelude::*;
// import crate
use virtual_joystick::*;
// ID for joysticks
#[derive(Default, Reflect, Hash, Clone, PartialEq, Eq)]
enum JoystickControllerID {
#[default]
Joystick1,
Joystick2,
}
#[bevy_main]
fn main() {
App::new()
.add_plugins(DefaultPlugins)
// Add plugin to application
.add_plugin(VirtualJoystickPlugin::::default())
.run()
}
```
Create Joystick
```rust
#[bevy_main]
fn main() {
App::new()
.add_plugins(DefaultPlugins)
// Add plugin to application
.add_plugin(VirtualJoystickPlugin)
// Create system
.add_startup_system(create_scene)
// update System
.add_system(update_player)
.run()
}
fn create_scene(mut cmd: Commands, asset_server: Res) {
cmd.spawn(Camera2dBundle::default());
cmd.spawn_empty().insert(Player(30.));
// Spawn Virtual Joystick at horizontal center
create_joystick(
&mut cmd,
asset_server.load("Knob.png"),
asset_server.load("Outline.png"),
None,
None,
Some(Color::rgba(1.0, 0.27, 0.0, 0.3))),
Vec2::new(75., 75.),
Vec2::new(150., 150.),
VirtualJoystickNode {
dead_zone: 0.,
id: "UniqueJoystick".to_string(),
axis: VirtualJoystickAxis::Both,
behaviour: VirtualJoystickType::Floating,
},
Style {
width: Val::Px(150.),
height: Val::Px(150.),
position_type: PositionType::Absolute,
left: Val::Percent(50.),
bottom: Val::Percent(15.),
..default()
},
);
}
```
Use variable generated by Joystick
```rust
fn update_joystick(
mut joystick: EventReader>,
mut player: Query<(&mut Transform, &Player)>,
time_step: Res
// Iter each joystick event
for j in joystick.read() {
let Vec2 { x, y } = j.axis();
// Verify ID of joystick for movement
match j.id() {
JoystickControllerID::Joystick1 => {
// Move player using joystick axis value
player.translation.x += x * player_data.0 * time_step.delta_seconds();
player.translation.y += y * player_data.0 * time_step.delta_seconds();
}
}
}
}
```
# TODOs
- [ ] WIP: Add more better documentation