Skip to main content

Introduction

Zora is a framework for creating minimalistic, fast and scalable Minecraft plugins. Simply, it encapsulates all the core and common tasks involved with creating a plugin, allowing you to focus purely on the logic of your plugin.

It's designed to be as simple as possible, while still being powerful and flexible. Zora serves as a replacement for internal tools used by RedEye, as well as our partners Synx Games and CheatCode Media Group.

This documentation serves to assist you with developing plugins using Zora. The majority of Zora is well documented throughout the codebase, but this documentation exists to supplement that.

Zora is named after the aquatic species sharing the name from the Legend of Zelda series. It's a fitting name, as Zora is designed to be as fast and efficient as possible, while still being powerful and flexible. This is similar to the Zora species, which are known for their speed and agility.

Getting Started​

info

You must additionally install the Zora Minecraft plugin to any server using Zora. This ensures filesize of any projects using Zora is kept to a minimum, with all shared code being loaded from the plugin.

Zora is a licenced product. As such, you will need to obtain a licence key before you can use it. This licence key will provide you with access to our private Maven repository, which contains the Zora library.

We only document our build systems in Gradle, but Zora is compatible with Maven as well. We strongly recommend using Gradle due to its significantly better performance and flexibility.

Once you have added our repository, you can add Zora as a dependency:

Groovy DSL​

repositories {
    maven {
        url = 'https://repo.redeye.dev/repository/maven-public/'
    }
}

dependencies {
    implementation 'dev.redeye:zora:1.0.0'
}

Kotlin DSL​

repositories {
    maven {
        url = uri("https://repo.redeye.dev/repository/maven-public/")
    }
}

dependencies {
    implementation("dev.redeye:zora:1.0.0")
}