mirror of https://github.com/Minestom/Minestom.git
hollow-cube/minestom-ce -> minestom/minestom
This commit is contained in:
mworzala
Matt Worzala
parent
cccef17e27
commit
1cd68e0c3f
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
# Minestom
|
||||
|
||||
[](../LICENSE)
|
||||
[](../LICENSE)
|
||||
[](https://github.com/RichardLitt/standard-readme)
|
||||
[](https://javadoc.minestom.net)
|
||||
[](https://wiki.minestom.net/)
|
||||
|
|
@ -16,10 +16,6 @@ However, we have a complete API which is designed to allow you to make anything
|
|||
|
||||
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.
|
||||
|
||||
> **Warning**
|
||||
>
|
||||
> `minestom-ce` is a fork with breaking changes from `Minestom/Minestom`. The list of changes can be found [here](/CHANGELOG.md).
|
||||
|
||||
# Table of contents
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
|
|
@ -35,7 +31,7 @@ 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.
|
||||
|
||||
`minestom-ce` is available on [Maven Central](https://central.sonatype.com/artifact/dev.hollowcube/minestom-ce),
|
||||
Minestom is available on [Maven Central](https://central.sonatype.com/artifact/net.minestom/minestom),
|
||||
and can be installed like the following (Gradle/Groovy):
|
||||
|
||||
```groovy
|
||||
|
|
@ -44,7 +40,7 @@ repositories {
|
|||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'dev.hollowcube:minestom-ce:<first 10 chars of commit hash>'
|
||||
implementation 'net.minestom:minestom:<???>'
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -52,17 +48,6 @@ dependencies {
|
|||
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/).
|
||||
|
||||
# What is `minestom-ce`?
|
||||
`minestom-ce` is a fork of `Minestom/Minestom` with some controversial/breaking changes. It was originally started as @mworzala's
|
||||
personal fork for making changes, but has since been used by a number of others and aims to be relatively stable. The high
|
||||
level goal of many changes are to make Minestom more of a library and less of a server implementation. For example:
|
||||
* Removing extensions
|
||||
* Removing logging & terminal implementations
|
||||
|
||||
The name "community edition" is not a reflection of an intentional rift between the two projects, it was just a joke between
|
||||
a few people that stuck. I (@mworzala) am very happy for changes in `minestom-ce` to be merged back to `Minestom/Minestom`, I
|
||||
just do not necessarily have the time to do so myself.
|
||||
|
||||
# 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 server that benefits little from vanilla features. e.g. creative, kitpvp.
|
||||
|
|
@ -112,7 +97,7 @@ It is a field where Minecraft evolved a lot, inventories are now used a lot as c
|
|||
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/hollow-cube/minestom-ce/graphs/contributors) of the project
|
||||
* The [contributors](https://github.com/Minestom/Minestom/graphs/contributors) of the project
|
||||
* [The Minecraft Coalition](https://wiki.vg/) and [`#mcdevs`](https://github.com/mcdevs) -
|
||||
protocol and file formats research.
|
||||
* [The Minecraft Wiki](https://minecraft.gamepedia.com/Minecraft_Wiki) for all their useful info
|
||||
|
|
|
|||
23
CHANGELOG.md
23
CHANGELOG.md
|
|
@ -1,23 +0,0 @@
|
|||
## Changelog
|
||||
Not a "proper" versioned changelog, just a list of the changes from Minestom master.
|
||||
Some of these are pending, some deserve PRs, others are just minor tweaks
|
||||
|
||||
* **breaking** Delete extensions (`mworzala/Minestom` @ `no_more_extensions`)
|
||||
* **breaking** Block face in digging events (`mworzala/Minestom` @ `block_break_face`)
|
||||
* Change `Entity#getInstance` to @UnknownNullability
|
||||
* Support custom component translator for serverside translation
|
||||
* **breaking** Remove tinylog and MinestomTerminal implementation
|
||||
* Add `Tag.Transient`
|
||||
* Optionally allow multiple parents in event nodes
|
||||
* **breaking** Add sender to argument parsing chain
|
||||
* This allows for argument parsing based on the sender, such as in argument map. This was already present for suggestions, but not for parsing.
|
||||
* This is a breaking change because it changes the signature of `Argument#parse`, but most use cases should not be affected.
|
||||
Support has been maintained for the old argument map signature, so only completely custom arguments will be affected.
|
||||
* **breaking** [Placement rule api changes](https://github.com/hollow-cube/minestom-ce/pull/20)
|
||||
* **breaking** Block update rework
|
||||
* Block updates are optional, placements in instances can be done without triggering updates (will not call placement rule place or update events)
|
||||
* Block updates are not always triggered by a block place (only if a neighbor update triggers one back)
|
||||
* Block updates now only update adjacent blocks, not diagonals. This is inline with vanilla behvaior
|
||||
* Block placement rules can dictate a max range where updates will be applied. Defaults to 10 to be more compatible with prior behavior.
|
||||
* Block placement updates receive the block face that triggered the update
|
||||
* Optionally use reworked chunk sending algorithm (`minestom.use-new-chunk-sending` system property)
|
||||
|
|
@ -106,7 +106,7 @@ tasks {
|
|||
|
||||
nexusPublishing{
|
||||
useStaging.set(true)
|
||||
this.packageGroup.set("dev.hollowcube")
|
||||
this.packageGroup.set("net.minestom")
|
||||
|
||||
repositories.sonatype {
|
||||
nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
|
||||
|
|
@ -120,21 +120,21 @@ tasks {
|
|||
}
|
||||
|
||||
publishing.publications.create<MavenPublication>("maven") {
|
||||
groupId = "dev.hollowcube"
|
||||
artifactId = "minestom-ce"
|
||||
groupId = "net.minestom"
|
||||
artifactId = "minestom"
|
||||
version = project.version.toString()
|
||||
|
||||
from(project.components["java"])
|
||||
|
||||
pom {
|
||||
name.set("minestom-ce")
|
||||
description.set("Lightweight and multi-threaded 1.19.3 Minecraft server")
|
||||
url.set("https://github.com/hollow-cube/minestom-ce")
|
||||
name.set("minestom")
|
||||
description.set(project.description)
|
||||
url.set("https://github.com/minestom/minestom")
|
||||
|
||||
licenses {
|
||||
license {
|
||||
name.set("Apache 2.0")
|
||||
url.set("https://github.com/hollow-cube/minestom-ce/blob/main/LICENSE")
|
||||
url.set("https://github.com/minestom/minestom/blob/main/LICENSE")
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -151,19 +151,19 @@ tasks {
|
|||
|
||||
issueManagement {
|
||||
system.set("GitHub")
|
||||
url.set("https://github.com/hollow-cube/minestom-ce/issues")
|
||||
url.set("https://github.com/minestom/minestom/issues")
|
||||
}
|
||||
|
||||
scm {
|
||||
connection.set("scm:git:git://github.com/hollow-cube/minestom-ce.git")
|
||||
developerConnection.set("scm:git:git@github.com:hollow-cube/minestom-ce.git")
|
||||
url.set("https://github.com/hollow-cube/minestom-ce")
|
||||
connection.set("scm:git:git://github.com/minestom/minestom.git")
|
||||
developerConnection.set("scm:git:git@github.com:minestom/minestom.git")
|
||||
url.set("https://github.com/minestom/minestom")
|
||||
tag.set("HEAD")
|
||||
}
|
||||
|
||||
ciManagement {
|
||||
system.set("Github Actions")
|
||||
url.set("https://github.com/hollow-cube/minestom-ce/actions")
|
||||
url.set("https://github.com/minestom/minestom/actions")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ metadata.format.version = "1.1"
|
|||
[versions]
|
||||
|
||||
# Important dependencies
|
||||
data = "1.20-rv2"
|
||||
data = "1.20-rv1"
|
||||
adventure = "4.12.0"
|
||||
kotlin = "1.7.22"
|
||||
hydrazine = "1.7.2"
|
||||
|
|
@ -51,7 +51,7 @@ kotlin-stdlib-jdk8 = { group = "org.jetbrains.kotlin", name = "kotlin-stdlib-jdk
|
|||
|
||||
# Miscellaneous
|
||||
hydrazine = { group = "com.github.MadMartian", name = "hydrazine-path-finding", version.ref = "hydrazine" }
|
||||
minestomData = { group = "dev.hollowcube", name = "minestom-ce-data", version.ref = "data" }
|
||||
minestomData = { group = "net.minestom", name = "data", version.ref = "data" }
|
||||
jetbrainsAnnotations = { group = "org.jetbrains", name = "annotations", version.ref = "jetbrainsAnnotations" }
|
||||
hephaistos-common = { group = "io.github.jglrxavpok.hephaistos", name = "common", version.ref = "hephaistos" }
|
||||
hephaistos-gson = { group = "io.github.jglrxavpok.hephaistos", name = "gson", version.ref = "hephaistos" }
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
rootProject.name = "minestom-ce"
|
||||
rootProject.name = "minestom"
|
||||
|
||||
include("testing")
|
||||
include("code-generators")
|
||||
|
|
|
|||
Loading…
Reference in New Issue