Coder Social home page Coder Social logo

creeperg16 / serenity Goto Github PK

View Code? Open in Web Editor NEW

This project forked from serenityjs/serenity

0.0 0.0 0.0 6.19 MB

A Minecraft Bedrock Edition Server Software

Home Page: https://discord.gg/jUcC3q59zg

JavaScript 3.15% Rust 5.40% TypeScript 90.14% Handlebars 1.31%

serenity's Introduction


Logo

Minecraft Bedrock Edition Server Software

Explore Now »

Report Bug

discord License License

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 gameplay experiences, without worrying about the underlying network and protocol details. As Serenity is still in a early version of development, it is recommended not to use Serenity for any offical purposes, as the code structure of the api will be rapidly changing, and may cause plugins to break without notice.

Getting Started

Prerequisites

Before installing Serenity you first need to make sure you have the lastest recommended version of Node.js installed on your machine. Once installed, it is recommened 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

Clone or download a local copy of the Serenity repository to a perferred area on your machine. You can then open the Serenity folder in your perferred integrated development environment. You will now need to run a few terminal commands before starting.

  • First you will need to initialize the folder using Yarn. Copy and run the command yarn install, follow any steps that may appear on screen.

  • Next you are now ready to build the project, since the project is coded in TypeScript, it will first need to be compiled to JavaScript before running. To do this, run the command yarn build, this command will then compile the project into JavaScript.

  • Finally you are now ready to start the Serenity server. To do this run the command yarn dev, you should then see the server starting in the console.

serenity's People

Contributors

anybananagame avatar conmaster2112 avatar creeperg16 avatar dkmtomy avatar nobu-sh avatar pmk744 avatar skyderg avatar th3ang3lo avatar

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.