Getting Started
Get up and running with BlockAssist and start training your own model.
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), Linux (Ubuntu 22.04+), macOS (Intel and Apple Silicon), and remote Linux desktops.
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.
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.
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.
Installation Flow
Every installation follows the same general flow, regardless of platform.
Choose and complete the correct installation guide for your platform.
Run BlockAssist from your terminal.
Log in when prompted:
Paste your Hugging Face Write-access token.
Authenticate through the Gensyn Testnet browser window.
Play and record your in-game building session.
Wait for the model to train and upload automatically to Hugging Face and the Gensyn Testnet.
Cursor Setup (Optional)
For users who prefer a more guided setup experience, BlockAssist can also be configured through Cursor AI, 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:
Running BlockAssist: Instructions for launching and training.
Hugging Face Guide: Generate and manage your API token for uploads.
Last updated