Installation & IDE Setup

Download the mod

Download pkl4mc

I probably don’t need to tell you how to install a Minecraft mod.

Start the game once

pkl4mc will create its working directory:

• data/ holds loose .pkl files, with some example files
• datapacks/ holds full .pkl datapacks (folders or zips)
• schemas/ holds bundled schemas, copied out for your editor
• registries/ holds registry id modules made by /pkl dump
• PklProject is the auto-generated editor project config

All important files are in data/, datapacks/, and assets/. ALL other files are just auto-generated and will probably rewrite on restart.

Install the PKL extension

Install the PKL extension for your editor of choice:

• PKL for VS Code
• PKL for Zed
• PKL for Neovim
• PKL for IntelliJ

Patched pkl-lsp (optional)

For now install the patched pkl-lsp, which has way better performance, then the default one. Some day I will make a PR, but for now just install the patched release.

• PKL Langauge Server Protcol

In your editor’s settings change the pkl.lsp.path to the downloaded jar. For more information, look up the PKL documentation

Setup

1. Run the /pkl dump command once in game. The command exports every registry id of your running modpack to config/pkl4mc/registries/, which makes item, tag and fluid ids autocomplete.

2. Open config/pkl4mc/ as your editor workspace root.

3. Re-run /pkl dump after adding or removing mods. A stale dump only affects editor completion. The runtime never validates against it, so it cannot break world loads.

Install the PKL CLI (optional)

Most editor extensions will not need it.

• PKL CLI