https://github.com/not-elm/bevy_flurx

Allows you to write sequential description of processes involving delays, user input, and other waits.
https://github.com/not-elm/bevy_flurx

async bevy bevy-plugin game-development rust

Last synced: about 1 month ago
JSON representation

Allows you to write sequential description of processes involving delays, user input, and other waits.

• Host: GitHub
• URL: https://github.com/not-elm/bevy_flurx
• Owner: not-elm
• License: apache-2.0
• Created: 2023-10-12T10:08:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-04T12:35:29.000Z (5 months ago)
• Last Synced: 2024-06-04T13:56:53.041Z (5 months ago)
• Topics: async, bevy, bevy-plugin, game-development, rust
• Language: Rust
• Homepage: https://docs.rs/bevy_flurx/
• Size: 1.2 MB
• Stars: 45
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# bevy_flurx

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

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

[![Crates.io](https://img.shields.io/crates/d/bevy_flurx.svg)](https://crates.io/crates/bevy_flurx)

This library provides a mechanism for more sequential description of delays, character movement,

waiting for user input, and other state waits.

As an example, here is an example of a cut-in effect that involves waiting for user input, a slight delay, and a sprite

to move.

![cut_in](examples/cut_in.gif)

The full source code can be found [here](examples/cut_in.rs).

```rust

fn spawn_reactor(

    mut commands: Commands

) {

    commands.spawn(Reactor::schedule(|task| async move {

        task.will(Update, {

            wait::input::just_pressed().with(KeyCode::KeyR)

                .then(once::switch::on::())

                .then(delay::time().with(Duration::from_millis(100)))

                .then(once::switch::on::())

                .then(wait::both(

                    wait::switch::off::(),

                    wait::switch::off::(),

                ))

                .then(once::switch::on::())

                .then(delay::time().with(Duration::from_millis(500)))

                .then(once::switch::off::())

                .then(once::switch::on::())

                .then(delay::time().with(Duration::from_millis(300)))

                .then(once::event::app_exit())

        })

            .await;

    }));

}

```

## Example

All examples are [`here`](./examples).

## Feature flags

| flag name | short description              | default |

|-----------|--------------------------------|---------|

| audio     | audio actions                  | true    |

| record    | undo/redo actions and events   | true    | 

| effect    | thread/async side effects      | true    |

| tokio     | async-compat and async actions | false   | 

### audio

Provides the actions that perform simple audio playback and waiting using bevy's default audio functionality.

- once::audio

- wait::audio

### record

Provides `Record` to manage operation history.

![undo_redo](examples/undo_redo.gif)

### effect

Allows to convert the operations with side effects such as asynchronous runtime or thread into the

referential-transparent actions.

### tokio

You will be able to write processes that depend on tokio's runtime in the reactor.

## ChangeLog

Please see [here](https://github.com/not-elm/bevy_flurx/blob/main/CHANGELOG.md).

## Compatible Bevy versions

| bevy_flurx    | bevy   |

|---------------|--------|

| 0.3.0         | 0.13.0 |

| 0.3.1         | 0.13.1 |

| 0.3.2 ~ 0.5.3 | 0.13.2 | 

| 0.6.0         | 0.4.1  | 

## License

This crate is licensed under the MIT License or the Apache License 2.0.