Yatopia/README.md
Zoe 0ae19b278e
Fix Docs (#364) - Fixes #359
* Fix Docs

* Update README.md
2021-01-26 13:13:17 -06:00

4.3 KiB

Yatopia

Yatopia

Github-CI CodeMC Discord API

Blazing fast Tuinity fork with best in class performance.

So what is Yatopia?

Yatopia combines the code from many Paper forks and optimization mods, as well as many unique optimizations. We borrow code from the following repos:

Try it out

The latest stable builds of Yatopia are always available over at our downloads page. You can also download the latest development build here.

Documentation

You can find a full explanation of the Yatopia configuration file on the wiki. Check out the list of patches included in this project and who created them here.

Building and setting up

Run the following commands in the root directory:

./gradlew initGitSubmodules
./gradlew setupUpstream
./gradlew applyPatches
./gradlew paperclip

Using Yatopia-API

To build your plugin against the Yatopia-API, first add the CodeMC maven repository:

Maven

Add the CodeMC Repo:

<repositories>
    <repository>
        <id>codemc-repo</id>
        <url>https://repo.codemc.io/repository/maven-public/</url>
    </repository>
</repositories>

And then add the Yatopia-API dependency:

<dependencies>
    <dependency>
        <groupId>org.yatopiamc</groupId>
        <artifactId>yatopia-api</artifactId>
        <version>1.16.5-R0.1-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle

Groovy DSL

Add the CodeMC Repo:

repositories {
    maven {
        url 'https://repo.codemc.io/repository/maven-public/'
    }
}

And then add the Yatopia-API dependency:

dependencies {
    compileOnly 'org.yatopiamc:yatopia-api:1.16.5-R0.1-SNAPSHOT'
}

Kotlin DSL

Add the CodeMC Repo:

repositories {
    maven("https://repo.codemc.io/repository/maven-public/")
}

And then add the Yatopia-API dependency:

dependencies {
    compileOnly("org.yatopiamc:yatopia-api:1.16.5-R0.1-SNAPSHOT")
}

Why aren't there many API additions?

(Modified from starlis/empirecraft)

APIs are tough to design. In projects such as Bukkit, Spigot, Sponge, Paper, etc once an API is commited, it's almost forever. You can't go breaking it without solid justification. This is the politics game.

With that in mind, much thought has to be given to the API in now and future use cases and applications to ensure it can be extended without breaking.

This is a lot of politics that we don't have time in our lives to deal with.

That being said we make light API additions when requested.

License

License information can be found here.

Security

Security information can be found found here.

Statistics

bStats Graph Data

Made with on Earth.