Box3JSJS/TS Scripting Engine for Minecraft

Build custom gameplay, mini-games, and UIs — no JDK, no Java compilation required.

🎮

Server & Client Scripting

Server-side world manipulation, entities, recipes. Client-side keyboard input, screen UI, sounds, SQLite storage, and HTTP requests.

📦

TypeScript First

Full DTS type definitions for all 17 global objects. Built-in esbuild + Babel pipeline transpiles modern TS to Rhino-compatible ES5.

🔄

Hot Reload

Edit scripts and see changes instantly without restarting the server. File watcher auto-reloads on save.

🌐

Bidirectional Communication

remoteChannel enables server↔client event messaging. Server broadcasts to all players; clients reply independently.

🗄️

Dual-Side Storage & Database

JSON file persistence and SQLite on both server and client. Pagination, atomic updates, counters, and tagged-template queries.

🧩

Custom Blocks & Items

Block textures, item models, equipment, sounds, and creative tabs — all registered from JSON configs (standalone/JAR mode).

📚

Comprehensive Docs

50+ pages across API reference, progressive tutorials, cookbook recipes, architecture deep-dive, and FAQ — in Chinese and English.

🚀

Standalone JAR Mode

Compile your script project into a self-contained JAR mod. No runtime dependency on Box3JS — just drop it in your mods folder.

Quick Start

bash

# In-game: create a new project
/box3script create mygame

# Build and watch
cd config/box3/script/mygame
npm install
npm run build -- --watch

# TypeScript type checking
npm run check

// src/server/app.ts — your first script
world.onChat((entity, message) => {
  if (message === "!hello") {
    entity.player.directMessage(`Hello, ${entity.player.name}!`);
    return false;
  }
  return true;
});

Read full docs →

Version Info

Component	Version
Minecraft	1.21.1
Mod Loader	NeoForge
Java	21
JS Engine	Mozilla Rhino 1.9.1 (ES5)
TypeScript	via Babel → ES5