Possible issues during setup

This page contains the possible issues that can come up while spinning up the project, also containing their resolution.

Cargo command is missing

Error message:

== Compilation error in file lib/game/utils/namigator.ex ==
** (ErlangError) Erlang error: :enoent
    (elixir 1.17.3) lib/system.ex:1114: System.cmd("cargo", ["metadata", "--format-version=1"], [cd: "native/namigator"])
    (rustler 0.35.1) lib/rustler/compiler/config.ex:76: Rustler.Compiler.Config.metadata!/1
    (rustler 0.35.1) lib/rustler/compiler/config.ex:63: Rustler.Compiler.Config.build/1
    (rustler 0.35.1) lib/rustler/compiler.ex:8: Rustler.Compiler.compile_crate/3
    lib/game/utils/namigator.ex:2: (module)

Reason:

The cargo commmand (build system and package manager for Rust) is missing.

Resolution:

Install Rust, which will include the cargo command as well.

Install guide on official Rust site: https://doc.rust-lang.org/cargo/getting-started/installation.html

C compiler is missing

Error message:

error: linker `cc` not found
  |
  = note: No such file or directory (os error 2)

error: could not compile `proc-macro2` (build script) due to 1 previous error
warning: build failed, waiting for other jobs to finish...
error: could not compile `libc` (build script) due to 1 previous error

== Compilation error in file lib/game/utils/namigator.ex ==
** (RuntimeError) Rust NIF compile error (rustc exit code 101)
    (rustler 0.35.1) lib/rustler/compiler.ex:36: Rustler.Compiler.compile_crate/3
    lib/game/utils/namigator.ex:2: (module)

Reason:

The C compiler is missing.

Resolution:

Install build-essential package, which will include the C compiler as well.

Example command for Linux:

sudo apt-get update
sudo apt install build-essential