# Call of Nil
> [!NOTE]
> Call of Nil is still under development and not yet ready to play.
## Installation
You can download the latest version from our [website](https://nil.dev.br/download) or [GitHub Releases](https://github.com/tsukilabs/nil/releases/latest).
## Building from source
Call of Nil requires a [nightly Rust toolchain](https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust) to compile. You must also set up additional dependencies, such as [Node.js](https://nodejs.org/en/about). A complete list of requirements can be found in the [contributing guide](https://github.com/tsukilabs/nil/blob/main/.github/CONTRIBUTING.md#requirements).
```sh
git clone https://github.com/tsukilabs/nil.git
cd nil
cargo -Zscript scripts/build-client.rs
```
## Library usage
Call of Nil is available as a collection of Rust crates on [crates.io](https://crates.io/keywords/call-of-nil) that you can use to build custom applications. For other programming languages, we also provide precompiled [native libraries](https://nil.dev.br/download#native-libraries) that expose a [C-compatible API](https://github.com/tsukilabs/nil/blob/main/crates/nil-ffi/gen/libnil.h).
For Node.js, we publish autogenerated [TypeScript bindings](https://www.npmjs.com/package/@tsukilabs/nil-bindings) to npm, as well as an experimental [FFI wrapper](https://www.npmjs.com/package/@tsukilabs/nil-ffi) around the native libraries, which currently requires Node.js' [`--experimental-ffi`](https://nodejs.org/api/cli.html#--experimental-ffi) flag.
## License
All source code files are licensed under [AGPL-3.0](https://spdx.org/licenses/AGPL-3.0-only.html) unless explicitly stated otherwise.