Building From Source

Building from Source

Important

This repository is intended for development and contributions only. Please read the project's license before redistributing or publishing modified versions of Lavendre.

Requirements

Before you begin, install the following requirements:

• Temurin® JDK 21
• Git
• Pakku
• Modrinth
• IntelliJ IDEA (recommended)

Optional:

Installing wget

wget is only required if you want to download the required resource packs from the command line. Otherwise, you can download them through the in-game prompt.

Windows

Using Winget (recommended):

winget install GNU.Wget2

Or, if you use Scoop:

scoop install wget

macOS

Using Homebrew:

brew install wget

Linux

Debian / Ubuntu

sudo apt install wget

Fedora

sudo dnf install wget

Arch Linux

sudo pacman -S wget

Prepare the Modrinth Instance

This is where your local clone will live. You can use another launcher if you prefer, but Modrinth is recommended.

1. Create a new Custom instance in Modrinth.
   • Name: [PAKKU] Lavendre (or anything you like)
   • Mod Loader: Fabric
   • Minecraft Version: 1.21.1
   • Loader Version: 0.19.3
2. Open the instance folder.
3. Delete everything inside the instance folder.

Clone the Repository

Clone the repository directly into the empty instance folder.

git clone https://github.com/aerhazu/Lavendre.git .

Note

The trailing . clones the repository into the current folder instead of creating a new Lavendre folder.

Switch to a Version Branch

Important

Do not use the master branch for development. The master branch is reserved for documentation, assets, and other repository files. Always switch to a version branch you want to work on (for example, 1.0.0) before continuing.

To see all available branches:

git branch -r

Then switch to the version you want to work on:

git switch 1.0.0

Replace 1.0.0 with the appropriate development branch if you're working on a different version.

Initialize Pakku

Before fetching the modpack, copy the contents of:

.pakku/client-overrides/config

into the root config folder of your instance.

After that, download all managed files (mods, resource packs, shaders, etc.):

pakku fetch

(Optional) Install Required Resource Packs

If you installed wget earlier, you can automatically download the required Mizuno's resource packs:

wget -O "resourcepacks/Mizunos 16 Craft JE_1.20.4-1.0_230105.zip" "https://raw.githubusercontent.com/aerhazu/CIT-Repository/main/minecraft/ResourcePack/Mizunos%2016%20Craft%20JE_1.20.4-1.0_230105.zip"
wget -O "resourcepacks/Mizunos 16 Craft JE CIT_1.21.1-1.1_170726.zip" "https://raw.githubusercontent.com/aerhazu/CIT-Repository/main/minecraft/CITs/Mizunos%2016%20Craft%20JE%20CIT_1.21.1-1.1_170726.zip"

If you don't have wget, don't worry—you can download both packs from the in-game prompt the first time you launch the instance.

Launch the Game

Start the Modrinth instance as usual. If this is your first launch, Minecraft will generate any remaining configuration files and prompt you to download any missing optional resource packs.

---

Next: Directory Structure — learn how the .pakku folder is organized.