Documentation

For launcher 1.1.0 · mod 1.2.0 · updated July 2026

Install Veltrix

1. Grab the installer from the download page and run it.
2. Pick an install folder (the default needs no admin rights) and hit Install.
3. Launch Veltrix from the desktop or Start Menu shortcut.

Sign in

Open Accounts in the sidebar and click Add account. Veltrix uses Microsoft's official device-code flow: you get a short code, approve it at microsoft.com/link, and you're in. You can add several accounts and switch instantly — tokens are encrypted on your machine and never leave it.

Browsing versions, skins and mods works without signing in; launching the game requires an account that owns Minecraft: Java Edition.

Install a version & play

1. Open Versions. Search or filter — releases, snapshots, betas, alphas, everything up to 26.1.x is there.
2. Click Install. Libraries, natives and assets download in parallel with SHA-1 verification.
3. The version gets selected automatically and — new in 1.1 — its own empty mod section is created for it.
4. Hit the big Launch button on Home. If the right Java isn't on your PC, Veltrix downloads a matching Temurin runtime silently (26.1.x needs Java 25 — handled).

Mods & profiles

Every version you install has its own mod profile (section). On the Mods page you can:

• Install the Veltrix Client Mod — one click, no Fabric API needed. Works on 1.21.3–1.21.5 and every 26.1.x release.
• Search Modrinth and install mods matched to your game version.
• Apply the FPS pack — Sodium, Lithium, FerriteCore, Entity Culling, ImmediatelyFast, Dynamic FPS, ModernFix, Krypton — with individual toggles.
• Drag-and-drop .jar files, disable mods without deleting them, duplicate whole profiles.

When you launch, Veltrix quietly sets up Fabric Loader for the profile — vanilla stays untouched if a profile has no enabled mods.

Skins

The Skins page keeps a library with rotating 3D previews (drag to spin). Upload PNGs, mark them classic or slim, apply with one click through the official API. The underrated trick: type any player's name and Veltrix grabs their current skin into your library.

In-game menu

Press Right Shift in game (rebindable in the config). The menu is built like Feather's:

• Search bar — type to filter all 25 modules by name or description.
• One row per module — item icon, name, green/grey state dot. Click to toggle.
• ⚙ cog on every row — opens that module's settings (see module settings).
• Bottom bar: Cosmetics, Edit HUD Layout, Reload Scripts, Done.

Everything you toggle is saved to config/veltrix/config.json instantly.

HUD editor

Right Shift → Edit HUD Layout. The world stays fully visible — no blur, no dark overlay — so you see exactly what you'll get:

• Drag any module card anywhere on screen. Positions are stored as screen fractions, so they survive resolution changes.
• Scroll over a module to scale it from 0.5× to 2.5×.
• Esc saves and exits.

Cosmetics

Six capes (Crimson V, Ember, Void, Galaxy, Carbon, Royal) and four hats (Crown, Beanie, Visor, Flames). Two places to equip them, one source of truth:

• In the launcher — the Cosmetics page shows them live on your actual skin in 3D.
• In game — Right Shift → Cosmetics, click to equip, click again to remove.

Both write the same file, and both watch it: equip a cape in the launcher while playing and it appears on you in game within a couple of seconds — and the other way round. Cosmetics are client-side flair on your own player, like other clients' free tiers.

Minimap

Enable Minimap in the menu. It renders the terrain around you from real map colors with height shading — the same palette vanilla maps use — locked north-up with an N marker.

• Your cursor is a rotating arrow that points where you look.
• White squares are players, red dots hostile mobs, green dots animals — both toggleable.
• The cog sets view range (32–128 blocks) and map size (80–176 px).

Module settings

Every module's cog opens a settings screen with an enable toggle and a scale slider, plus module-specific options:

Module builder — your first script

The mod embeds a sandboxed JavaScript engine (Rhino, ES6). Scripts live in config/veltrix/scripts/ inside the game folder — three commented samples (welcome.js, dayinfo.js, commands.js) are created on first run so you always have something to copy from.

// hello.js — a custom HUD card + a chat command
veltrix.hud("Hello", function () {
    return ["Hi " + veltrix.getName(), veltrix.getFps() + " fps"];
});

veltrix.command("hello", function (args) {
    veltrix.chat("Hello from my own Veltrix feature!");
});

Save the file, press Right Shift → Reload Scripts. A new HUD card appears — drag it anywhere in the HUD editor — and typing .hello in chat runs your command locally. No compiler, no game restart.

API reference — the veltrix object

Registration

Output

Info getters

getX() getY() getZ() (doubles) · getYaw() · getHealth() · getFps() · getPing() · getName() · getBiome() · getHeldItem() · getTimeOfDay() (world ticks, 24000 = one day) · isSprinting()

Sandbox rules

• Scripts run in interpreted, sandboxed Rhino: no file access, no network, no Java classes — only the veltrix API.
• A script that throws is disabled until the next reload, with the error shown in chat. It can never crash the game.
• All callbacks run on the game thread — keep per-frame HUD functions light (results are cached for 50 ms anyway).

Examples

Low-health warning

var warned = false;
veltrix.on("tick", function () {
    if (veltrix.getHealth() > 0 && veltrix.getHealth() <= 6 && !warned) {
        veltrix.chat("§c♥ LOW HEALTH!");
        warned = true;
    }
    if (veltrix.getHealth() > 10) warned = false;
});

Mention ping

veltrix.on("chat", function (message) {
    if (message.indexOf(veltrix.getName()) !== -1 && message.indexOf("<") === 0)
        veltrix.chat("§e^ someone mentioned you");
});

Custom speedometer

var lastX = 0, lastZ = 0, speed = 0;
veltrix.on("tick", function () {
    var dx = veltrix.getX() - lastX, dz = veltrix.getZ() - lastZ;
    speed = Math.sqrt(dx * dx + dz * dz) * 20;
    lastX = veltrix.getX(); lastZ = veltrix.getZ();
});
veltrix.hud("Speed", function () {
    return speed.toFixed(1) + " b/s";
});

Troubleshooting