Repository Directory
Back to directory
JSPrismarine avatar

JSPrismarine

Dedicated Minecraft Bedrock Edition server written in TypeScript.. Read more below about its uses, features, and usage.

View on GitHub Visit website

Clone repository

git clone https://github.com/JSPrismarine/JSPrismarine.git

313

Stars

44

Forks

6

Watchers

MPL-2.0

License

README

Read full README on GitHub →

JSPrismarine

License Join the Discord Server Contributors npm Code Coverage TODOs Counter FIXMEs Counter GitHub Commit Activity

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, making it easy to use and develop plugins for. You can develop plugins in any language that transpiles into JavaScript, such as TypeScript, Kotlin, CoffeeScript, asm.js, and more.
  • 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? Run git submodule update --init --recursive. The bedrock-data resources submodule is required to build.

FAQ

  • Can I contribute?
  • Is JSPrismarine for Minecraft: Bedrock Edition or Minecraft: Java Edition?
    • JSPrismarine is made for Minecraft: Bedrock Edition, but there may potentially be plugins available to provide a Minecraft: Java Edition protocol implementation.
  • What devices can a player join JSPrismarine with?
    • By default, PC/Windows, Android, and iOS. With some tricks, you can also join with Xbox, Switch, and even PlayStation consoles.
  • Which OSes can run JSPrismarine?
    • Any platform supporting a somewhat recent version of Node.js.
  • If my question isn't listed here, where should I ask?
  • Why can't I join a JSPrismarine instance hosted on my Windows PC?
    • To join an instance of JSPrismarine hosted on the same Windows machine, you need to enable Loopback. Here are the steps:
      • Open Windows PowerShell as administrator.
      • Run this command: 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.