About The Project

Serenity is a robust and flexible Minecraft Bedrock Edition Server Software that was built from the ground up using Rust and TypeScript. Serenity provides a well written set of apis and tools for building Minecraft Bedrock servers, allowing developers to focus on creating unique game-play experiences, without worrying about the underlying network and protocol details. Serenity is in a active state of development, though is now approaching its first stable release. As some vanilla features are missing, we are working as hard as possible to implement these important features.

Getting Started

Prerequisites

Before installing Serenity you first need to make sure you have the latest recommended version of Node.js installed on your machine. Once installed, it is recommended to fully restart your machine to allow for the full Node.js experience to be enabled. You will also need to use an integrated development environment of personal choice. Visual Studio Code is the recommended environment for Serenity development.

Serenity is built off of the foundation of Yarn Workspaces for quick and easy development. Before installing Serenity, you will first need to install Yarn. To do this, please read through the Installation Guide provided by the developers of Yarn.

Serenity has started development on a plugin system. This system allows modification to the Serenity software while providing a full api to completely interact with the server. Check out the sample-plugin to get started.

Installing Serenity

We provide an easy to use CLI installer process. Run the following command of your choice, and follow the install prompts.

#npm
npm create serenity
#yarn
yarn create serenity
#pnpm
pnpm create serenity