https://github.com/shanecelis/bevy_minibuffer

https://github.com/shanecelis/bevy_minibuffer

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/shanecelis/bevy_minibuffer
• Owner: shanecelis
• License: apache-2.0
• Created: 2024-04-05T10:46:53.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-04-12T08:26:03.000Z (9 months ago)
• Last Synced: 2024-04-12T14:45:49.782Z (8 months ago)
• Language: Rust
• Size: 568 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE2

Awesome Lists containing this project

README

        
# bevy_minibuffer

This is a developer console for the bevy game engine. It's inspired by the

user interface of classic unix text editors rather than the unix shell.

> [!CAUTION]

> `bevy_minibuffer` is currently in the early stages of development and is subject to breaking changes.

# Example

![two_commands example](https://github.com/shanecelis/bevy_minibuffer/assets/54390/e90c4ef9-664c-47af-8ff5-a83214237341)

The video above shows the [two_commands.rs](examples/two_commands.rs) example.

# Goals

- Easily add commands

- Easily bind key chord sequences to commands

- Easily solicit user for textual input

- Tab completable

## Unrealized goals

- Easily exclude from build

- Easily opt-in to built-in functionality

# Antigoals

- No general text editing

- No windows or panels

Try to force everything through the minibuffer at the bottom of the screen. It can resize to accommodate more than one-line of text. 

- No default kitchen sink

The default functionality should be a blank slate that does nothing if no commands or key bindings have been added. Built-in functions like `exec_act` and the ":" key binding should be opt-in.

# FAQ

## Why are bevy_minibuffer commands called acts?

`bevy_minibuffer` commands are called `Act`s to avoid confusion because bevy

already has its own `Command` struct.

# Design Quetions

## Re: No windows antigoal

The minibuffer can show more than one line of text, but what to do if its asked

to show multiple pages of text?

# License

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