Installation
Entelechy is built from source for now. The repository (Fynn-3D/entelechy) is private; you need access.
Prerequisites
Section titled “Prerequisites”-
Rust 1.93 or later (
rust-version = "1.93", edition 2024), via rustup:终端窗口 rustup update stablerustc --version # ≥ 1.93 -
Git and a GitHub account with access to the repository.
-
Optional: building the windowed
entelechy-playeron Linux needspkg-configand libudev’s development files (e.g.pkg-config libudev-devon Debian/Ubuntu); the GPU backend needs a Metal, Vulkan or DX12 adapter.
Get the source and build
Section titled “Get the source and build”git clone https://github.com/Fynn-3D/entelechy.gitcd entelechycargo build --releasecargo 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 entelechyCheck the install
Section titled “Check the install”entelechy versionentelechy = 0.0.2-rc.3entelechy.api = 1entelechy.language = 3entelechy.ir = 1entelechy.package = 1Run the first example:
entelechy run examples/grayscale/scene.esn --out gray.pngentelechy replay examples/grayscale/tests/grayscale.replayevaluated in 1.24ms: executed [gray+source, blocks], reused 0 -> gray.pngexamples/grayscale/tests/grayscale.replay: ok (1 frames, 5 checks)Run the test suite (optional)
Section titled “Run the test suite (optional)”cargo build --workspacecargo test --workspaceThe 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).
- Your first project:
entelechy newwrites one that runs.

