From 2819307dac6b5bcf2a349d1d0776a0ec804cbed3 Mon Sep 17 00:00:00 2001 From: Paldiu Date: Thu, 13 Apr 2023 21:21:48 -0500 Subject: [PATCH] Create README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..914efed --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# 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: + - Aikar's Annotation Command Framework for command handling + - 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