Getting Started

Requirements

• Rust 1.98 or later (the rust-version of every crate). An app pinned to an older toolchain in rust-toolchain.toml fails to resolve; bump it first.
• egui and eframe 0.36.2.

Add a crate

fastframe is not on crates.io. Depend on a release tag from GitHub:

[dependencies]
fastframe-text = { git = "https://github.com/crmne/fastframe", tag = "v0.17.0" }
fastframe-fonts = { git = "https://github.com/crmne/fastframe", tag = "v0.17.0" }

Use the same tag for every fastframe crate, and move it deliberately: the release notes name every change an app has to make to upgrade.

A first window

Fonts and text rendering are where most apps start. At startup, before the first frame:

use fastframe_fonts::{FontSetup, Weight};

fn setup(ctx: &egui::Context) {
    // Inter at 400, 500, 600 and 700, and installed fonts for other scripts.
    let mut fonts = FontSetup::default().definitions();

    // Hint and antialias like the desktop does.
    let rendering = fastframe_text::detect();
    rendering.apply_to(&mut fonts);
    ctx.set_fonts(fonts);

    // After the app has set its own visuals, for both themes.
    ctx.all_styles_mut(|style| rendering.apply_to_visuals(&mut style.visuals));
}

fn title(ui: &mut egui::Ui, text: &str) {
    ui.label(egui::RichText::new(text).font(Weight::SemiBold.font_id(16.0)));
}

From there, each crate page shows how to wire it in. The migration guide lists, app by app, what each crate replaces in ZapFast, Spotifast, Solco, TonePush and Chat with Work Desktop, which makes it a good set of worked examples.

egui and winit forks

The apps build against forks of egui and winit that carry fixes waiting for upstream releases. A library cannot pin those: Cargo applies [patch] only in the root workspace of the app being built, so each app keeps its own [patch.crates-io] section. fastframe crates depend on the published egui versions, and they must compile against both the release and the apps’ fork.

The maintained apps-0.36.2 branch carries the app patches on egui 0.36.2. Use the revisions below together to get those fixes. Existing apps can keep their old pins until they upgrade fastframe. Copy this into the app’s root Cargo.toml:

[patch.crates-io]
ecolor = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
eframe = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
egui = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
egui-wgpu = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
egui-winit = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
egui_extras = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
egui_glow = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
emath = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
epaint = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
epaint_default_fonts = { git = "https://github.com/crmne/egui", rev = "6ce633ba5f7f64d19ef6d204f9377da560bb546b" }
winit = { git = "https://github.com/crmne/winit", rev = "ed7caa9023f10b397f5b6ec8284a840cbd8a6f65" }

Patch every egui crate the app uses from the same revision, so they share one emath and epaint (add egui_kittest if the app’s tests use it), and move egui and winit together: the egui revision is built against that winit, and mixing incompatible revisions can fail to build. An app that compensated for the zoom shrink itself (a window_builder that scales the restored size) drops that code when it moves to egui ba6790fe or later, or the size is scaled twice. Cargo warns about a patch for a crate the app does not use (egui_extras, say); leave that line out. With egui ba6790fe or later (emilk/egui#8621), a window or menu is left out of the accessibility tree on the frame that sizes it, so a test that reads the tree right after opening one runs one more frame first.

What the forks carry, and where each patch stands upstream. Each patch goes upstream as a pull request and stays in the fork until an egui or winit release includes it; then the fork drops it.

On stock egui and winit, fastframe still builds and works, without these fixes.

A future forks.toml, with a generator that writes each app’s patch section and a CI check that they agree, will keep those pins in one place. It does not exist yet; until then, this section has the current revisions, and a fastframe release that needs newer ones says so in its notes.