Getting Started

Getting Started

Once the mod is installed, getting going takes about a minute.

In a hurry? See the Quick Start page for the shortest path to a working companion.

First time? On your first join, Blockpal greets you and opens a short in-game tutorial. The full in-game wiki is reachable from the tutorial's Open Wiki button or from /ai panel → Settings → Identity tab. Reopen the tutorial with /ai tutorial.

1. Summon your assistant

In-game, run:

/ai summon

A companion named Ethan spawns next to you with a nametag. Rename it any time with /ai name <name>.

2. (Optional) Add an AI token

Quick commands (come, follow, stay…) work out of the box — and so do AI-planned tasks: with no token set, Blockpal uses a free built-in AI service so your companion can think from the first minute. Adding a token switches it to a faster, higher-quality model; Blockpal uses HuggingFace's router (OpenAI-compatible) by default.

1. Create a free token at https://huggingface.co/settings/tokens.
2. Open the panel with /ai menu → AI & API tab → paste it into the API token field → Save. (Server owners can instead set the BLOCKPAL_API_TOKEN environment variable so it never touches disk.)

Prefer everyone to use their own key? Each player can set theirs in /ai mymenu (or /ai mykey <token>) — see Per-Player Keys & Models. Your token persists in config/blockpal/config.json (obfuscated) and survives updates.

3. Try it out

Try typing in chat	What happens
follow me	Follows you (instant, no token)
Ethan, build a 5×5 floor	Sends the task to the AI planner
can you clear these trees?	Active analysis figures out you want them mined

See Talking to Your Assistant for the full chat system, or Commands for the slash-command reference.

Using a different model or provider

Point it at any OpenAI-compatible endpoint (Ollama, LM Studio, OpenAI…) from the panel's AI tab — set the API URL and Model fields, then Save (e.g. URL http://localhost:11434/v1/chat/completions).

More in Settings.