Plugin:Freedom Network Suite

From TotalFreedom Wiki
Jump to navigation Jump to search


Freedom Network Suite

The Freedom Network Suite is a comprehensive suite of modules designed to enhance and customize the functionality of Minecraft servers. It offers a range of features and tools to provide server administrators and developers with extensive customization options while maintaining the ideologies of a Freedom server.

Overview

The Freedom Network Suite is a ground-up rewrite of the TotalFreedomMod plugin, originally designed to allow all players to have true op while still giving control to administrators. The suite consists of various modules supported by a common library, which provides a foundation for seamless integration and customization.

Modules

The Freedom Network Suite is composed of several modules, each serving a specific purpose and contributing to the overall functionality of the suite. Here are the key modules:

Patchwork

Patchwork acts as the core module and communication hub of the Freedom Network Suite. It ensures smooth communication and data sharing among different parts of the server, making sure that all components work together harmoniously. Patchwork provides features such as logging, SQL database management, economy management, command handling, particle effects, user management, ban management, service execution, task management, permissions handling, configuration management, and event handling.

Datura

Datura focuses on providing comprehensive permission management functionalities within the Freedom Network Suite. It handles permission registration, assignment, and enforcement for various aspects of the server. Datura integrates with the SQL data management system, providing efficient handling of permissions and ensuring accurate permission management across the server.

Fossil

Fossil takes charge of the server's economy, providing a robust and self-maintained monetary system. It offers implementations for managing player balances, in-game purchases, and rewards. Fossil integrates with Patchwork's SQL API, ensuring global data consistency and supporting cross-network player balances. Additionally, Fossil introduces features like particle implementations (including trails), custom commands, and an interactive shop for players to enjoy.

Corvo

Corvo focuses on service management and task execution within the Freedom Network Suite. It allows the creation, management, and execution of services and tasks on the server. Services can run synchronously or asynchronously, ensuring efficient performance. Corvo's task management system provides scheduling and execution capabilities for one-time or recurring tasks, allowing server administrators to automate various server operations. Additionally, Corvo offers event and listener implementations, enabling server developers to create and handle custom server events.

API and Libraries

The Freedom Network Suite utilizes several external libraries and APIs to enhance its functionality and provide a smooth development experience. Here are some notable ones:

- Google GSON: Used for JSON interpretation and serialization.

- Jetbrains Annotations: Provides additional compiler annotations for enhanced code analysis and optimization.

- Lombok: Used for boilerplate code generation, reducing development effort and increasing code readability.

- Apache Commons: Offers a collection of utility classes for various common tasks.

- SLF4J: Provides a flexible and standardized logging API for efficient logging within the suite.

- Paper: Utilized as the server implementation for the Freedom Network Suite, ensuring compatibility and optimized performance.

- Kyori Adventure: Used for chat formatting, allowing customized and visually appealing chat messages.

- Reflections API: Enables convenient class scanning and reflection, facilitating dynamic class discovery and usage within the suite.

Community and Development

The Freedom Network Suite is designed to support a vibrant community of server administrators, developers, and Minecraft enthusiasts. The suite encourages collaboration, feedback, and contributions from the community to continually enhance and improve its features and functionality. The suite is actively developed, and updates are released periodically to incorporate bug fixes, optimizations, and new features.

Server owners and developers interested in the Freedom Network Suite can join the official community forums, where they can interact with fellow community members, share their experiences, seek assistance, and contribute to the ongoing development and improvement of the suite.[1]

References