Split READMEs to the plugins (#35)

* Add READMEs for various plugins/themes, documenting features and technical details

* Add additional notes and warnings to plugin READMEs

* Remove technical details sections from plugin and theme READMEs.

* cleanup

---------

Co-authored-by: Boy132 <mail@boy132.de>

Author: PalmarHealer

README.md

@@ -1,142 +1,35 @@
 # Pelican Plugins
 
-A curated list of plugins for the [pelican panel](https://pelican.dev). Feel free to add plugins that you created via a pull request!
+A curated list of plugins for the [Pelican Panel](https://pelican.dev). Feel free to add plugins that you created via a pull request!
 
 ## How to install plugins
 
 [Download the repository archive](https://github.com/pelican-dev/plugins/archive/refs/heads/main.zip) and extract the folders of the plugins you want to install to your panels `plugins` folder (`/var/www/pelican/plugins` by default). Finally, open your panel and head to the plugins page and click on "Install".
 
-## Plugin list
-
-### [Announcements](/announcements) <sup><sub>by Boy132</sub></sup>
-
-Very simple announcements via AlertBanners.
-
-> [!WARNING]
-> Alert banners are currently bugged. See <https://github.com/pelican-dev/panel/issues/1492>
-
----
-
-### [Billing](/billing) <sup><sub>by Boy132</sub></sup>
-
-Allows admins to create products and users to buy them. Features automatic server creation and payment handling. Also adds a simple shop.
-
-> [!CAUTION]
-> This plugin is incomplete!
-
----
-
-### [Fluffy Theme](/fluffy-theme) <sup><sub>by Boy132</sub></sup>
-
-Simple "Theme" with silly colors and font.
-
----
-
-### [Generic OIDC Providers](/generic-oidc-providers) <sup><sub>by Boy132</sub></sup>
-
-Allows to create generic OIDC providers.
-
----
-
-### [Legal Pages](/legal-pages) <sup><sub>by Boy132</sub></sup>
-
-Adds some legal pages (like an Imprint) to the panel.
-
----
-
-### [Mclogs Uploader](/mclogs-uploader) <sup><sub>by Boy132</sub></sup>
-
-Adds a button to the console for uploading console logs to [mclo.gs](https://mclo.gs/).
-
----
-
-### [Minecraft Modrinth](/minecraft-modrinth) <sup><sub>by Boy132</sub></sup>
-
-Allows to easily download minecraft mods & plugins from modrinth.
-
-> [!IMPORTANT]
-> Add `modrinth_mods` or `modrinth_plugins` to the features of your egg to enable the mod/ plugins page. Also make sure your egg has the `minecraft` tag and a tag for the mod loader, e.g. `paper` or `forge` or `fabric`.
-
----
-
-### [Pirate Language](/pirate-language) <sup><sub>by Boy132</sub></sup>
-
-Adds a new Pirate like language to the panel.
-
-> [!WARNING]
-> Only the server pages, the Admin Dashboard, Profile page & Health page are currently translated.
-
----
-
-### [Player Counter](/player-counter) <sup><sub>by Boy132</sub></sup>
-
-Adds a simple player counter to the console and a player list page. Uses a [GameQ fork](https://github.com/krymosoftware/gameq).
-
-> [!IMPORTANT]
-> You need to have the bz2 php extension and zip/ 7zip installed!
-
-> [!IMPORTANT]
-> For Minecraft servers you need to set `enable-query` to true and the `query-port` to your server port! (in `server.properties`)
-
----
-
-### [Pterodactyl Theme](/pterodactyl-theme) <sup><sub>by Boy132</sub></sup>
-
-Simple "Theme" with Pterodactyl like colors and font.
-
----
-
-### [Register](/register) <sup><sub>by Boy132</sub></sup>
-
-Enables registration on all panels.
-
----
-
-### [Robo Avatars](/robo-avatars) <sup><sub>by Boy132</sub></sup>
-
-Adds [RoboHash](https://robohash.org/) as avatar provider.
-
----
-
-### [Rust uMod](/rust-umod) <sup><sub>by Boy132</sub></sup>
-
-Allows to easily download rust plugins from uMod.
-
----
-
-### [Snowflakes](/snowflakes) <sup><sub>by Boy132</sub></sup>
-
-Adds simple CSS snowflakes to all panels.
-
----
-
-### [Subdomains](/subdomains) <sup><sub>by Boy132</sub></sup>
-
-Allows users to create subdomains (on cloudflare) for their servers.
-
----
-
-### [Tawk.to Widget](/tawkto-widget) <sup><sub>by Boy132</sub></sup>
-
-Adds a Tawk.to widget to all panels.
-
----
-
-### [Theme Customizer](/theme-customizer) <sup><sub>by Boy132</sub></sup>
-
-Allows to customize the panel font and colors.
-
----
-
-### [Tickets](/tickets) <sup><sub>by Boy132</sub></sup>
-
-Allows users to create tickets (per server) and admins to answer them.
-
----
-
-### [User Creatable Servers](/user-creatable-servers) <sup><sub>by Boy132</sub></sup>
-
-Allows admins to assign resources to users. User can then create server themselves.
-
-> [!IMPORTANT]
-> Add `user_creatable_servers` as tag to the nodes that should be used for creating servers.
+## Plugins
+
+- [Announcements](/announcements) - Create panel wide announcements to inform your users
+- [Billing](/billing) - Allows users to purchase servers via Stripe
+- [Generic OIDC Providers](/generic-oidc-providers) - Create generic OIDC providers for authentication
+- [Legal Pages](/legal-pages) - Adds legal pages (Imprint, Privacy Policy, ToS) to the panel
+- [MCLogs Uploader](/mclogs-uploader) - Upload console logs to mclo.gs
+- [Minecraft Modrinth](/minecraft-modrinth) - Download Minecraft mods & plugins from Modrinth
+- [Player Counter](/player-counter) - Show connected players count for game servers
+- [Register](/register) - Enable user self-registration on all panels
+- [Robo Avatars](/robo-avatars) - Adds RoboHash as avatar provider
+- [Rust uMod](/rust-umod) - Download Rust plugins from uMod
+- [Snowflakes](/snowflakes) - Adds CSS snowflakes to all panels
+- [Subdomains](/subdomains) - Create Cloudflare subdomains for servers
+- [Tawk.to Widget](/tawkto-widget) - Adds a Tawk.to live chat widget
+- [Theme Customizer](/theme-customizer) - Customize panel font and colors
+- [Tickets](/tickets) - Simple ticket system for user support
+- [User Creatable Servers](/user-creatable-servers) - Allow users to create their own servers
+
+## Themes
+
+- [Fluffy Theme](/fluffy-theme) - A super nice and super fluffy theme
+- [Pterodactyl Theme](/pterodactyl-theme) - Pterodactyl like colors and font
+
+## Language Packs
+
+- [Pirate Language](/pirate-language) - Turns yer site's lingo into pirate talk, matey!

announcements/README.md

@@ -0,0 +1,14 @@
+# Announcements (by Boy132)
+
+Create panel-wide announcements to inform your users about important updates, maintenance schedules, or any other information.
+
+> [!WARNING]
+> Alert banners are currently bugged. See https://github.com/pelican-dev/panel/issues/1492
+
+## Features
+
+- Create announcements with customizable titles and body text
+- Support for different announcement types (info, warning, danger, success)
+- Target specific panels (admin, app, server) or display on all panels
+- Schedule announcements with valid from/to dates
+- Announcements are displayed as alert banners across the panel

billing/README.md

@@ -0,0 +1,17 @@
+# Billing (by Boy132)
+
+A simple billing plugin that allows users to purchase servers using Stripe as the payment processor.
+
+> [!CAUTION]
+> This plugin is incomplete! Do NOT use this plugin in production!
+
+## Features
+
+- Stripe integration for payment processing
+- Product management with customizable pricing intervals (monthly, yearly, etc.)
+- Coupon system with percentage and fixed amount discounts
+- Customer management linked to user accounts
+- Order tracking and management
+- Dashboard widget for users to view and purchase products
+- Multi-currency support (USD, EUR, GBP)
+- Configurable deployment tags for automatic server provisioning

fluffy-theme/README.md

@@ -0,0 +1,8 @@
+# Fluffy Theme (by Boy132)
+
+A super nice and super fluffy theme that transforms the panel with playful colors and a fun font.
+
+## Features
+
+- Custom "Finger Paint" font for a playful appearance
+- Unique color palette with soft, fluffy tones

generic-oidc-providers/README.md

@@ -0,0 +1,9 @@
+# Generic OIDC Providers (by Boy132)
+
+Allows administrators to create and configure generic OpenID Connect (OIDC) providers for authentication.
+
+## Features
+
+- Create custom OIDC providers through the admin panel
+- Configure client ID, client secret, and authorization endpoints
+- Support for multiple OIDC providers simultaneously

legal-pages/README.md

@@ -0,0 +1,10 @@
+# Legal Pages (by Boy132)
+
+Adds essential legal pages (Imprint, Privacy Policy, Terms of Service) to the panel for compliance with legal requirements.
+
+## Features
+
+- Pre-configured legal page types (Imprint, Privacy Policy, Terms of Service)
+- Admin interface for editing legal page content
+- Accessible pages in the user-facing app panel
+- Markdown support for page content

mclogs-uploader/README.md

@@ -0,0 +1,9 @@
+# MCLogs Uploader (by Boy132)
+
+Upload server console logs to mclo.gs for easy sharing and troubleshooting.
+
+## Features
+
+- One-click upload of console logs to mclo.gs
+- Integrated action button in the server console
+- Perfect for (but not limited to) Minecraft server

minecraft-modrinth/README.md

@@ -0,0 +1,13 @@
+# Minecraft Modrinth (by Boy132)
+
+Easily download and install Minecraft mods and plugins directly from Modrinth within the server panel.
+
+> [!IMPORTANT]
+> Add `modrinth_mods` or `modrinth_plugins` to the features of your egg to enable the mod/plugins page. Also make sure your egg has the `minecraft` tag and a tag for the mod loader, e.g. `paper` or `forge` or `fabric`.
+
+## Features
+
+- Browse and search Modrinth's extensive mod library
+- Download mods and plugins directly to your server
+- Automatic version compatibility checking
+- Seamless installation to the correct server directory

pirate-language/README.md

@@ -0,0 +1,13 @@
+# Pirate Language (by Boy132)
+
+Turns yer site's lingo into pirate talk, matey! A fun language pack that transforms the entire panel interface into pirate speak.
+
+> [!WARNING]
+> Only the server pages, the Admin Dashboard, Profile page & Health page are currently translated.
+
+## Features
+
+- Complete translation of panel interface to pirate speak
+- Covers admin, server, and profile sections
+- Fun and thematic for gaming communities
+- Easy to enable through language settings

player-counter/README.md

@@ -0,0 +1,19 @@
+# Player Counter (by Boy132)
+
+Show the amount of connected players to game servers with real-time querying capabilities.
+
+> [!IMPORTANT]
+> You need to have the bz2 php extension and zip/7zip installed!
+
+> [!IMPORTANT]
+> For Minecraft servers you need to set `enable-query` to true and the `query-port` to your server port! (in `server.properties`)
+
+## Features
+
+- Real-time player count display for game servers
+- Support for multiple game query protocols via [GameQ](https://github.com/krymosoftware/gameq)
+- Link query protocols to specific eggs
+- Dashboard widget showing connected players
+- Dedicated players page for detailed information
+- Configurable through the admin panel
+- Advanced integration for Minecraft servers: Displays user helmet avatar and allows to manage whitelist & op list.