Skip to main content

Environment Setup

This guide will walk you through the process of setting up your development environment for FinalBiome. It will show you how to build and run a FinalBiome node, which is a prerequisite for most tutorials and how-to guides. Once the node is up and running, you will be able to connect to it either through the developer portal or directly from the game engine.

Prerequisites​

Before you start, make sure you meet the following prerequisites:

  • An active internet connection and access to an interactive shell terminal on your local computer.
  • A basic understanding of software development and comfort using command-line interfaces.
  • The Rust compiler and toolchain installed on your system.

To check if Rust is installed, run the rustup show command. If Rust is installed, this command will display version information for the toolchain and compiler. If it's not, the command will not return any output. For more information on installing Rust, refer to the Rust Installation Guide.

Building the Node​

The steps for building the node template are as follows:

  1. Clone the node template repository:

    git clone <https://github.com/finalbiome/finalbiome-node>

    This command clones the main branch of the repository.

    If you wish to specify a particular version of FinalBiome for compatibility, you can use the --branch option and a tag of your choice.

  2. Navigate to the root of the cloned directory:

    cd finalbiome-node

  3. Compile the FinalBiome node:

    cargo build --package finalbiome-node --release

    The initial compilation of the node might take some time. Once the compilation finishes, you will see a line like this:

    Finished release [optimized] target(s) in 10m 14s

View Node Information​

After building the node, you can check that it is ready for use and explore its command-line options:

  1. Run the following command:

    ./target/release/finalbiome-node --help

    This command lists all the available command-line options. You can use these options to start the node, manage accounts and keys, and modify node operations.

Starting the Node​

You can launch your blockchain with the following steps:

  1. Run the node in development mode:

    ./target/release/finalbiome-node --dev

    Development mode does not require peer computers to finalize blocks. As the node starts, it will display operations in the terminal. If you see messages indicating that blocks are being proposed and finalized, your node is running successfully.

    ... Idle (0 peers), best: #3 (0xcc82…3aa2), finalized #1 ...
    ... Starting consensus session on top of parent ...
    ... Prepared block for proposing at 4 (0 ms) ...

Stopping the Node​

You can stop the node by following these steps:

  1. Locate the terminal that is displaying the blockchain operations.
  2. Use the control-c key combination to stop the local blockchain and clear all state.

Now that you have your environment setup and know how to operate a node, you're ready to dive deeper into the FinalBiome universe.

Happy developing!