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:Initial setup
Configure Gradle memory
The project is configured to use 4GB of RAM for Gradle. This is set in
gradle.properties:Generate IDE files
- IntelliJ IDEA
- Eclipse
- Visual Studio Code
Open the project directory in IntelliJ IDEA. The IDE will automatically detect the Gradle project and import it.Alternatively, use:
Setup development workspace
Generate the Minecraft development environment: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.
Development workflow
Running the game
- Client
- Server
- Data Generation
Launch the Minecraft client for testing:
Hot reloading
For faster development iteration:- Make code changes in your IDE
- Use your IDE’s “Build” or “Make” feature (Ctrl+F9 in IntelliJ)
- The running game will hot-reload changed classes automatically
Project configuration
The mod uses the Cloche multi-loader build system. Key configuration files:build.gradle.kts
build.gradle.kts
Main build configuration defining:
- Mod metadata (name, version, authors)
- Dependencies (Biolith, Lithostitched)
- Loader-specific configurations
- Repository URLs
gradle.properties
gradle.properties
Build performance settings:
- JVM memory allocation (4GB)
- Parallel build execution
- Kotlin code style
settings.gradle.kts
settings.gradle.kts
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