|
1 | | - |
2 | | - |
| 1 | +# Microtus |
3 | 2 |
|
4 | | -# Minestom |
5 | | - |
6 | | -[](../LICENSE) |
7 | | -[](https://github.com/RichardLitt/standard-readme) |
8 | | -[](https://javadoc.minestom.net) |
| 3 | +[](../LICENSE) |
9 | 4 | [](https://wiki.minestom.net/) |
10 | | -[](https://discord.gg/pkFRvqB) |
11 | | - |
12 | | -Minestom is an open-source library that enables developers to create their own Minecraft server software, without any code from Mojang. |
13 | 5 |
|
14 | | -The main difference between Mojang's vanilla server and a minestom-based server, is that ours does not contain any features by default! |
15 | | -However, we have a complete API which is designed to allow you to make anything possible, with ease. |
| 6 | +[Microtus](https://en.wikipedia.org/wiki/Microtus) is a fork of the original minestom but patch based. |
16 | 7 |
|
17 | | -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. |
| 8 | +Our projects get names of animals but in latin. |
18 | 9 |
|
19 | | -# Table of contents |
20 | | -- [Install](#install) |
21 | | -- [Usage](#usage) |
22 | | -- [Why Minestom?](#why-minestom) |
23 | | -- [Advantages & Disadvantages](#advantages-and-disadvantages) |
24 | | -- [API](#api) |
25 | | -- [Credits](#credits) |
26 | | -- [Contributing](#contributing) |
27 | | -- [License](#license) |
| 10 | +Discord for discussion: [OneLiteFeather.net](https://discord.onelitefeather.net) |
28 | 11 |
|
29 | | -# Install |
30 | | -Minestom is not installed like Bukkit/Forge/Sponge. |
31 | | -As Minestom is a Java library, it must be loaded the same way any other Java library may be loaded. |
32 | | -This means you need to add Minestom as a dependency, add your code and compile by yourself. |
| 12 | +## Our goals |
| 13 | +- Include patches from open pull requests on minestom repository |
| 14 | +- Fixes issues from original minestom repository |
| 15 | +- Make useful decisions |
| 16 | + - Include new features |
| 17 | + - Try to stay updated with original minecraft cycle |
| 18 | +- Release cycle of 2 weeks |
33 | 19 |
|
34 | | -Minestom is available on [Maven Central](https://mvnrepository.com/artifact/net.minestom/minestom-snapshots), |
35 | | -and can be installed like the following (Gradle/Groovy): |
| 20 | +## Project contribution: |
36 | 21 |
|
37 | | -```groovy |
38 | | -repositories { |
39 | | - mavenCentral() |
40 | | - maven { url 'https://jitpack.io' } |
41 | | -} |
| 22 | +For details how you can contribute to the project please read our [Contributing](CONTRIBUTING.md). |
42 | 23 |
|
43 | | -dependencies { |
44 | | - implementation 'net.minestom:minestom-snapshots:<???>' |
45 | | -} |
46 | | -``` |
| 24 | +## Usage of Jitpack: |
47 | 25 |
|
48 | | -# Usage |
49 | | -An example of how to use the Minestom library is available [here](/demo). |
50 | | -Alternatively you can check the official [wiki](https://wiki.minestom.net/) or the [javadocs](https://minestom.github.io/Minestom/). |
| 26 | +Some of the project's dependencies are only available in the Jitpack repository. |
| 27 | +To ensure a seamless experience, kindly include this repository in your project configuration to prevent any potential issues. |
51 | 28 |
|
52 | | -# Why Minestom? |
53 | | -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. |
54 | | -Our target audience is those who want to make a server that benefits little from vanilla features. e.g. creative, kitpvp. |
55 | | -The goal is to offer more performance for those who need it. |
56 | | -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. |
57 | | - |
58 | | -# Advantages and Disadvantages |
59 | | -Minestom isn't perfect, our choices make it much better for some cases, worse for some others. |
60 | | - |
61 | | -## Advantages |
62 | | -* Remove the overhead of vanilla features |
63 | | -* Multi-threaded |
64 | | -* Instance system (Collections of blocks and entities) which is much more scalable than worlds |
65 | | -* Open-source |
66 | | -* Modern API |
67 | | -* No more legacy NMS |
| 29 | +```kt |
| 30 | +maven("https://jitpack.io") |
| 31 | +``` |
68 | 32 |
|
69 | | -## Disadvantages |
70 | | -* Does not work with Bukkit/Forge/Sponge plugins or mods |
71 | | -* Does not work with older clients (using a proxy with ViaBackwards is possible) |
72 | | -* Bad for those who want a vanilla experience |
73 | | -* Longer to develop something playable |
74 | | -* Multi-threaded environments need extra consideration |
75 | 33 |
|
76 | | -# API |
77 | | -Even if we do not include anything by default in the game, we simplify the way you add them, here is a preview. |
| 34 | +## Usage of microtus |
| 35 | +Since 23.07.2023 we are now official on the maven central for releases and snapshots. |
| 36 | +To use Microtus in your projects you need: |
| 37 | +<details> |
| 38 | + <summary>Snapshot</summary> |
78 | 39 |
|
79 | | -## Instances |
80 | | -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... |
| 40 | +Please replace the `<version>` with the right one. You can find the versions here: [Central](https://central.sonatype.com/search?q=microtus) |
| 41 | +For example: `1.1.0-SNAPSHOT+9284d26` |
81 | 42 |
|
82 | | -Being able to create instances directly on the go is a must-have, we believe it can push many more projects forward. |
| 43 | +### Repositories Section |
| 44 | +```kt |
| 45 | +repositories { |
| 46 | + mavenCentral() |
| 47 | + maven("https://oss.sonatype.org/content/repositories/snapshots") |
| 48 | +} |
| 49 | +``` |
83 | 50 |
|
84 | | -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. |
| 51 | +### Dependency Section |
| 52 | +```kt |
| 53 | +dependencies { |
| 54 | + implementation("net.onelitefeather.microtus:Minestom:1.1.3-SNAPSHOT") |
| 55 | + testImplementation("net.onelitefeather.microtus.testing:testing:1.1.3-SNAPSHOT") |
| 56 | +} |
| 57 | +``` |
| 58 | +</details> |
85 | 59 |
|
86 | | -## Blocks |
87 | | -Minestom by default does not know what is a chest, you will have to tell him that it opens an inventory. |
88 | | -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. |
89 | | -However, all blocks are visually there, they just won't have interaction by default. |
| 60 | +<details> |
| 61 | + <summary>Release</summary> |
90 | 62 |
|
91 | | -## Entities |
92 | | -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. |
| 63 | +Please replace the `<version>` with the right one. You can find the versions here: [Central](https://central.sonatype.com/search?q=microtus) |
| 64 | +For example: `1.1.0` |
| 65 | +### Dependency Section |
| 66 | +```kt |
| 67 | +dependencies { |
| 68 | + implementation("net.onelitefeather.microtus:Minestom:1.1.3") |
| 69 | + testImplementation("net.onelitefeather.microtus.testing:testing:1.1.3") |
| 70 | +} |
| 71 | +``` |
| 72 | +</details> |
| 73 | + |
| 74 | +## Extension usage |
| 75 | +### settings.gradle.kts |
| 76 | +Read more about here: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry |
| 77 | +```kt |
| 78 | +pluginManagement { |
| 79 | + repositories { |
| 80 | + gradlePluginPortal() |
| 81 | + maven("https://maven.pkg.github.com/OneLiteFeatherNET/Microtus") { |
| 82 | + credentials { |
| 83 | + username = "Your username" |
| 84 | + password = "your github token" |
| 85 | + } |
| 86 | + } |
| 87 | + } |
| 88 | +} |
| 89 | +``` |
93 | 90 |
|
94 | | -## Inventories |
95 | | -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. |
| 91 | +### build.gradle.kts |
| 92 | +```kt |
| 93 | +plugins { |
| 94 | + id("net.onelitefeather.microtus.extension") version "0.0.1" |
| 95 | +} |
96 | 96 |
|
97 | | -## Commands |
98 | | -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. |
| 97 | +dependencies { |
| 98 | + extensionLibrary("com.fasterxml.jackson.module:jackson-module-kotlin:2.15.2") // Use the external dependencies function from minestom |
| 99 | +} |
| 100 | +extension { |
| 101 | + authors = listOf("TheMeinerLP") |
| 102 | + entrypoint = "net.onelitefeather.microtus.extension.ProjectEntry" |
| 103 | + // dependencies = listOf("LuckPerms") // To generate dependencies |
| 104 | + // version = "1.0.0" // Normally its use the project version |
| 105 | + // name = "Example" // Normally its use the project name |
| 106 | + // External dependencies are handled via `extensionLibrary("String")` from gradle |
| 107 | +} |
| 108 | +``` |
99 | 109 |
|
100 | | -# Credits |
101 | | -* The [contributors](https://github.com/Minestom/Minestom/graphs/contributors) of the project |
102 | | -* [The Minecraft Coalition](https://wiki.vg/) and [`#mcdevs`](https://github.com/mcdevs) - |
103 | | - protocol and file formats research. |
104 | | -* [The Minecraft Wiki](https://minecraft.wiki) for all their useful info |
105 | | -* [JProfiler](https://www.ej-technologies.com/products/jprofiler/overview.html) for their amazing Java profiler |
| 110 | +--- |
106 | 111 |
|
107 | | -# Contributing |
108 | | -See [the contributing file](CONTRIBUTING.md)! |
109 | | -All WIP features are previewed as Draft PRs |
| 112 | +[](https://www.yourkit.com/) |
110 | 113 |
|
111 | | -# License |
112 | | -This project is licensed under the [Apache License Version 2.0](../LICENSE). |
| 114 | +[YourKit](https://www.yourkit.com/), makers of the outstanding java profiler, support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler) and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for granting Microtus an OSS license so that we can make our software the best it can be. |
0 commit comments