Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JSPrismarine/JSPrismarine

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

javascript mcbe mcpe mcpe-server minecraft minecraft-bedrock minecraft-bedrock-edition minecraft-pocket-edition minecraft-server node npm npm-package server typescript

Last synced: about 2 months ago
JSON representation

Dedicated Minecraft Bedrock Edition server written in TypeScript.

Host: GitHub
URL: https://github.com/JSPrismarine/JSPrismarine
Owner: JSPrismarine
License: mpl-2.0
Created: 2020-07-01T09:46:15.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-05-01T10:46:34.000Z (5 months ago)
Last Synced: 2024-05-01T11:23:08.818Z (5 months ago)
Topics: javascript, mcbe, mcpe, mcpe-server, minecraft, minecraft-bedrock, minecraft-bedrock-edition, minecraft-pocket-edition, minecraft-server, node, npm, npm-package, server, typescript
Language: TypeScript
Homepage: https://jsprismarine.org
Size: 631 MB
Stars: 254
Watchers: 8
Forks: 42
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-minecraft-bedrock - JSPrismarine - Basic Minecraft Bedrock Edition software. (Server)

README

        # [![JSPrismarine](https://github.com/JSPrismarine/JSPrismarine/assets/108444335/3169ac83-0427-402d-a76d-6c1bc215c583)](https://jsprismarine.org/)

[![License](https://img.shields.io/github/license/JSPrismarine/JSPrismarine)](https://github.com/JSPrismarine/JSPrismarine/blob/master/LICENSE)

[![Join the Discord Server](https://img.shields.io/discord/704967868885762108?color=%237289DA&label=Discord)](https://discord.gg/6w8JWhy)

[![Contributors](https://img.shields.io/github/contributors/JSPrismarine/JSPrismarine?color=%23E30B5D)](https://github.com/JSPrismarine/JSPrismarine/graphs/contributors)

[![npm](https://img.shields.io/npm/dt/@jsprismarine/prismarine)](https://www.npmjs.com/package/@jsprismarine/prismarine)

[![Code Coverage](https://img.shields.io/codecov/c/github/JSPrismarine/JSPrismarine?token=WLXLSJOGN3&color=63A375)](https://codecov.io/gh/JSPrismarine/JSPrismarine)

[![TODOs Counter](https://img.shields.io/github/search/JSPrismarine/JSPrismarine/todo)](https://github.com/JSPrismarine/JSPrismarine/search?q=todo)

[![FIXMEs Counter](https://img.shields.io/github/search/JSPrismarine/JSPrismarine/fixme)](https://github.com/JSPrismarine/JSPrismarine/search?q=fixme)

[![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/JSPrismarine/JSPrismarine?color=%2387F4BC)](https://github.com/JSPrismarine/JSPrismarine/commits/master)

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](https://github.com/JSPrismarine/JSPrismarine/blob/master/LICENSE) license.

- Under active development.

## Getting started

**[You can find the documentation over at jsprismarine.org/docs](https://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](https://github.com/JSPrismarine/JSPrismarine/actions/workflows/nightly.yml?query=branch%3Amaster) (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](https://nodejs.org) v21+ and [pnpm](https://pnpm.io).

  - 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?

  - Sure, make sure to read the [CONTRIBUTING.md](https://github.com/JSPrismarine/JSPrismarine/blob/master/CONTRIBUTING.md) file first.

- 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?

  - You can join the [Discord server](https://discord.gg/fGkHZhu), or open a [GitHub issue](https://github.com/JSPrismarine/JSPrismarine/issues/new) 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

- [jsprismarine.org/docs](https://jsprismarine.org/docs/).

- [Running JSPrismarine](./docs/running.md).

## Remarks

- JSPrismarine is still in early/active development, and no stable versions have been released yet.