Giter Club home page Giter Club logo

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.org/docs.

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).

  • Linux/MacOS/Unix-based OS or a modern Windows (WSL2 is recommended)
    • You need Node.js v21+ and pnpm.
    • Clone the repository: git clone https://github.com/JSPrismarine/JSPrismarine.git.
    • Go to the cloned repository: cd JSPrismarine.
    • Install dependencies: pnpm install.
    • Build the project: pnpm run build.
    • Run the server: pnpm run start (or pnpm run dev for development).

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.

JSPrismarine's Projects

JSPrismarine doesnโ€™t have any public repositories yet.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.