I'll no longer be maintaining conrod for the reasons discussed here. If you're looking for a similar yet nicer replacement GUI library, I recommend egui. If you're interested in taking over maintenance, please express your interest here.

An easy-to-use, 2D GUI library written entirely in Rust.

1. What is Conrod?
   • A Brief Summary
   • Screenshots and Videos
   • Feature Overview
   • Available Widgets
     • Primitive Widgets
     • Common Use Widgets
   • Immediate Mode
     • What is it?
     • Why use it?
     • Is Conrod Immediate or Retained?
   • The Builder Pattern
2. Getting Started
   • Installing Rust and Cargo
   • Running the Conrod Examples
3. Hello World
   • Creating a new project
   • Conrod Setup -Back ends
   • Creating a Window
   • Event Handling
4. Using and Customising Themes
   • What is a Theme?
   • Custom Themes
   • Serializing Themes
5. Designing Custom Widgets (using the Widget trait)
   • The Widget trait
   • The widget_style! macro
   • The builder_methods! macro
   • Making a Button widget
6. Custom Graphics and Window Backends
   • Demonstration of Backend Implementation (using glium and glutin)
7. Internals
   • The Ui's Widget Graph
   • Ui::set_widgets - How does it work?
8. FAQ

The Guide is a work-in-progress. If a section is not linked, it is likely not yet implemented.

Crate	Badges	Description
conrod_core		The fundamentals for any conrod project.
conrod_derive		Provides the WidgetCommon and WidgetStyle derive macros.
conrod_winit		Simplifies using conrod_core with winit
conrod_gfx		Simplifies using conrod_core with the gfx ecosystem
conrod_wgpu		Simplifies using conrod_core with wgpu
conrod_glium		Simplifies using conrod_core with glium
conrod_piston		Simplifies using conrod_core with piston
conrod_vulkano		Simplifies using conrod_core with vulkano

We're just starting to reach a stable-ish API pattern! There will still be some large changes, however these are more likely to be new features than API overhauls.

To get a clearer idea of where we're at see the issues and in particular, the 1.0.0 milestone.

Want to help out? See Piston's how to contribute guide.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Example Assets

• Google Noto (Apache2)