Giter VIP home page Giter VIP logo

redstone's Introduction

redstone

A distributed, infinite-player Minecraft server that runs on Node.js.

Redstone can support theoretically infinite players in one game world by transparently breaking up the work to multiple servers. Being based on Node.js, it has blazing fast IO performance, which means lower resource consumption and lower latency than standard Java servers.

Status

WARNING: This project is currently considered unstable and experimental, it is not ready for production yet.

Redstone currently only supports creative mode, and is missing much of the game logic. The framework for the clustering of servers is present and functional, but could use some reorganization. This was originally a private project. Since I don't have enough time to spend on it anymore, I am open-sourcing it to allow the community to contribute and progress the code. When I have time, I will document the current architecture to make it easier to figure out what's going on.

Usage

First, make sure you have a MongoDB instance running. By default, Redstone connects to a MongoDB server on localhost, but if neccessary, you can configure the Mongo URI via the database parameter in config.coffee.

Install the dependencies:

npm install

Simple mode (all components in one process)

node bin/redstone.js

Distributed (components running on separate processes or servers)

First, you must run one master component:

node bin/redstone.js -m

Next, you will need to start the other components (servers and connectors). When starting them, you will need to specify the hostname of the master. You must start at least one server and at least one connector, but you may start as many as you like.

node bin/redstone.js -s --master=<HOSTNAME OF MASTER>
node bin/redstone.js -c --master=<HOSTNAME OF MASTER>

NOTE: If multiple components are running on the same machine, you must set the control port to a unique port, e.g.:

node bin/redstone.js -s --master=localhost --control=8001
node bin/redstone.js -c --master=localhost --control=8002

Once your components spin up, you should be able to connect to the connector(s) via your Minecraft client.

redstone's People

Contributors

keppel avatar mappum avatar

Stargazers

 avatar

Watchers

 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.