Upstream
/
Minestom
mirror of https://github.com/Minestom/Minestom.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme (#872)

This commit is contained in:
KrystilizeNevaDies 2022-04-06 17:19:52 +10:00 committed by GitHub
parent 66a8090a12
commit b6ba6901ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
.github/README.md vendored
View File

@ -7,12 +7,12 @@
[![wiki](https://img.shields.io/badge/documentation-wiki-74aad6?style=for-the-badge)](https://wiki.minestom.net/)
[![discord-banner](https://img.shields.io/discord/706185253441634317?label=discord&style=for-the-badge&color=7289da)](https://discord.gg/pkFRvqB)
Minestom is a complete rewrite of Minecraft server software, open-source and without any code from Mojang.
Minestom is an open-source library that enables developers to create their own Minecraft server software, without any code from Mojang.
The main difference compared to it is that our implementation of the Minecraft server does not contain any features by default!
However, we have a complete API which allows you to make anything possible with extensions, similar to plugins and mods.
The main difference between Mojang's vanilla server and a minestom-based server, is that ours does not contain any features by default!
However, we have a complete API which is designed to allow you to make anything possible, with ease.
This is a developer API not meant to be used by the end-users. Replacing Bukkit/Forge/Sponge with this will **not** work since we do not implement any of their APIs.
This is a developer API not meant to be used by end-users. Replacing Bukkit/Forge/Sponge with this **will not work** since we do not implement any of their APIs.
# Table of contents
- [Install](#install)
@ -25,21 +25,20 @@ This is a developer API not meant to be used by the end-users. Replacing Bukkit/
- [License](#license)
# Install
Minestom is similar to Bukkit in the fact that it is not a standalone program, it must be expanded upon.
It is the base for interfacing between the server and client.
Our own expanded version for Vanilla can be found [here](https://github.com/Minestom/VanillaReimplementation).
Minestom is not installed like Bukkit/Forge/Sponge.
As Minestom is a Java library, it must be loaded the same way any other Java library may be loaded.
This means you need to add Minestom as a dependency, add your code and compile by yourself.
Our own WIP implementation for Vanilla can be found [here](https://github.com/Minestom/VanillaReimplementation).
# Usage
An example of how to use the Minestom library is available [here](/demo).
Alternatively you can check the official [wiki](https://wiki.minestom.net/) or the [javadocs](https://minestom.github.io/Minestom/).
# Why Minestom?
Minecraft has evolved a lot since its release, most of the servers today do not take advantage of vanilla features and even have to struggle because of them. Our target audience is those who want to make a completely different server compared to vanilla Minecraft such as survival or creative building.
The goal is to offer more performance for those who need it. Minecraft being single-threaded is the biggest problem for them.
In other words, it makes sense to use Minestom when it takes less time to implement everything you want than removing everything you don't need.
Minecraft has evolved a lot since its release, most of the servers today do not take advantage of vanilla features and even have to struggle because of them.
Our target audience is those who want to make a server that benefits little from vanilla features. e.g. creative, kitpvp.
The goal is to offer more performance for those who need it.
In other words, it makes sense to use Minestom when it takes less time to implement every missing vanilla feature you want than removing every vanilla feature that will slow you down.
# Advantages and Disadvantages
Minestom isn't perfect, our choices make it much better for some cases, worse for some others.
@ -47,42 +46,41 @@ Minestom isn't perfect, our choices make it much better for some cases, worse fo
## Advantages
* Remove the overhead of vanilla features
* Multi-threaded
* Instance system which is much more scalable than worlds
* Instance system (Collections of blocks and entities) which is much more scalable than worlds
* Open-source
* Modern API
* No more disgusting NMS
* No more legacy NMS
## Disadvantages
* Does not work with Bukkit/Forge/Sponge plugins or mods
* Does not work with older clients (using a proxy with ViaBackwards is possible)
* Bad for those who want a vanilla experience
* Longer to develop something playable
* Multi-threaded environments are prone to complications
* Multi-threaded environments need extra consideration
# API
Even if we do not include anything by default in the game, we simplify the way you add them, here is a preview.
## Instances
It is our major concept, worlds are great for survival with friends, but when it scales up it can become unmanageable. The best examples can be found in Skyblock or minigames, not being able to separate each part properly and being forced to save everything in files, not to say the overhead caused by unnecessary data contained in them. Instances are a lightweight solution to it, being able to have every chunk in memory only, copying and sending it to another player in no time, making your serializer and much more...
It is our major concept, worlds are great for survival with friends, but when it scales up it can become unmanageable. The best examples can be found in Skyblock or minigames, not being able to separate each part properly and being forced to save everything in files, not to say the overhead caused by unnecessary data contained in them. Instances are a lightweight solution to it, being able to have every chunk in memory only, copying and sending it to another player in no time, with custom serialization and much more...
Being able to create instances directly on the go is a must-have, according to us it can push many more projects forward.
Being able to create instances directly on the go is a must-have, we believe it can push many more projects forward.
Instances also come with performance benefits, unlike some others which will be fully single-threaded or maybe using one thread per world we are using a set number of threads (pool) to manage all chunks independently from instances, meaning using more CPU power.
## Blocks
Minestom by default does not know what is a chest, you will have to tell him that it opens an inventory.
Every "special blocks" (which aren't only visual) have to be registered, then they can be placed anywhere simply.
Every "special blocks" (which aren't only visual) need a specialized handler. After applying this handler, you have a block that can be placed anywhere simply.
However, all blocks are visually there, they just won't have interaction by default.
## Entities
The terms "passive" or "aggressive" monsters do not exist, nobody forbid you from making a flying chicken rushing into any players coming too close, doing so with NMS is a real mess because of obfuscation and the large inheritance.
The terms "passive" or "aggressive" monsters do not exist, nobody stops you from making a flying chicken rushing into any players coming too close, doing so with NMS is a real mess because of obfuscation and the large inheritance.
## Inventories
It is a field where Minecraft evolved a lot, inventories are now used a lot as client<->server interface with clickable items and callback, we support it natively without the need of programming your solution.
It is a field where Minecraft evolved a lot, inventories are now used a lot as client<->server interface with clickable items and callback, we support these interactions natively without the need of programming your solution.
## Commands
Commands are the simplest way of communication between clients and server. Since 1.13 Minecraft has incorporated a new library denominated "Brigadier", we then integrated an API meant to use the full potential of args types.
Commands are the simplest way of communication between clients and server. Since 1.13 Minecraft has incorporated a new library denominated "Brigadier", we then integrated an API designed to use the full potential of args types.
# Credits
* The [contributors](https://github.com/Minestom/Minestom/graphs/contributors) of the project
@ -92,8 +90,8 @@ Commands are the simplest way of communication between clients and server. Since
* [JProfiler](https://www.ej-technologies.com/products/jprofiler/overview.html) for their amazing Java profiler
# Contributing
See [the contributing file](CONTRIBUTING.md)!
All planned features are listed on [Trello](https://trello.com/b/4ysvj5hT/minestom)
See [the contributing file](CONTRIBUTING.md)!
All WIP features are previewed as Draft PRs
# License
This project is licensed under the [Apache License Version 2.0](../LICENSE).