FreedomNetworkSuite/README.md

34 lines
1.9 KiB
Markdown
Raw Normal View History

2023-04-14 02:41:06 +00:00
[Aikar's ACF]: https://github.com/aikar/commands "Annotation Command Framework"
2023-04-14 02:39:42 +00:00
[ProjectReactor]: https://github.com/reactor/reactor-core "ProjectReactor"
[Google GSON]: https://github.com/google/gson "Google GSON"
[Jetbrains Annotations]: https://github.com/JetBrains/JetBrains.Annotations "JetBrains Annotations"
[Lombok]: https://github.com/projectlombok/lombok "Lombok"
[Apache Commons]: https://github.com/apache/commons-lang "Apache Commons"
[SLF4J]: https://github.com/qos-ch/slf4j "SLF4J"
[Paper]: https://github.com/PaperMC/Paper "Paper"
[Kyori Adventure]: https://github.com/KyoriPowered/adventure "Kyori Adventure"
[Reflections API]: https://github.com/ronmamo/reflections "Reflections API"
2023-04-14 02:37:47 +00:00
2023-04-14 02:21:48 +00:00
# FreedomNetworkSuite
This is a proof of concept for a new suite of non-plugin driven modules supported by a common library.
This is designed to encompass the ideologies of a Freedom server, while maintaining full customization through modules.
The modules are non-plugin driven, meaning that in no way are any modules an extension of the Bukkit plugin interface.
This is because the commons library is designed to be a JavaPlugin extension which utilizes each loaded module as a resource.
Any modules are by default an extension of the commons library.
Modules are defined by a module.yml in the resources folder, which contains the path to the main class file,
and a list of dependencies if it requires any other modules to run.
This proof-of-concept also uses the following libraries:
2023-04-14 02:41:06 +00:00
- [Aikar's ACF] for command handling
2023-04-14 02:39:42 +00:00
- [ProjectReactor] for subscribing to SQL database streams
- [Google GSON] for Json interpretation
- [Jetbrains Annotations] for additional compiler annotations
- [Lombok] for boilerplate generation
- [Apache Commons] for various utilities
- [SLF4J] for logging
- [Paper] for the server implementation
- [Kyori Adventure] for chat formatting
- [Reflections API] for reflections