Install
paludarium is published as crates on crates.io and as a package on npm.
| You want | Install |
|---|---|
| the command | cargo install paludarium |
| the Rust library | cargo add paludarium |
| the browser or Node.js | npm install @aletheia-works/paludarium-wasm |
Rust
paludarium is built and tested with a pinned nightly Rust (the one in rust-toolchain.toml, moved to the latest nightly every week). The crates declare 1.101 as their MSRV (the oldest Rust they support), so today's stable Rust cannot build them; use a nightly Rust.
rustup toolchain install nightly
cargo +nightly install paludariumpaludarium runs statically linked x86-64 Linux executables (ET_EXEC and static-pie). Linking statically with musl produces them:
rustup target add x86_64-unknown-linux-musl
cargo build --release --target x86_64-unknown-linux-musl
paludarium target/x86_64-unknown-linux-musl/release/helloJavaScript
npm install @aletheia-works/paludarium-wasmThe package holds paludarium.wasm, the launcher and its Workers, and the TypeScript types. In the browser, the page must be cross-origin isolated; see JavaScript and the browser.
Build from source
git clone https://github.com/aletheia-works/paludarium.git
cd paludarium
cargo build --release --locked # the paludarium command
mise run wasm:build # paludarium.wasm of the npm packagerustup installs the nightly pinned in rust-toolchain.toml automatically. mise run needs mise; mise tasks lists every task.