Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Eternal Pixels

A UI suite and pixel art editor.

The editor is not built yet. What exists so far is the Bazel monorepo and the libraries it will be made of: ink-rs, Rust bindings to Google Ink; eternal-styler, a small CSS engine built on Servo’s cssparser and selectors crates; eternal-ui, a dense, keyboard-first UI toolkit styled with that CSS; and eternal-ui-skia, its Skia rendering backend.

Layout

crates/
  eternal-pixels/   the application            (AGPL-3.0)
  eternal-ui/       UI toolkit                 (MPL-2.0)
    themes/         the built-in stylesheet
  eternal-ui-skia/  Skia backend for the toolkit (MPL-2.0)
  eternal-styler/   CSS engine for the toolkit (MPL-2.0)
  ink-rs/           Google Ink bindings        (MPL-2.0)
    cc/             the C++ facade
    src/            the safe Rust API
patches/            Bazel module patches
third_party/        crate_universe lockfile for crates.io dependencies
tools/bindgen/      regenerates the FFI declarations
tools/ink/          builds an Ink prefix for the Cargo build
licenses/           licence texts, symlinked into each crate
docs/               this book

Building

Bazel is the development build. It fetches Ink and builds it from source, so nothing needs installing beyond Bazel.

bazel build //...
bazel test //...

The first build is long: it compiles Ink and Abseil.

API reference

The rustdoc for every crate is published next to this book at api/. To build it locally:

tools/docs/build-api.sh       # writes docs/book/api

This book

The book is built with mdBook. To work on it locally:

mdbook serve docs --open

Pages live under docs/src/, and docs/src/SUMMARY.md is the table of contents. Every push to main that touches docs/ rebuilds the book and publishes it to GitHub Pages.