From 892cc3344c7d8fdcb04647773a2daa46b0d17186 Mon Sep 17 00:00:00 2001 From: Ben Allfree Date: Sun, 30 Nov 2025 09:45:06 -0800 Subject: [PATCH] style: update index.html for improved layout and design, including new hero section, enhanced call-to-action buttons, and refined method cards for better user experience --- registry/index.html | 446 +++++++++++++++++++------------------------- 1 file changed, 192 insertions(+), 254 deletions(-) diff --git a/registry/index.html b/registry/index.html index e75f312..a4753c0 100644 --- a/registry/index.html +++ b/registry/index.html @@ -4,10 +4,6 @@ Mesh Plugin Registry -
-
+

🔌 Mesh Plugin Registry

-

Discover and install plugins for your Meshtastic firmware

-

+

Extend your Meshtastic firmware with community plugins

+
Built by MeshEnvy • Not affiliated with Meshtastic -

+
+
+ +
-
-

What is the Mesh Plugin Registry?

-

- The Mesh Plugin Registry is a centralized - repository built by +

+
+ Recommended +

Mesh Forge

+

+ Build custom firmware with plugins directly in your browser. No + installation or setup required. +

+
    +
  • Zero installation
  • +
  • Simple interface
  • +
  • Automatic dependencies
  • +
  • Ready-to-flash files
  • +
MeshEnvyGet Started → - that hosts metadata about available Meshtastic plugins. This - registry provides: -

-
    -
  • A searchable catalog of community-developed plugins
  • -
  • Version information and release history
  • -
  • Dependency relationships between plugins
  • -
  • Author information and repository links
  • -
  • Automatic dependency resolution during installation
  • -
-
+
-
-

What is the Mesh Plugin Manager?

-

- The Mesh Plugin Manager (MPM) is the command-line - tool you use to access the registry and install plugins. It's a - lightweight package manager designed specifically for Meshtastic - plugins that provides a simple and powerful way to extend your - Meshtastic firmware with additional functionality. -

-
- Key Features: +
+ Advanced +

Mesh Plugin Manager

+

+ Command-line tool for building firmware locally. Requires + PlatformIO and Poetry setup. +

    -
  • Install and manage plugins from the registry
  • -
  • Automatic dependency resolution with SemVer support
  • -
  • Lockfile generation for reproducible builds
  • -
  • Protobuf file generation for plugins
  • -
  • Seamless PlatformIO build system integration
  • +
  • Local development
  • +
  • Full control
  • +
  • CLI interface
  • +
  • Developer-focused
-
-
- -
-

Installation

-

- MPM is installed as a development dependency via Poetry. From the - firmware repository root: -

-
-
poetry install
-
-
- Important: Poetry must be configured to create the - virtual environment in the project directory (.venv) so - that the PlatformIO build system can find it. Configure it locally - for the project: -
View on PyPI → -
poetry config virtualenvs.in-project true --local
-
-
+
-
-

Usage

+
+

Creating Your Own Plugin?

- Once installed, you can use the mpm command via Poetry - to browse the registry and manage your plugins: + Check out the plugin development guide for documentation on plugin + structure, protobuf generation, and module registration.

- -
-
# List installed plugins
-poetry run mpm list
-
-# List all available plugins from registry
-poetry run mpm list --all
-
-# Install a plugin from the registry
-poetry run mpm install <slug>
-
-# Install all plugins from meshtastic.json
-poetry run mpm install
-
-# Remove a plugin
-poetry run mpm remove <slug>
-
-# Generate protobuf files for all plugins
-poetry run mpm proto
-
-
- -
-

Adding Your Plugin to the Registry

-

- Have a plugin you'd like to share with the community? Submit a pull - request to add it to the Mesh Plugin Registry! -

-
- How to contribute: -
    -
  1. - Fork the - MeshEnvy/mesh-forge - repository -
  2. -
  3. - Edit the registry/registry.json file and add your - plugin entry -
  4. -
  5. - Include all required fields: name, description, version, author, - repo URL, and dependencies -
  6. -
  7. - Submit a pull request with a clear description of your plugin -
  8. -
-
-

Your plugin entry should follow this format:

-
-
{
-  "your-plugin-slug": {
-    "name": "Your Plugin Name",
-    "description": "A brief description of what your plugin does",
-    "version": "1.0.0",
-    "author": "your-username",
-    "repo": "https://github.com/your-username/your-plugin",
-    "dependencies": {
-      "meshtastic": ">=2.7.0"
-    }
-  }
-}
-
-
- -
-

Registry API

-

- The registry is served as a JSON file that can be accessed - programmatically. The registry format includes: -

-
    -
  • Plugin metadata (name, description, version, author)
  • -
  • Repository URLs for source code
  • -
  • Dependency specifications with version constraints
  • -
  • Compatibility information
  • -
-

You can access the registry JSON directly:

-
-
curl https://registry.meshforge.org/registry.json
-
-
+ Plugin Development Guide → +
- -