!JSPrismarine
JSPrismarine is a dedicated Minecraft Bedrock Edition server written in TypeScript. It focuses on performance, extensibility, and ease-of-use. It is not affiliated with the official server software from Mojang AB.
Why use JSPrismarine?
- Written in TypeScript.
- Open source with the permissive MPL2 license.
- Under active development.
Getting started
You can find the documentation over at jsprismarine.github.io/JSPrismarine.
Prebuilt binaries will be provided once a stable release is available. For now, you can follow the steps below or download the latest nightly (which may or may not work before reaching v1.0.0).
Requirements: Linux/MacOS/Unix-based OS or a modern Windows (WSL2 is recommended), Node.js v21+ and pnpm.
Enable (or install) corepack.
corepack enable
Clone the repository. The --recurse-submodules flag is required!
git clone --recurse-submodules https://github.com/JSPrismarine/JSPrismarine.git
cd JSPrismarine
Install dependencies and build the project.
pnpm install
pnpm run build
Run the server (use pnpm run dev for development).
pnpm run start
[!NOTE]
Already cloned without--recurse-submodules? Rungit submodule update --init --recursive. Thebedrock-dataresources submodule is required to build.
FAQ
- Can I contribute?
- Is JSPrismarine for
Minecraft: Bedrock EditionorMinecraft: Java Edition?
Minecraft: Bedrock Edition.
- What devices can a player join JSPrismarine with?
- Which OSes can run JSPrismarine?
- If my question isn't listed here, where should I ask?
- Why can't I join a JSPrismarine instance hosted on my Windows PC?
CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftUWP_8wekyb3d8bbwe".
- Open Minecraft and add a server with the IP 127.0.0.1.
- > NOTE: This may not work reliably on WSL2 while using the experimental bridge.
Documentation
Remarks
- JSPrismarine is still in early/active development, and no stable versions have been released yet.