Profile
Back to NewsBack
GitHub Trending 2 min
Reader Mode
JSPrismarine/JSPrismarine: Dedicated Minecraft Bedrock Edition server written in TypeScript.

JSPrismarine/JSPrismarine: Dedicated Minecraft Bedrock Edition server written in TypeScript.

4 hours ago

!JSPrismarine

License</a> Join the Discord Server</a> Contributors</a> npm</a> Code Coverage</a> TODOs Counter</a> FIXMEs Counter</a> GitHub Commit Activity</a>

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?

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?
- Sure, make sure to read the CONTRIBUTING.md file first.
  • Is JSPrismarine for Minecraft: Bedrock Edition or Minecraft: Java Edition?
- JSPrismarine is made for Minecraft: Bedrock Edition.
  • 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?
- You can join the Discord server, or open a GitHub issue for development-related questions.
  • 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.
Chat with me