Skip to main content

Plugin Templates

Ready-to-use starter templates for building HyperHQ plugins in multiple languages.

Available Templates

🐹 Go Template

Best for: Performance-critical plugins, small executable size, concurrent operations

  • ✅ Full Socket.IO client implementation
  • ✅ Challenge-response authentication
  • ✅ Cross-platform support (Windows, macOS, Linux)
  • ✅ Tiny executable size (~10MB)
  • ✅ Excellent concurrency with goroutines

View Go Template Details →


#️⃣ C# Template

Best for: Windows development, .NET ecosystem integration, async/await patterns

  • ✅ Modern async/await patterns
  • ✅ Microsoft.Extensions.Logging integration
  • ✅ SocketIOClient library
  • ✅ Single-file deployment
  • ✅ Strong typing and IDE support

View C# Template Details →


🐍 Python Template

Best for: Rapid prototyping, beginners, extensive library ecosystem

  • ✅ Simple, readable syntax
  • ✅ Python-socketio library support
  • ✅ Easy debugging
  • ✅ Rich ecosystem of libraries
  • ✅ Cross-platform

View Python Template Details →


Comparison Matrix

FeatureGoC#Python
Difficulty⭐⭐⭐⭐
Executable Size~10MB~70MB~20MB
Startup TimeFastMediumMedium
Memory UsageLowMediumMedium
Cross-platformWindows only
PerformanceExcellentGoodGood
Learning CurveModerateModerateEasy

What's Included

Each template includes:

  • Full source code - Well-commented and structured
  • Authentication - Challenge-response implementation
  • Socket.IO client - Real-time communication
  • Example handlers - Request, event, and data handlers
  • Build scripts - One-command builds
  • plugin.json manifest - Pre-configured
  • Documentation - Language-specific guides

Download Templates

Templates are included with HyperHQ:

HyperHQ/docs/templates/
├── go-starter/
├── csharp-starter/
└── python-starter/

You can find them in your HyperHQ installation directory under docs/templates/, or download them individually from the links on each template's documentation page.

Quick Start

  1. Choose your template based on your needs
  2. Copy the template to a new directory
  3. Build the executable using provided scripts
  4. Install in HyperHQ plugins folder
  5. Test your plugin

See the Quick Start Guide for detailed instructions.

Template Structure

All templates follow a similar structure:

template-name/
├── main.(go|cs|py) # Main plugin code
├── plugin.json # Plugin manifest
├── build.sh/bat # Build script
├── README.md # Template-specific docs
└── go.mod/csproj/... # Language-specific config

Customization

Each template is designed to be customized:

  1. Change plugin ID in plugin.json
  2. Modify settings in the manifest
  3. Add your logic to the execute handlers
  4. Extend capabilities as needed

Next Steps