Coder Social home page Coder Social logo

bevy_dev_console's Introduction

bevy_dev_console

bevy_dev_console is a Source-inspired developer console plugin for the Bevy Game Engine.

Image of the developer console

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)
    • Calculations
    • Variables
      • Uses a simplified version of ownership and borrowing
    • Standard library (Doesn't have much at the moment)
    • Custom native functions (World access included!)
    • Many types
    • Resource viewing and modification
      • Enums
      • Structs
    • Entity queries Coming Soon... (Syntax suggestions would be appreciated!)
    • ...and more!

Usage

  1. Add the bevy_dev_console git package.

    cargo add --git https://github.com/doonv/bevy_dev_console.git
  2. Import the prelude.

    use bevy_dev_console::prelude::*;
  3. Add the plugins.

    use bevy::{prelude::*,log::LogPlugin};
    use bevy_dev_console::prelude::*;
    
    App::new()
        .add_plugins((
            // Start capturing logs before the default plugins initiate.
            ConsoleLogPlugin::default(),
            // Add the default plugins without the LogPlugin.
            // Not removing the LogPlugin will cause a panic!
            DefaultPlugins.build().disable::<LogPlugin>(),
            // 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.13.* git (master)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.