Box3JS

English

简体中文

English

简体中文

Appearance

Box3JSTypeScript Scripting Engine for Minecraft

No Java. No Gradle. No restarts. Write TypeScript, hot-reload in seconds.

Get Started
Why Box3JS?
⚡

TypeScript, Zero Java

Full DTS types with bilingual JSDoc for every API. esbuild + Babel pipeline compiles modern TS to ES5 automatically. No JDK, no Gradle, no IDE setup.

🔄

Hot Reload in Seconds

Edit → save → see changes instantly. No server restarts. Built-in file watcher auto-reloads on every save.

🎮

Box3-Compatible API

Same clean API style as Box3 (Shenqi Code Island). World, Entity, Player, Voxels, Storage, Database, HTTP, remoteChannel — all as global objects.

🧩

110+ Minecraft Extensions

Scoreboards, BossBars, teams, world border, particles, fireworks, lightning, potions, custom blocks/items/sounds, and more.

🖥️

Server & Client Scripting

Server handles game logic and world manipulation. Client handles keyboard input, HUD, audio, custom GUIs. Bidirectional events via remoteChannel.

🛡️

Sandbox Protection

Enable sandbox to auto-track all script changes. Disable to fully roll back. Test fearlessly — your map is always safe.

📦

Standalone JAR Distribution

/box3script compile packages your scripts into a standalone mod. Drop it into mods/ — no Box3JS dependency required.

🗄️

Built-in Persistence

JSON file storage and SQLite database on both server and client. Leaderboards, player saves, economies — all built-in.

Quick Start ​

bash
/box3script create mygame       # scaffold a TypeScript project
bash
cd config/box3/script/mygame
npm install && npm run build     # install deps + build
bash
/box3script sandbox mygame       # enable sandbox (recommended)
/box3script start mygame         # start the script

Open src/server/app.ts, write your game logic, save, then /box3script reload mygame. Enable /box3script watch and it auto-reloads on every save.

Full documentation →

Released under the Apache License 2.0.