Project Structure

This is a very quick introduction for people who are interested in the module structure

OUTDATED (everything down below is outdated)

Module Naming

The module will normally be <platform>-<module>

• platform: The platform for this specific module, it may not exactly being a platform for example:

  • core - covers every module that will be used in every platform
  • mc - covers every module that will be used in every Minecraft related platform

• module: Separate modules, for example storage for Database storage such as MySQL, Mongo etc

Module Structures and it purposes

Core platform, Every module that will be used in every platform

• core-base - The base of Fairy, It contains Bootstrap, Bean Service, Library Loader, Reflection, Aspect Annotation and Platform Abstract etc
• core-storage - The storage module, It contains every utilities for Databases such as, H2, MySQL, MariaDB, Postgre and MongoDB
• core-main - The other small utilites compilation, It contains Redis, Commands, Metadata and other small utilities
• core-all - The module that compiled every module inside, you should normally depended on this module

Minecraft platform, The abstract modules for every Minecraft related platform

• mc-abstract - The abstract module for Minecraft Related platform, It contains Localization and Player Storage Interfaces