FancyPlugins/README.md

Simple, lightweight and feature-rich plugins for Minecraft servers.

Modules

Caution

The monorepo is still work in progress. Expect breaking changes and incomplete documentation.

Plugins:

• fancynpcs: create and manage fancy looking npcs (old repository)
• fancyholograms (v3): create fancy looking holograms
• fancyvisuals: plugin to customize all visual components of the game

Libraries:

• common: common classes and utilities (FancyLib previously)
• jdb: json database library (included in FancyLib previously)
• plugin-tests: testing library for plugins (included in FancyLib previously)
• packets: packet handling library (FancySitula previously)

Tools:

• deployment: deploy plugins to platforms like modrinth
• quick-e2e: generate a quick end-to-end environment for testing

Docs: documentation for all plugins, libraries and tools.

Future packages that are planned to be added to the monorepo:

• fancywebsite: https://github.com/FancyMcPlugins/FancyWebsite
• (fancymorphs: https://github.com/FancyMcPlugins/FancyMorphs)
• modrinth-sdk: an SDK for the modrinth API (which then can be used in the deployment and quick-e2e tool)
• minecraft-client: a lightweight Minecraft client for testing

Usage

The monorepo uses Gradle as build system. See monorepo.md for more information.

To see specific usage for each package, see the README.md in the respective package directory.

Contributors

Since this is a new repository, the list of contributors didn't get migrated from the previous repositories. Here is a list of contributors to the previous repositories:

• Grabsky
• OakLoaf
• Matt-MX
• Sxtanna
• airoons
• BitByLogics
• devpeaqe
• NonSwag
• FrezzyDev
• perkojack
• BigTowns
• kforbro
• Kamillaova
• Emibergo02
• bridgelol
• Seshpenguin
• UltraFaceguy
• 4drian3d
• Zemux1613
• Yive
• UsainSrht
• killerprojecte
• SirSalad
• yukisnowflake
• BiFTHg
• alexcastro1919
• FrinshHD
• xii69
• ruViolence
• JonasDevDE
• CloveTwilight3

(Taken from https://github.com/FancyMcPlugins/FancyNpcs/graphs/contributors and https://github.com/FancyMcPlugins/FancyHolograms/graphs/contributors)

If you contributed to the previous repositories and want to be listed here, please open an issue or a pull request.