https://github.com/loopystudios/bevy_ogle

A multi-mode camera for 2D vector games
https://github.com/loopystudios/bevy_ogle

Last synced: 3 months ago
JSON representation

A multi-mode camera for 2D vector games

• Host: GitHub
• URL: https://github.com/loopystudios/bevy_ogle
• Owner: loopystudios
• License: apache-2.0
• Created: 2024-07-07T01:52:48.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-20T02:57:50.000Z (6 months ago)
• Last Synced: 2024-10-20T01:16:21.217Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 29.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
> [!WARNING]

> This is a work in progress and the README is a reflection of future work.



# Bevy Ogle

**A multi-mode camera for 2D vector games in [Bevy](https://bevyengine.org).**

[![Discord](https://img.shields.io/discord/913957940560531456.svg?label=Loopy&logo=discord&logoColor=ffffff&color=ffffff&labelColor=000000)](https://discord.gg/zrjnQzdjCB)

[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](#license)

[![Following released Bevy versions](https://img.shields.io/badge/bevy%20tracking-released%20version-lightblue)](https://bevyengine.org/learn/quick-start/plugin-development/#main-branch-tracking)\

[![Dependency status](https://deps.rs/repo/github/loopystudios/bevy_ogle/status.svg)](https://deps.rs/repo/github/loopystudios/bevy_ogle)

[![Crates.io](https://img.shields.io/crates/v/bevy_ogle.svg)](https://crates.io/crates/bevy_ogle)

[![Docs](https://img.shields.io/docsrs/bevy_ogle)](https://docs.rs/bevy_ogle)

[![Build status](https://github.com/loopystudios/bevy_ogle/workflows/CI/badge.svg)](https://github.com/loopystudios/bevy_ogle/actions)



Quickstart to run an example:

```shell

cargo run -p demo

```

## Bevy version support

|bevy|bevy_ogle|

|---|---|

|0.14|0.1-0.2, main|

|< 0.13| unsupported |

## Usage

There are several [examples](examples/) for reference.

You can also run examples on web:

```shell

# Make sure the Rust toolchain supports the wasm32 target

rustup target add wasm32-unknown-unknown

cargo run_wasm -p demo

```

### Camera Modes

The camera currently supports 3 modes, easily switched through commands.

```rust

commands.ogle_mode(OgleMode::Frozen); // No camera system will be run. "User is in the menu"

commands.ogle_mode(OgleMode::Follow); // Camera will follow a target.

commands.ogle_mode(OgleMode::Pancam); // Camera is a debug camera controlled by the user.

```

### Camera Target

Exclusively when the camera is in `OgleMode::Follow`, the camera will follow a target.

There are several ways to set the target:

```rust

commands.ogle_clear_target(); // Clear the target - No following is observed.

commands.ogle_target_position(Vec2::new(0.0, 0.0)); // Camera looks at a position target.

commands.ogle_target_entity(target_entity); // Camera follows a target entity (must have a `Transform`).

```

## Community

All Loopy projects and development happens in the [Loopy Discord](https://discord.gg/zrjnQzdjCB). The discord is open to the public.

Contributions are welcome by pull request. The [Rust code of conduct](https://www.rust-lang.org/policies/code-of-conduct) applies.

## License

Licensed under either of

- Apache License, Version 2.0

   ([LICENSE-APACHE](LICENSE-APACHE) or )

- MIT license

   ([LICENSE-MIT](LICENSE-MIT) or )

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.