heron - GitLite

KO | EN

gitlite — search

#javascript #react #typescript #go #golang #rust #docker #nodejs #windows #cli #security #mcp #openai #open-source

heron

(★ 289)

[DISCONTINUED] An ergonomic physics API for bevy games

파일 탐색기

최종 버전 다운로드 (.zip)

- fast_compiles_config
- - build.yml
  - look-ahead.yml
- - collision_from_mesh.rs
  - collisions.rs
  - constraints.rs
  - events.rs
  - gravity.rs
  - layers.rs
  - lib.rs
  - physics_time.rs
  - step.rs
  - utils.rs
  - velocity.rs
- build.rs
- Cargo.toml
- - dim2.rs
  - dim3.rs
  - lib.rs
  - shape3d_wireframe.rs
- Cargo.toml
- collision_shapes_in_child_entity.rs
- debug_2d.rs
- debug_3d.rs
- demo.rs
- events.rs
- layers.rs
- quickstart.rs
- ray_casting.rs
- - lib.rs
- Cargo.toml
- - acceleration.rs
  - body.rs
  - convert.rs
  - damping.rs
  - lib.rs
  - pipeline.rs
  - shape.rs
  - velocity.rs
- - acceleration.rs
  - bodies.rs
  - body_types.rs
  - children_collision_shapes.rs
  - constraints.rs
  - damping.rs
  - density.rs
  - events.rs
  - friction.rs
  - layers.rs
  - resources.rs
  - restitution.rs
  - sensor_shape.rs
  - velocity.rs
- build.rs
- Cargo.toml
- lib.rs
- macros.rs
.gitignore
.gitpod.Dockerfile
.gitpod.yml
.releaserc.json
build.rs
Cargo.toml
CONTRIBUTING.md
deny.toml
LICENSE
publish.sh
README.md
renovate.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Heron

[![License](https://img.shields.io/github/license/jcornaz/heron)](https://github.com/jcornaz/heron/blob/main/LICENSE)
[![Crates.io](https://img.shields.io/crates/v/heron)](https://crates.io/crates/heron)
[![Docs](https://docs.rs/heron/badge.svg)](https://docs.rs/heron)
[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
[![Build](https://img.shields.io/github/workflow/status/jcornaz/heron/Build)](https://github.com/jcornaz/heron/actions?query=workflow%3ABuild+branch%3Amain)
[![Zenhub](https://img.shields.io/badge/workspace-zenhub-%236061be)](https://app.zenhub.com/workspaces/heron-600478067304b1000e27f4c4/board)

An ergonomic physics API for 2d and 3d [bevy] games. (powered by [rapier])

## ⚠ The project is discontinued!

Heron is in now discontinued. No more features, fixes or support will be provided.

For more details on the reasons, read the [announcement](https://github.com/jcornaz/heron/discussions/317)

## Design principles

* Use [bevy] types, resources and components when possible (`Vec3`, `Quat`, `Transform`, `Events`, etc.)
* Provide a single API that works for both 2d and 3d.
* Data oriented. Using this library should feel like its a part of [bevy].
* Avoid asking the user to lookup in resources via *handles*. Data should be accessible and modifiable directly in components.
* Hide the actual physics engine. This is an implementation detail the user shouldn't have to worry about.
    * But, allow advanced users to access the underlying [rapier] resources, so the user is never blocked by a missing
      element in the API of heron.

## What it looks like

```rust,no_run
use bevy::prelude::*;
use heron::prelude::*;

fn main() {
  App::new()
    .add_plugins(DefaultPlugins)
    .add_plugin(PhysicsPlugin::default()) // Add the plugin
    .insert_resource(Gravity::from(Vec3::new(0.0, -9.81, 0.0))) // Optionally define gravity
    .add_startup_system(spawn)
    .run();
}

fn spawn(mut commands: Commands) {
    commands

// Spawn any bundle of your choice. Only make sure there is a `GlobalTransform`
        .spawn_bundle(SpriteBundle::default())

// Make it a rigid body
        .insert(RigidBody::Dynamic)
        
        // Attach a collision shape
        .insert(CollisionShape::Sphere { radius: 10.0 })
        
        // Optionally add other useful components...
        .insert(Velocity::from_linear(Vec3::X * 2.0))
        .insert(Acceleration::from_linear(Vec3::X * 1.0))
        .insert(PhysicMaterial { friction: 1.0, density: 10.0, ..Default::default() })
        .insert(RotationConstraints::lock())
        .insert(CollisionLayers::none().with_group(Layer::Player).with_mask(Layer::World));
}

// Define your physics layers
#[derive(PhysicsLayer)]
enum Layer {
    World,
    Player,
    Enemies,
}
```

## Documentation

* [guide and reference](https://docs.rs/heron)
* [changelog](CHANGELOG.md)

## MSRV

The minimum supported rust version is currently: `1.60`

**It *may* be increased to a newer stable version in a minor release.** (but only if needed)

It *will* be increased to the latest stable version in a major release. (even if not needed)

## Supported Bevy Versions

| bevy | heron      |
|------|------------|
| 0.8  | 4, 5       |
| 0.7  | 3          |
| 0.6  | 1, 2       |
| 0.5  | 0.4 - 0.13 |
| 0.4  | 0.1 - 0.3  |

## How does this project compare to bevy_rapier?

[bevy_rapier] plugin is an excellent option and should definitely be considered.

Here are some key differences between the two projects:

* `heron` tries to provide a smaller, simpler API that is easier to use. `bevy_rapier` is more complete and powerful, but a bit more complex.
* `heron` is focused on games only. `bevy_rapier` targets all kind of physics simulation applications (incl. games).
* `bevy_rapier` is actively maintained by [dimforge], the developer of `rapier`. `heron` is also active, but cannot evolve as fast as `bevy_rapier` can.

`heron` is probably more suited for simple games and game-jams, where the ease of learn/use is especially valuable and where the lack of advanced feature isn't problematic.

`bevy_rapier` is probably more suited for bigger/complex games and other types of physics simulations, where it may be better to learn/use a more exhaustive/complex API.

## Contribute / Contact

You can open issues/discussions here or you can discuss with me (`Jomag#2675`) in the [bevy discord](https://discord.com/invite/gMUk5Ph)

See [how to contribute](https://github.com/jcornaz/heron/blob/main/CONTRIBUTING.md)

[bevy]: https://bevyengine.org
[rapier]: https://rapier.rs
[bevy_rapier]: https://github.com/dimforge/bevy_rapier
[dimforge]: https://www.dimforge.com
[nalgebra]: https://github.com/dimforge/nalgebra