README.md

Element

Element is a DI-like framework for creating standardized "element" objects from configuration files and dependencies. It's meant for Minecraft developers, but it doesn't depend on any particular platform.

Table of Contents

• Background
• Install
• Usage
• Maintainers
• Contributing
• License
• Hosting

Background

Making data-driven, extensible frameworks is hard. Element was designed to help get rid of as much boilerplate as possible.

Install

Element binaries are hosted over on Cloudsmith. You can use Element by adding it as a dependency to your build management system of choice.

For Gradle, add the repository URL like this:

repositories {
    maven {
        url 'https://dl.cloudsmith.io/public/steanky/element/maven/'
    }
}

And in your dependencies section:

dependencies {
    implementation 'com.github.steanky:element-core:1.0.0'
}

(this assumes version 1.0.0, you'll probably want to grab the latest version above)

You can also build binaries directly from source:

git clone https://github.com/Steanky/Element.git
cd ./Element
./gradlew build

Usage

WIP.

Maintainers

Steanky

Contributing

PRs accepted.

License

GNU General Public License v3.0

Hosting

Package repository hosting is graciously provided by Cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence.