bevy_cef 0.1.0

Bevy CEF integration for web rendering
docs.rs failed to build bevy_cef-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

bevy_cef

A powerful Bevy plugin for embedding web content using the Chromium Embedded Framework (CEF). Render websites, local HTML files, and web applications directly onto 3D meshes or 2D sprites with full interactivity and bidirectional communication between JavaScript and Bevy.

Crates.io Documentation License

https://github.com/user-attachments/assets/54f476d0-8eda-4030-a3f6-dc4f2f54209f

โœจ Features

  • ๐ŸŒ Full Web Browser Integration - Embed complete web pages with CSS, JavaScript, and modern web APIs
  • ๐ŸŽฎ 3D Mesh & 2D Sprite Rendering - Render web content on any 3D surface or 2D sprite
  • โšก Interactive Input - Full mouse, keyboard, and touch input support with automatic event forwarding
  • ๐Ÿ”„ Bidirectional Communication - Seamless data exchange between JavaScript and Bevy systems
  • ๐Ÿ“ Local Asset Serving - Serve local HTML/CSS/JS files with hot reload support
  • ๐Ÿ› ๏ธ Developer Tools - Full Chrome DevTools integration for debugging
  • ๐ŸŽฏ Navigation Controls - Browser history, zoom, audio controls, and more
  • ๐Ÿ”’ Multi-Process Architecture - Secure CEF multi-process design for stability

๐Ÿ“ฆ Installation

Add to your Cargo.toml:

[dependencies]
bevy = "0.16"
bevy_cef = "0.1.0"

Platform Requirements

On macOS, using CEF typically requires creating an app bundle. For development, this library provides a debug feature flag. When enabled, it installs a debug renderer process and the CEF framework locally so the app can run standalone.

[!NOTE] Use this feature only during development; for releases, bundle the renderer process and the CEF framework inside the app.

Manual Installation(macOS)

> cargo install export-cef-dir
> export-cef-dir --force $HOME/.local/share/cef
> cargo install bevy_cef_debug_render_process

Examples

See examples/.

On macOS, you need to enable debug feature enabled:

cargo run --example simple --features debug

๐ŸŒ Platform Support

Platform Status Notes
macOS โœ… Full Primary development platform
Windows โš ๏ธ Planned CEF support ready, testing needed
Linux โš ๏ธ Planned CEF support ready, testing needed

๐Ÿค Contributing

We welcome contributions! Here's how you can help:

  1. ๐Ÿ› Bug Reports - Open an issue with detailed reproduction steps
  2. ๐Ÿ’ก Feature Requests - Suggest new features or improvements
  3. ๐Ÿ”ง Pull Requests - Submit bug fixes or new features
  4. ๐Ÿ“š Documentation - Improve docs, examples, or tutorials
  5. ๐Ÿงช Testing - Help test on different platforms

Development Setup

  1. Clone the repository
  2. Install Rust and Cargo
  3. Run cargo build --features debug to set up CEF
  4. Run examples to test functionality

Code Standards

  • Follow Rust style guidelines (cargo fmt)
  • Pass all lints (cargo clippy)
  • Add tests for new features
  • Update documentation for API changes

๐Ÿ“‹ Version Compatibility

Bevy bevy_cef CEF Status
0.16 0.1.0 138 โœ… Current

โš–๏ธ License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


Built with ๐Ÿฆ€ Rust and โค๏ธ for the Bevy community