# Getting Started

{% embed url="<https://github.com/gensyn-ai/blockassist>" %}

{% hint style="warning" %}
BlockAssist has been sunset. Please see the [home page](https://docs.gensyn.ai/testnet/blockassist) for more information.
{% endhint %}

## Overview

This page helps you prepare your system and choose the correct installation path for BlockAssist. It provides a readiness checklist, supported platforms, and an overview of the setup process before you begin installing and running BlockAssist on your device.

#### Before You Begin

BlockAssist is available across several environments: [Windows (via WSL 2)](https://docs.gensyn.ai/testnet/blockassist/getting-started/windows-wsl-2), [Linux (Ubuntu 22.04+)](https://docs.gensyn.ai/testnet/blockassist/getting-started/linux), [macOS (Intel and Apple Silicon)](https://docs.gensyn.ai/testnet/blockassist/getting-started/macos), and [remote Linux desktops.](https://docs.gensyn.ai/testnet/blockassist/getting-started/linux/running-blockassist-on-a-remote-linux-desktop)

Before you start, make sure you meet the basic requirements and have the necessary accounts.

### System Requirements

* 12 GB RAM minimum (32 GB recommended)
* Stable internet connection
* At least 10 GB of available storage (for overhead)
* Modern multi-core CPU (Intel, AMD, or Apple Silicon)

#### Accounts & Access

* **Hugging Face account:** You’ll need a Write-access API token to upload your model after training. See the Hugging Face Guide for instructions.
* **Gensyn Testnet account:** Automatically created when you first log in through your browser during setup.

#### Software Requirements (All Platforms)

* Python 3.10.x
* Java 1.8.0\_152 (OpenJDK 8)
* Git
* Internet access for dependency installation and authentication

### Supported Platforms & Installation Paths

BlockAssist runs on multiple environments. Choose the guide that matches your operating system or setup.

<table data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><a href="getting-started/windows-wsl-2">Windows (WSL 2)</a></td><td>Run BlockAssist on Windows 10 or 11 using Windows Subsystem for Linux 2 (WSL). This setup requires an X Server such as VcXsrv to render the Minecraft environment.</td><td></td><td><a href="getting-started/windows-wsl-2">windows-wsl-2</a></td></tr><tr><td align="center"><a href="getting-started/linux">Linux (Ubuntu 22.04+)</a></td><td>Install BlockAssist natively on Ubuntu or a compatible distribution for the most stable experience.</td><td></td><td><a href="getting-started/linux">linux</a></td></tr><tr><td align="center"><a href="getting-started/macos">macOS (Intel &#x26; Apple Silicon)</a></td><td>Install and run BlockAssist on macOS using Homebrew for dependency management. Both Intel and M-series processors are supported.</td><td></td><td><a href="getting-started/macos">macos</a></td></tr></tbody></table>

{% hint style="success" %}
All platform installations share a few core dependencies. These are handled within each platform’s guide, but if you encounter dependency issues, consult your specific platform’s **Troubleshooting** section.
{% endhint %}

### Installation Flow

Every installation follows the same general flow, regardless of platform.

1. Choose and complete the correct installation guide for your platform.
2. Run BlockAssist from your terminal.
3. Log in when prompted:
   * Paste your Hugging Face Write-access token.
   * Authenticate through the Gensyn Testnet browser window.
4. Play and record your in-game building session.
5. Wait for the model to train and upload automatically to Hugging Face and the Gensyn Testnet.

{% hint style="info" %}
This sequence is similar on all platforms, with commands and dependencies varying by operating system.
{% endhint %}

***

#### Cursor Setup (Optional)

For users who prefer a more guided setup experience, [BlockAssist can also be configured through Cursor AI](https://docs.gensyn.ai/testnet/blockassist/using-blockassist/running-blockassist-with-cursor), an intelligent code editor that walks you through installation steps interactively. This method is platform-agnostic but still requires that dependencies and environment setup steps are completed.

#### Additional Resources

After you've successfully installed BlockAssist on your system, continue with:&#x20;

* [Running BlockAssist](https://docs.gensyn.ai/testnet/blockassist/using-blockassist): Instructions for launching and training.
* [Hugging Face Guide](https://docs.gensyn.ai/testnet/blockassist/hugging-face-guide): Generate and manage your API token for uploads.
