-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,26 @@ | ||
## legacy-lands-library | ||
<div align="center"> | ||
<img src="./logo.png"> | ||
<br /><br /> | ||
<p>Based on <a href="https://github.com/FairyProject/fairy" target="_blank">Fairy Framework</a>, it runs as a plug-in, aiming to encapsulate various existing libraries to simplify the development of <a href="https://github.com/PaperMC/Folia" target="_blank">Folia</a> plug-ins.</p> | ||
</div> | ||
|
||
![logo.png](logo.png) | ||
### overview | ||
|
||
This is a project that aims to encapsulate various existing libraries to facilitate the team to develop [Folia](https://github.com/PaperMC/Folia) plug-ins. | ||
The overall dependence is on the Fairy [Fairy Framework](https://github.com/FairyProject/fairy). It probably doesn't have a lot of overly complex stuff, like an unnecessary repackaging of some large library. | ||
|
||
The overall dependence is on the Fairy Framework framework. It probably doesn't have a lot of overly complex stuff, like an unnecessary repackaging of some large library. | ||
### usage | ||
|
||
Please download all `artifacts` in [Actions](https://github.com/LegacyLands/legacy-lands-library/actions) and install them as plugins. | ||
|
||
The usage of a particular module is described in detail in the module's `README.md`. | ||
|
||
It should be noted that the entire library fully depends on [Fairy Framework](https://github.com/FairyProject/fairy), which will completely simplify our development process and provide various functions. It also depends on [fairy-lib-plugin](https://github.com/FairyProject/fairy-lib-plugin). | ||
|
||
### modules | ||
|
||
- annotation - Not fully completed (annotation processor available) | ||
- configuration - Not fully completed (serialization/yaml/json/toml available) | ||
- mongodb - Not fully completed | ||
- cache - Not fully completed (memory/caffeine/redis cache available) | ||
- [annotation](annotation/README.md) | ||
- [configuration](configuration/README.md) | ||
- [mongodb](mongodb/README.md) | ||
- [cache](cache/README.md) | ||
- data - Not started yet | ||
- security - Not started yet | ||
- security - Not started yet |