1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
//! Extra BRP methods for Bevy applications
//!
//! This crate provides additional Bevy Remote Protocol (BRP) methods that can be added
//! to your Bevy application for enhanced remote control capabilities.
//!
//! # Usage
//!
//! Add the plugin to your Bevy app:
//! ```no_run
//! use bevy::prelude::*;
//! use bevy_brp_extras::BrpExtrasPlugin;
//!
//! App::new()
//! .add_plugins(DefaultPlugins)
//! .add_plugins(BrpExtrasPlugin::default())
//! .run();
//! ```
//!
//! # Plugin Composability
//!
//! `BrpExtrasPlugin` is designed to compose with existing BRP setups. If
//! [`RemotePlugin`](bevy_remote::RemotePlugin) or
//! [`RemoteHttpPlugin`](bevy_remote::http::RemoteHttpPlugin) are already added
//! to the app, `BrpExtrasPlugin` will skip adding them and register its methods
//! into the existing [`RemoteMethods`](bevy_remote::RemoteMethods) resource.
//!
//! **Important**: If `RemoteHttpPlugin` is already present, any port
//! configuration on `BrpExtrasPlugin` (`with_port()` or the `BRP_EXTRAS_PORT`
//! environment variable) will be ignored — the existing HTTP transport is used
//! as-is. A warning is logged when this occurs.
//!
//! # HTTP Transport Configuration
//!
//! On native targets, HTTP transport can be configured in three mutually
//! exclusive ways (enforced at compile time):
//!
//! 1. **Default** — uses `BRP_EXTRAS_PORT` env var or port 15702
//! 2. **Explicit port** — `BrpExtrasPlugin::with_port(9000)`
//! 3. **Full control** — `BrpExtrasPlugin::with_http_plugin(plugin)` accepts a pre-configured
//! [`RemoteHttpPlugin`](bevy_remote::http::RemoteHttpPlugin)
//!
//! # Available BRP Methods
//!
//! ## App Lifecycle
//!
//! ### `brp_extras/screenshot`
//! Captures a screenshot of the primary window and saves it to a file.
//! - `path` (string, required): file path where the screenshot will be saved
//!
//! **Note**: Requires Bevy's `png` feature enabled, otherwise files will be 0 bytes.
//!
//! ### `brp_extras/shutdown`
//! Schedules a graceful application shutdown. No parameters.
//!
//! ### `brp_extras/set_window_title`
//! Changes the title of the primary window.
//! - `title` (string, required): new window title
//!
//! ### `brp_extras/get_diagnostics`
//! Returns FPS and frame time diagnostics from Bevy's `DiagnosticsStore`.
//! No parameters. Requires the `diagnostics` cargo feature (enabled by default).
//!
//! Returns current, average, and smoothed values for FPS and frame time,
//! plus total frame count and history buffer metadata.
//!
//! ## Keyboard
//!
//! ### `brp_extras/send_keys`
//! Simulates keyboard input with a press-hold-release cycle. All keys are
//! pressed simultaneously and held for the specified duration.
//! - `keys` (array of strings, required): key codes (e.g., `["KeyA", "Space", "ShiftLeft"]`)
//! - `duration_ms` (u32, optional, default: 100, max: 60000): hold duration in milliseconds
//!
//! ### `brp_extras/type_text`
//! Types text sequentially, one character per frame, with proper shift handling
//! for uppercase and symbols.
//! - `text` (string, required): text to type (letters, numbers, symbols, newlines, tabs)
//!
//! ## Mouse
//!
//! All mouse methods accept an optional `window` parameter (entity ID) to target
//! a specific window. Defaults to the primary window.
//!
//! Button values: `"Left"`, `"Right"`, `"Middle"`, `"Back"`, `"Forward"`
//!
//! ### `brp_extras/click_mouse`
//! Performs a click (press and immediate release).
//! - `button` (string, required)
//! - `window` (u64, optional)
//!
//! ### `brp_extras/double_click_mouse`
//! Performs two rapid clicks with configurable delay.
//! - `button` (string, required)
//! - `delay_ms` (u32, optional, default: 250): delay between clicks
//! - `window` (u64, optional)
//!
//! ### `brp_extras/send_mouse_button`
//! Presses and holds a mouse button for a specified duration.
//! - `button` (string, required)
//! - `duration_ms` (u32, optional, default: 100, max: 60000)
//! - `window` (u64, optional)
//!
//! ### `brp_extras/move_mouse`
//! Moves the cursor by delta or to an absolute position. Exactly one must be provided.
//! - `delta` ([f32; 2], optional): relative movement
//! - `position` ([f32; 2], optional): absolute position
//! - `window` (u64, optional)
//!
//! ### `brp_extras/drag_mouse`
//! Performs a smooth drag with linear interpolation over a number of frames.
//! - `button` (string, required)
//! - `start` ([f32; 2], required): starting position
//! - `end` ([f32; 2], required): ending position
//! - `frames` (u32, required): number of frames to interpolate over
//! - `window` (u64, optional)
//!
//! ### `brp_extras/scroll_mouse`
//! Sends mouse wheel scroll events.
//! - `x` (f32, required): horizontal scroll amount
//! - `y` (f32, required): vertical scroll amount
//! - `unit` (string, required): `"Line"` or `"Pixel"`
//! - `window` (u64, optional)
//!
//! ## Trackpad Gestures (macOS)
//!
//! ### `brp_extras/double_tap_gesture`
//! Sends a double-tap gesture event. No parameters.
//!
//! ### `brp_extras/pinch_gesture`
//! Sends a pinch gesture for zoom operations.
//! - `delta` (f32, required): positive = zoom in, negative = zoom out
//!
//!
//! ### `brp_extras/rotation_gesture`
//! Sends a rotation gesture.
//! - `delta` (f32, required): rotation in radians
pub use BrpExtrasPlugin;
pub use HasEffectivePort;
pub use HttpPluginConfigured;
pub use PortConfigured;
pub use PortDisplay;
pub use Unconfigured;
/// Default port for remote control connections
///
/// This matches Bevy's `RemoteHttpPlugin` default port to ensure compatibility.
pub const DEFAULT_REMOTE_PORT: u16 = 15702;