https://github.com/doonv/bevy_dev_console

Source-inspired developer console plugin for the Bevy game engine.
https://github.com/doonv/bevy_dev_console

bevy console developer-console rust source

Last synced: 2 days ago
JSON representation

Source-inspired developer console plugin for the Bevy game engine.

• Host: GitHub
• URL: https://github.com/doonv/bevy_dev_console
• Owner: doonv
• License: apache-2.0
• Created: 2023-11-26T19:13:37.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-09T20:01:02.000Z (15 days ago)
• Last Synced: 2025-01-15T09:49:56.868Z (9 days ago)
• Topics: bevy, console, developer-console, rust, source
• Language: Rust
• Homepage:
• Size: 595 KB
• Stars: 129
• Watchers: 2
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# bevy_dev_console

`bevy_dev_console` is a Source-inspired developer console plugin for the [Bevy Game Engine](https://github.com/bevyengine/bevy).

![Image of the developer console](doc/console.png)

> [!WARNING]  

>

> `bevy_dev_console` is currently in its early development stages. Expect breaking changes in the near future (especially when using the built-in command parser). For this reason its only available as a git package at the moment.

## Features

- Log viewing

  - View all the hidden data from any log message by hovering over it.

- Powerful Built-in parser language built specifically for `bevy_dev_console`. ([Documentation](https://github.com/doonv/bevy_dev_console/wiki/Built%E2%80%90in-Parser))

  - Calculations

  - Variables

    - Uses a simplified version of ownership and borrowing

  - Standard library (Doesn't have much at the moment)

  - [Custom native functions](https://github.com/doonv/bevy_dev_console/blob/master/examples/custom_functions.rs) (`World` access included!)

  - [Many types](https://github.com/doonv/bevy_dev_console/wiki/Built%E2%80%90in-Parser#types)

  - Resource viewing and modification

    - Enums

    - Structs

  - ~~Entity queries~~ [*Coming Soon...*](https://github.com/doonv/bevy_dev_console/issues/3) (Syntax suggestions would be appreciated!)

  - ...and more!

## Usage

1. Add the `bevy_dev_console` git package.

    ```bash

    cargo add --git https://github.com/doonv/bevy_dev_console.git

    ```

2. Import the `prelude`.

    ```rust

    use bevy_dev_console::prelude::*;

    ```

3. Add the plugins.

    ```rust,no_run

    use bevy::{prelude::*, log::LogPlugin};

    use bevy_dev_console::prelude::*;

    App::new()

        .add_plugins((

            // Add the log plugin with the custom log layer

            DefaultPlugins.set(LogPlugin {

                custom_layer: custom_log_layer,

                ..default()

            }),

            // Add the dev console plugin itself.

            DevConsolePlugin,

        ))

        .run();

    ```

4. That should be it! You can now press the `` ` `` / `~` key on your keyboard and it should open the console!

## Togglable Features

**(default)** `builtin-parser` includes the default parser. Disabling this allows you to remove the built-in parser and replace it with your own (or you could do nothing and make the console into a log reader).

## Bevy Compatibility

| bevy   | bevy_dev_console |

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

| 0.14.* | git (master)     |