Building INOX code

How to download INOX repository

You can clone it using https://github.com/gents83/INOX.git

Or you can download the zip from here

How to build and run INOX code

Once that you've cloned and downloaded the repository, you can build it by running the following commands:

git submodule update --init --recursive

The above command is needed to download all extern submodules and could require some time.

cargo build --manifest-path ./crates/Cargo.toml

The above command build the project in debug but you can switch to release adding --release at the end.

cargo run --manifest-path ./crates/Cargo.toml -- -plugin inox_viewer

The above command run the inox_launcher executable with the inox_viewer plugin.
Please provided needed command line parameters, like the -file_to_load 'path'
See the section Command line parameters accepted by inox_launcher

How to use Microsoft VSCode launch and tasks created for INOX on Windows

If you are using Microsoft VSCode on Windows you can benefits of several shortcuts to build and execute INOX code.

Using the SABI.code-workspace file will allow you to get even raccomandation on useful extensions to maximise the VSCode experience.

Let's see some useful shortcuts.

  • When building or pressing CTRL+SHIFT+B:
    You'll have many debug possibilities as:

    • BUILD DEBUG - Build workspace in debug
    • BUILD RELEASE WASM - Build workspace in release with wasm as target
    • BUILD RELEASE - Build workspace in release
    • BUILD BOOK - Build and launch a rendered version of documentation in /docs/ folder
    • RUN CLIPPY - Execute clippy fix on crates code and check if there are any errors
    • CHECK CRATES DEPENDENCIES - Check crates dependencies detecting and warning on unused ones.

  • When debugging or pressing F5:
    You'll have many debug possibilities as:

    • RUN LAUNCHER DEBUG - Run the launcher in debug mode
    • RUN LAUNCHER RELEASE - Run the launcher in release mode
    • RUN VIEWER RELEASE - Run the viewer with a test scene (customizable in /.vscode/launch.json)

Command line parameters accepted by inox_launcher

  • -plugin [name]:
    The plugin to use.
    You can specify names of crates inside apps folder like inox_viewer, inox_editor, etc
    When not specified an empty window will be opened with only the binarizer executing in background.

  • -load_file [path]:
    A path of a scene to load with path relative to /data/
    As example could be ./data/blender_export/TestScene/TestScene.scene_data

How to setup your marchine for Android platform

Install AndroidSDK and NDK and setup environment variables (ANDROID_SDK_ROOT and ANDROID_NDK_ROOT). Going through Android Studio could be an easy win solution - just remember to go into SDK Manager and install then the Android NDK.
(https://mozilla.github.io/firefox-browser-architecture/experiments/2017-09-21-rust-on-android.html)

Install cargo-apk with cargo install cargo-apk.

Add desired android targets with rustup target add <triple>.

Run cargo apk run -p android-build optionally with the flag --target <triple> for explicit target selection.

How to setup your marchine for Web platform

Install wasm bindgen with cargo install -f wasm-bindgen-cli Add wasm target with rustup target add wasm32-unknown-unknown

Use Google Chrome Canary and enable Unsafe WebGPU in chrome://flags/