FreedomNetworkSuite/README.md

[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"

[TotalFreedomMod]: https://github.com/AtlasMediaGroup/TotalFreedomMod "TotalFreedomMod"

#####

![Header Image](https://media.discordapp.net/attachments/436759124953399296/1107175759941996544/20230514_002037_0000.png)

###

[<img src="https://img.shields.io/static/v1?label=%20&message=Help%20Wanted&color=red&style=for-the-badge">](https://discord.gg/4PdtmrVNRx)
![GitHub contributors](https://img.shields.io/github/contributors/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge)
[<img src="https://img.shields.io/github/issues/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge">](https://github.com/SimplexDevelopment/FreedomNetworkSuite/issues)
[<img src="https://img.shields.io/github/issues-pr/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge">](https://github.com/SimplexDevelopment/FreedomNetworkSuite/pulls)
![GitHub last commit](https://img.shields.io/github/last-commit/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge)
![Codacy grade](https://img.shields.io/codacy/grade/7a0fa4694878444dabc6cc2804fbf125?style=for-the-badge)

###

[<img src="https://img.shields.io/static/v1?label=Roadmap&message=Google%20Docs&color=4285F4&style=for-the-badge&logo=googledrive">](https://docs.google.com/document/d/197fwNo076RsCiPW6e6QWaGEzTGnDcRuf5FBA6lNeiPE)
[<img src="https://img.shields.io/github/license/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge">](https://github.com/SimplexDevelopment/FreedomNetworkSuite/blob/kitchen-sink/LICENSE.md)
![GitHub top language](https://img.shields.io/github/languages/top/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge&logo=github)
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/SimplexDevelopment/FreedomNetworkSuite?include_prereleases&style=for-the-badge&logo=github)
![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge)
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/SimplexDevelopment/FreedomNetworkSuite?style=for-the-badge)
![TFM Used](https://img.shields.io/static/v1?label=TFM%20Code%20Used&message=0%25&color=red&style=for-the-badge&logo=tensorflow)

# FreedomNetworkSuite

This is a proof of concept for a new suite of modules supported by a common library.
This is designed to encompass the ideologies of a Freedom server, while maintaining full customization through modules.
This is a ground up rewrite of [TotalFreedomMod].
<br>
Honorable mention:
<br>
[<img src="https://img.shields.io/static/v1?label=Plex&message=A%20New%20Freedom%20Plugin&color=4285F4&style=flat-square&logo=plex)">](https://github.com/plexusorg/Plex)

This proof-of-concept also uses the following libraries:

- [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

# Developers

[<img src="https://img.shields.io/static/v1?label=Developer&message=Patches&color=blueviolet&style=for-the-badge&logo=intellijidea">](https://github.com/Paldiu)
<br />
[<img src="https://img.shields.io/static/v1?label=Developer&message=Video&color=blueviolet&style=for-the-badge&logo=intellijidea">](https://github.com/VideoGameSmash12)
<br />
[<img src="https://img.shields.io/static/v1?label=Developer&message=Allink&color=blueviolet&style=for-the-badge&logo=intellijidea">](https://github.com/allinkdev)

# To Do List

Patchwork:

- [x] Logging System
- [x] SQL API
- [x] Economy API
- [ ] Command API
- [ ] Particle API
- [x] User API
- [ ] Ban API
- [x] Service API
- [x] Task API
- [x] Permissions API
- [ ] Configuration API
- [ ] Event API

Datura:

- [ ] Permission Handling
- [ ] Permission Registration & Assignment
- [ ] SQL Data Handling
- [ ] Configuration Implementations
- [ ] User Data Implementations
- [ ] Banning Implementation
- [ ] Punishment Systems (e.x. Locker, Halter, Muter, Cager)

Fossil:

- [x] Economy Implementation
- [ ] Particle Implementation / Trails
- [ ] Command Implementations
- [ ] Implement a shop for the economy
- [ ] Chat reaction / game system
- [ ] Jumppads

Corvo:

- [ ] Service Implementation
- [ ] Service Handling
- [ ] Task Implementation
- [ ] Task Management
- [ ] Event (Project) Implementations
- [ ] Listener (Bukkit) Implementations