Skip to main content

Prerequisites

Before you begin developing for Regions Unexplored, ensure you have the following installed:

Java Development Kit

JDK 21 or higher is required for Minecraft 1.21.1 development

Gradle

Gradle is used for building the project (wrapper included)

Git

For version control and cloning the repository

IDE

IntelliJ IDEA (recommended) or Eclipse with Gradle support

Clone the repository

Start by cloning the Regions Unexplored repository:
git clone https://github.com/UHQ-GAMES-MODS/RegionsUnexplored.git
cd RegionsUnexplored

Initial setup

1

Configure Gradle memory

The project is configured to use 4GB of RAM for Gradle. This is set in gradle.properties:
org.gradle.jvmargs=-Xmx4G
org.gradle.parallel=true
If you experience build issues, you may need to increase this value depending on your system.
2

Generate IDE files

Open the project directory in IntelliJ IDEA. The IDE will automatically detect the Gradle project and import it.Alternatively, use:
./gradlew idea
3

Setup development workspace

Generate the Minecraft development environment:
./gradlew :fabric:21.1:runClient
This command will:
  • Download Minecraft assets
  • Apply mappings and decompile Minecraft
  • Set up the mod development environment
  • Launch the Minecraft client with Regions Unexplored loaded
The first run may take several minutes as it downloads and processes Minecraft.
4

Verify the setup

Once the Minecraft client launches:
  1. Check that “Regions Unexplored” appears in the mods list
  2. Create a new world and verify custom biomes generate
  3. Check the console for any errors or warnings

Development workflow

Running the game

Launch the Minecraft client for testing:
./gradlew :fabric:21.1:runClient

Hot reloading

For faster development iteration:
  1. Make code changes in your IDE
  2. Use your IDE’s “Build” or “Make” feature (Ctrl+F9 in IntelliJ)
  3. The running game will hot-reload changed classes automatically
Not all changes support hot-reload. Registry changes, mixins, and some initialization code require a full restart.

Project configuration

The mod uses the Cloche multi-loader build system. Key configuration files:
Main build configuration defining:
  • Mod metadata (name, version, authors)
  • Dependencies (Biolith, Lithostitched)
  • Loader-specific configurations
  • Repository URLs
Build performance settings:
  • JVM memory allocation (4GB)
  • Parallel build execution
  • Kotlin code style
Project name and plugin repository configuration for Cloche build system

Dependencies

Regions Unexplored requires these mods as dependencies:

Biolith

Required - Biome library for multi-loader worldgenVersion: 3.0.10

Lithostitched

Required - Cave biome generation libraryVersion: 1.5.7

Fabric API

Fabric only - Core Fabric modding APIVersion: 0.116.8

Mod Menu

Fabric only - Mod configuration menuVersion: 11.0.3

Next steps

Project structure

Learn about the codebase organization and architecture

Building the mod

Build and package the mod for distribution

Build docs developers (and LLMs) love