Skip to content
View source

Installation

Entelechy is built from source for now. The repository (Fynn-3D/entelechy) is private; you need access.

  • Rust 1.93 or later (rust-version = "1.93", edition 2024), via rustup:

    终端窗口
    rustup update stable
    rustc --version # ≥ 1.93
  • Git and a GitHub account with access to the repository.

  • Optional: building the windowed entelechy-player on Linux needs pkg-config and libudev’s development files (e.g. pkg-config libudev-dev on Debian/Ubuntu); the GPU backend needs a Metal, Vulkan or DX12 adapter.

终端窗口
git clone https://github.com/Fynn-3D/entelechy.git
cd entelechy
cargo build --release

cargo build --release puts every program in target/release/:

Program What it does
entelechy the CLI: new, check, run, render, replay, serve, trace, graph, bench…
entelechy-player opens a scene in a window and keeps it live
entelechy-import / entelechy-export glTF, audio, MIDI, SVG and fonts in; GLB, WAV, MIDI and fonts out
libentelechy_ffi the C ABI library; see Embedding & bridges

For the CLI alone (faster, and no libudev):

终端窗口
cargo build --release -p entelechy
终端窗口
entelechy version
entelechy = 0.0.2-rc.3
entelechy.api = 1
entelechy.language = 3
entelechy.ir = 1
entelechy.package = 1

Run the first example:

终端窗口
entelechy run examples/grayscale/scene.esn --out gray.png
entelechy replay examples/grayscale/tests/grayscale.replay
evaluated in 1.24ms: executed [gray+source, blocks], reused 0 -> gray.png
examples/grayscale/tests/grayscale.replay: ok (1 frames, 5 checks)
终端窗口
cargo build --workspace
cargo test --workspace

The external-host, DCC-tool, headless Chrome and C bridge tests skip themselves where those tools are absent. The repository’s full verification is cargo xtask verify (see Contributing).