https://github.com/aleokdev/guiedit

Easily add an editor to any graphical application
https://github.com/aleokdev/guiedit

editor gui rust

Last synced: 2 months ago
JSON representation

Easily add an editor to any graphical application

• Host: GitHub
• URL: https://github.com/aleokdev/guiedit
• Owner: aleokdev
• License: apache-2.0
• Created: 2022-10-28T16:20:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-12T15:50:46.000Z (about 2 years ago)
• Last Synced: 2024-03-15T15:22:59.522Z (11 months ago)
• Topics: editor, gui, rust
• Language: Rust
• Homepage:
• Size: 428 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# guiedit

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

[![dependency status](https://deps.rs/crate/guiedit/latest/status.svg)](https://deps.rs/crate/tiled/)

`guiedit` is a Rust library for easily adding a developer GUI to any graphical application.

![Sokoban with guiedit screenshot](res/screenshot-sokoban.png)

## Current State

The crate is in a really experimental state right now. Although it is usable, things may change at

any point. The tree node and inspector are already implemented, but the only backend supported is

SFML. If you use SFML, feel free to include this crate, but expect to see many breaking changes down

the line.

Any issue reports & PRs are greatly appreciated!

## Goal

The goal of this crate is to be able to change a few lines of code in an existing or new codebase

and instantly get an editor viewport, an object inspector, graphical gizmos, and even state

loading/saving & hot code reloading. You can read further details on the "Progress" section below.

## Tutorial

TODO; Check examples for now

## Progress

| Symbol | Meaning |

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

| ✅     | Done; implemented |

| ☑️      | Partial implementation |

| 🚧     | Work-in-progress  |

| ⌛     | Planned; Queued   |

### Editor & Common Features

|   Feature     |   Status  |

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

| Inspector with support for `Inspectable` objects | ✅ |

| `#[derive(Inspectable)]` for structs | ✅ |

| `#[derive(Inspectable)]` for enums | ✅ |

| Object tree with support for `TreeNode` objects | ✅ |

| `#[derive(TreeNode)]` for structs | ✅ |

| `#[derive(TreeNode)]` for enums | ⌛ |

| `Inspectable` impl for std & core types | ☑️🚧 |

| `TreeNode` impl for std & core types | ☑️🚧 |

| Hot code reloading | ⌛ |

| Graphical gizmo support | ⌛ |

### [`sfml`](https://github.com/jeremyletang/rust-sfml) Integration

|   Feature     |   Status  |

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

| Forwarding all user rendering to offscreen texture | ✅ |

| Capturing events from the editor and relaying them to user-side | ☑️ |

| Object inspection via UI | ✅ |

| Window resizing | ⌛ |

| `Inspectable` impl for SFML types | ☑️🚧 |

| Graphical gizmos for `Drawable`s | ⌛ |