Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 4.9 KB

README.md

File metadata and controls

74 lines (56 loc) · 4.9 KB
Raw



Issues Forks Stars License Docs

Fairy Framework

Fairy is a compat & open-sourced Java Framework made with ♥. Fairy is heavily inspired from Spring Boot. Its objective is to bring the beauty of dependency injection and CRUD based design patterns to various platforms, including Minecraft server with platforms like Bukkit api, Bungee api etc. This project is a universal framework.

Main Maintainer: Imanity Software

Supported by:

Documentation: docs.fairyproject.io

Advantage using Fairy Framework

Fairy as a universal framework, it mainly built for minecraft server plugins in mind. It's easily the best framework for minecraft server open sourced due to it flexibility, dependency injection pattern, and powerful backing system.

With the flexibility Fairy had, we also have various platform supported that aren't minecraft related. Application platform for independent platform, Discord module built on top of JDA for better experience etc.

Project State

We are currently staying at 0.7.5, the reason why we still have 0 as the major version prefix is because we thought there is missing pieces before we can start with version 1. Does not mean it's unusable.

Objective

The objective of the project will be a fully cross-platform capable framework for minecraft. Where you can write code once and use on every platform with any version. To achieve this it's nearly impossible for a single person or a small team, that's why this is open-sourced, if you can contribute the project we would be very appreciated!

Public projects using Fairy

Getting Started

If you are interested in creating a project using Fairy framework, please start with project template and give our documentation a read!.

Licensing

MIT license for the ♥

Contributing

Contributions can be made via pull requests to this repository. If you are not sure what to contribute with, you can check the Open issues, or ask us directly in Discord.

If you have any issues before/during contribution feel free to come in our Discord to ask questions.

For every contributor, we will be rewarding a discord role in our discord:

image

we are planning to expand the reward for contributing, but this is it for now.

PR Requirements

  • There should be 0 issue found in Codacy.
  • No tabs; use 4 spaces instead.
    • Empty lines should contain no spaces.
  • No trailing whitespaces.
  • No one-line methods.
  • Major additions are preferred to have documentation.
  • Follow test driven development where available.
    • Fairy starting from 0.5.1 will start going in the direction of TDD, if you can contribute to improve test coverage in this project we would be grateful!
  • Avoid moving or renaming classes.