{"id":18561099,"url":"https://github.com/utilyre/bevy_prank","last_synced_at":"2025-04-10T02:31:21.516Z","repository":{"id":185920699,"uuid":"674352175","full_name":"utilyre/bevy_prank","owner":"utilyre","description":"Opinionated Unreal Engine inspired spectator camera for the Bevy game engine","archived":false,"fork":false,"pushed_at":"2023-08-19T11:26:46.000Z","size":136,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-28T04:45:55.083Z","etag":null,"topics":["bevy","bevy-plugin","camera","game-development","gamedev","plugin"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/bevy_prank","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/utilyre.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-03T18:28:18.000Z","updated_at":"2024-08-20T07:50:30.596Z","dependencies_parsed_at":"2024-06-19T15:34:24.714Z","dependency_job_id":null,"html_url":"https://github.com/utilyre/bevy_prank","commit_stats":null,"previous_names":["utilyre/bevy_prank"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utilyre%2Fbevy_prank","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utilyre%2Fbevy_prank/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utilyre%2Fbevy_prank/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utilyre%2Fbevy_prank/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/utilyre","download_url":"https://codeload.github.com/utilyre/bevy_prank/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144201,"owners_count":21054883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bevy","bevy-plugin","camera","game-development","gamedev","plugin"],"created_at":"2024-11-06T22:05:46.853Z","updated_at":"2025-04-10T02:31:21.213Z","avatar_url":"https://github.com/utilyre.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003e\n        Bevy Prank\n        \u003cbr /\u003e\n        \u003ca href=\"https://crates.io/crates/bevy_prank\"\u003e\u003cimg alt=\"version\" src=\"https://img.shields.io/crates/v/bevy_prank\" /\u003e\u003c/a\u003e\n        \u003ca href=\"https://crates.io/crates/bevy_prank\"\u003e\u003cimg alt=\"downloads\" src=\"https://img.shields.io/crates/d/bevy_prank\" /\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/utilyre/bevy_prank/issues\"\u003e\u003cimg alt=\"issues\" src=\"https://img.shields.io/github/issues/utilyre/bevy_prank\" /\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/utilyre/bevy_prank/blob/main/LICENSE\"\u003e\u003cimg alt=\"license\" src=\"https://img.shields.io/github/license/utilyre/bevy_prank\" /\u003e\u003c/a\u003e\n    \u003c/h1\u003e\n    \u003cp\u003e\n        Opinionated Unreal Engine inspired spectator camera for the Bevy game engine.\n    \u003c/p\u003e\n\u003c/div\u003e\n\n## ✨ Features\n\n- Provides smooth interpolation for movement without sacrificing camera's translation.\n\n- Includes an optional HUD overlay to display important information like FOV and FPS.\n\n- Automatically grabs cursor when \u003ckbd\u003eMMB\u003c/kbd\u003e/\u003ckbd\u003eRMB\u003c/kbd\u003e is held.\n\n- Allows complete control over movement via \u003ckbd\u003eLShift\u003c/kbd\u003e prefixed controls.\n\n## 📦 Installation\n\n1.  Install the crate using `cargo`\n\n    ```bash\n    cargo add bevy_prank\n    ```\n\n2.  Add `PrankPlugin` to your app\n\n    ```rust\n    use bevy::prelude::*;\n    use bevy_prank::prelude::*;\n\n    fn main() {\n        App::new()\n            // ...\n            .add_plugins((DefaultPlugins, PrankPlugin::default()))\n            // ...\n            .run();\n    }\n    ```\n\n## 🚀 Usage\n\nSpawn a `Camera3dBundle` along with a `Prank3d` component\n\n```rust\nuse bevy::prelude::*;\nuse bevy_prank::prelude::*;\n\nfn setup(mut commands: Commands) {\n    commands.spawn((\n        Prank3d::default(),\n        Camera3dBundle::default(),\n    ));\n}\n```\n\nFor further information see [examples][examples].\n\n## 🎮 Controls\n\n| Control                                                                                                            | Action                                                                                     |\n| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |\n| \u003ckbd\u003eMMB\u003c/kbd\u003e + Drag                                                                                              | Offsets the camera on its local `x` (left/right) and `y` (top/bottom) axes                 |\n| \u003ckbd\u003eRMB\u003c/kbd\u003e + Drag                                                                                              | Rotates the camera                                                                         |\n| \u003ckbd\u003eRMB\u003c/kbd\u003e + Scroll                                                                                            | Adjusts movement speed                                                                     |\n| \u003ckbd\u003eRMB\u003c/kbd\u003e + \u003ckbd\u003eW\u003c/kbd\u003e \u003ckbd\u003eA\u003c/kbd\u003e \u003ckbd\u003eS\u003c/kbd\u003e \u003ckbd\u003eD\u003c/kbd\u003e                                               | Moves the camera on its local `x` (left/right) and `z` (front/back) axes                   |\n| \u003ckbd\u003eRMB\u003c/kbd\u003e + \u003ckbd\u003eE\u003c/kbd\u003e \u003ckbd\u003eQ\u003c/kbd\u003e                                                                         | Moves the camera on the `y` (top/bottom) axis                                              |\n| \u003ckbd\u003eRMB\u003c/kbd\u003e + \u003ckbd\u003eLShift\u003c/kbd\u003e + \u003ckbd\u003eW\u003c/kbd\u003e \u003ckbd\u003eA\u003c/kbd\u003e \u003ckbd\u003eS\u003c/kbd\u003e \u003ckbd\u003eD\u003c/kbd\u003e \u003ckbd\u003eE\u003c/kbd\u003e \u003ckbd\u003eQ\u003c/kbd\u003e | Moves the camera on the `x` (left/right), `y` (top/bottom) axes, and `z` (front/back) axes |\n\n[examples]: https://github.com/utilyre/bevy_prank/tree/main/examples\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futilyre%2Fbevy_prank","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futilyre%2Fbevy_prank","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futilyre%2Fbevy_prank/lists"}