Skip to content

OneLiteFeatherNET/wiki

 
 

Repository files navigation

layout
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
visible
true

Introduction

What is Microtus?

Microtus is not only the latin term of a common vole (see: en.wikipedia.org/wiki/Microtus), it is the up to date, open source fork of the serversoftware Minestom which aims for code quality & stability. In order to do so, you, the community are playing an important part! Unlike (Craft-) Bukkit, Spigot, Paper and their corresponding forks, Microtus is NOT a drop in replacement for a whole Minecraft Vanilla experience. The main reason behind this is that Microtus (and Minestom) contains no Minecraft/Mojang/Microsoft developed Code.

-> Microtus is a framework or literally a "construction kit", without any vanilla logic!

Why Microtus ?

Microtus has the ability to accommodate hundreds or thousands of players with little memory. It is also possible to achieve the result faster without a lot of cancellation logic. Everything that is known as NMS1 under Paper/Spigot is supplied as an interface with Microtus. Microtus is changing core elements to absorb unexpected behaviour in a more effective way to improve the developer experience and framework usability.


Why Microtus and not Minestom?

On the one hand, Minestom is more feature-driven than Microtus. On the other hand, one of the Microtus main focus lies in fixing architecture issues from upstream which were made in the past. This has the advantage that Microtus can have a solid ground to build on so that additional features can be more stable.

Minestom decided some time ago to add functions such as

  • Terminal
  • Extensions
  • (TinyLog)

to be removed for various reasons

Microtus and the team behind it believe that a terminal and extensions is a very good combination for a plugin-in hybrid system to speed up update cycles or development cycles.

It also allows you to deploy smaller jars instead of a large monolithic application. In line with this, we are trying to incorporate or orientate design patterns such as Modulith and others.

In addition, we believe that it is a lesser evil to leak a partial component on the internet than a large jar file containing all dependencies or internal libs.


TL;DR

We have reinstalled the above features and give full flexibility to the developers and re-document code from upstream or improve it.


Our goals

Our aim is to bring Microtus closer to the concept of stability, maintainability, and modularity. Since many people see such terms as being empty words, I have described it as a concept.

The main goals can be found here on the roadmap.

One of our biggest points is documentation, listening to the community and stimulating discussions. So you are welcome to discuss things on our Discord or Github.


Footnotes

  1. Native Minecraft Source