Update README.md

This commit is contained in:
Oliver
2025-03-31 18:52:40 +02:00
parent d401dac6c3
commit 101bb49285

View File

@@ -15,9 +15,6 @@
[![CodeFactor](https://www.codefactor.io/repository/github/fancymcplugins/fancyplugins/badge)](https://www.codefactor.io/repository/github/fancymcplugins/fancyplugins) [![CodeFactor](https://www.codefactor.io/repository/github/fancymcplugins/fancyplugins/badge)](https://www.codefactor.io/repository/github/fancymcplugins/fancyplugins)
[![Lines of Code](https://tokei.rs/b1/github/fancymcplugins/fancyplugins?category=code)](https://github.com/fancymcplugins/fancyplugins) [![Lines of Code](https://tokei.rs/b1/github/fancymcplugins/fancyplugins?category=code)](https://github.com/fancymcplugins/fancyplugins)
<br />
Simple, lightweight and feature-rich plugins for Minecraft servers.
</div> </div>
@@ -27,28 +24,25 @@ Simple, lightweight and feature-rich plugins for Minecraft servers.
> Read the [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information about the monorepo. > Read the [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information about the monorepo.
> Here is a blog article about why we use a monorepo: [why-monorepo.md](docs/src/blog/why-monorepo.md). > Here is a blog article about why we use a monorepo: [why-monorepo.md](docs/src/blog/why-monorepo.md).
Plugins: **Plugins:**
- fancynpcs: create and manage fancy looking npcs ([old repository](https://github.com/FancyMcPlugins/FancyNpcs)) - FancyNpcs: create and manage fancy looking npcs ([old repository](https://github.com/FancyMcPlugins/FancyNpcs))
- fancyholograms (v2): create fancy looking holograms ([old repository](https://github.com/FancyMcPlugins/FancyHolograms)) - FancyHolograms (v2): create fancy looking holograms ([old repository](https://github.com/FancyMcPlugins/FancyHolograms))
- fancyholograms (v3): create fancy looking holograms - FancyHolograms (v3): create fancy looking holograms (work in progress)
- fancyvisuals: plugin to customize all visual components of the game - FancyVisuals: plugin to customize all visual components of the game (work in progress)
Libraries: **Libraries:**
- common: common classes and utilities (FancyLib previously) - Common: common classes and utilities (FancyLib previously)
- jdb: json database library (included in FancyLib previously) - JDB: json database library (included in FancyLib previously)
- plugin-tests: testing library for plugins (included in FancyLib previously) - Plugin Tests: testing library for plugins (included in FancyLib previously)
- packets: packet handling library (FancySitula previously) - Packets: packet handling library (FancySitula previously)
Tools: **Tools:**
- deployment: deploy plugins to platforms like modrinth - Deployment: deploy plugins to platforms like modrinth
- quick-e2e: generate a quick end-to-end environment for testing - 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: Future packages that are planned to be added to the monorepo:
- fancywebsite: https://github.com/FancyMcPlugins/FancyWebsite - fancywebsite: https://github.com/FancyMcPlugins/FancyWebsite
- (fancymorphs: https://github.com/FancyMcPlugins/FancyMorphs) - (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 - minecraft-client: a lightweight Minecraft client for testing
## Usage ## Usage