Git Product home page Git Product logo

jet's Introduction

✈️ Jet

standard-readme compliant

Note

Jet is still very much WIP, Jet should NOT be used for normal servers (yet!)

A brand new Minecraft server software made from scratch that aims to be multithreaded, user-friendly and to have a modern API.

Jet does not have any vanilla features reimplemented, such as combat or fluids, making it good for simple minigame servers.

Background

What does Jet do over other servers?

(Craft-)Bukkit based software (Spigot/Paper)

Minecraft minigame servers are popular for a long time. The oldest ones started from simple minigame servers and ended up with a large server networks.

Since Minecraft release, a lot features were added, affecting server performance. However, minigame servers don't need all of those features. Some servers may also want to have a multi-threaded solution, which Minecraft doesn't have. That's why server software like Jet and Minestom came up.

Jet doesn't have any vanilla features re-implemented by default, allowing for developers to implement their own mechanics and vanilla mechanics, but only these, which they need.

Our server software isn't ideal however. We recommend it for people, for which it's faster to add vanilla mechanics that they need than removing existing mechanics from (Craft-)Bukkit bassed software.

Minestom

  • Simplicity Unlike Minestom, Jet uses an approach more similar to that of Spigot and Paper, the server is just a .jar that you download and run like a normal application, and after which add plugins to. One downside of this is that it can often lead to clashes between plugins and generally make it harder to develop for, Jet aims to solve this with multiple approaches that you will see below.
  • Customizability As mentioned Jet will use multiple ways to better integrate your plugin with the server:
    • Everything is an event In Jet everything is an event, as you may know from other APIs, events have priorities like FIRST, NORMAL and LATE, unlike others Jet has an extra priority named SERVER, this priority will ONLY be used by Jet, and allows the developer to change multiple things about the event either before or after it is handled by Jet. Some features utilizing events are: ALL packets, both outgoing and ingoing, world loading and simple features like inventories, commands etc.
  • Quality of Life Jet includes many QoL features that you may or may not have seen in other servers, some of which include: setting a block only for a specific player, automatic resourcepack creation, any many more!

Install

To install Jet you need to download a server jar file from Github, which you run like a normal java application.

Usage

Using Jet is not very different than Craftbukkit based software, except for not having vanilla features and their properties.

You have a basic configuration file, which contains the most important settings for the server.

If you want to implement features on your server, you need to make plugins using our API, which you put into a plugins subdirectory.

Contributing

You can contribute to Jet easily by creating pull requests, without any other needs.

To not waste your time, make sure to join our Discord server and ask if your contribution would be merged or not. You can also make that via an issue, however it may take longer to get a response.

License

All Jet components (except of API) are licensed under a GPL 3.0 license. However, the API is licensed under a MIT license to allow plugins to be done like their authors want.

jet's People

Contributors

codestech1 avatar window5000 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jet's Issues

Command system

Minecraft servers have an important feature for client -> server interaction. It is called "commands". Commands are represented by a string, which server parses and does a certain thing. Mojang introduced an open-source command parser, which is even used by a vanilla server. Due to that, it should not be hard to implement a command system with brigadier - the command parser - and it would let users create commands easily.

Status protocol state

Status is one of two Minecraft protocol states that follow a handshake packet. A use case of it is to receive a server list MOTD.

Related to: #4

Configuration Protocol State

Configuration is a Protocol State, during which server initializes world and settings, such as resource packs. Jet cannot fully work without this state with modern versions of Minecraft.

Related to: #4

Plugin system

Plain Jet does not have any behaviour. It it up to a user to add it. To do that, it's needed to have a plugin system, which would contain all API interfaces to interact with server.

Event system

An event system is needed in Jet in any case. Our Minecraft server software does not contain any vanilla features, it it up to user to re-implement them if they are needed. However, server's behaviour can not be controlled via plugins without an event system.

Mixins

Jet should support SpongeMixins, might be complicated as we need to have a class transformer or something, however there are already libraries doing this and fabric has a pretty full library doing this too.

Login system

Jet currently has only one Minecraft protocol state fully implemented. It is handshake. However, after handshake, client requests a server to switch to one of two protocol states. They are login and status. While login is for logging a player into a server, status is for server list pinging. Login is needed by Jet, because it is an unmodifiable behaviour and is required to let a player join to the server.

This issue is related to #4

Registry system

Since Minecraft 1.16, servers are able to send custom registry data, such as biomes and dimension types. Since Jet aims on customizability, it should be added before 1.0 release.

Jet data needs to be finished first.

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.