Skip to main content

Quick Start Guide

Get your first HyperHQ plugin running in 5 minutes!

Prerequisites​

  • HyperHQ installed and running
  • Basic programming knowledge
  • One of the following:
    • Go (for Go template)
    • C# / .NET SDK (for C# template)
    • Python 3.8+ (for Python template)

Step 1: Choose a Template​

Pick the language you're most comfortable with:

TemplateLanguageBest For
Go StarterGoPerformance, small binaries
C# StarterC#Windows, .NET ecosystem
Python StarterPythonQuick prototyping

Step 2: Get Template​

Find your chosen template in your HyperHQ installation:

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

Copy the template folder to your development directory. See the Templates page for more details.

Step 3: Build Your Plugin​

Go Template​

Terminal
cd go-starter
go build -o plugin.exe

C# Template​

Terminal
cd csharp-starter
dotnet publish -c Release -r win-x64 --self-contained -p:PublishSingleFile=true

Python Template​

Terminal
cd python-starter
pip install pyinstaller
pyinstaller --onefile plugin.py

Step 4: Install in HyperHQ​

  1. Create plugin directory:

    HyperHQ/plugins/my-first-plugin/

  2. Copy files:

    my-first-plugin/
    ├── plugin.exe       (your built executable)
    ├── plugin.json      (manifest)
    └── icon.png         (optional, 128x128)

  3. Restart HyperHQ

Step 5: Test Your Plugin​

  1. Open HyperHQ
  2. Go to Settings → Plugins
  3. Find your plugin in the list
  4. Click Test to verify it's working

What's Next?​

Now that you have a working plugin, learn more:

Common Issues​

Plugin doesn't appear in HyperHQ​

  • ✅ Check plugin.json exists and is valid JSON
  • ✅ Verify executable name matches manifest
  • ✅ Restart HyperHQ completely

Authentication fails​

  • ✅ Ensure plugin reads HYPERHQ_AUTH_CHALLENGE environment variable
  • ✅ Check you're connecting to the correct Socket.IO port
  • ✅ Verify challenge is sent immediately on connect

Plugin crashes on startup​

  • ✅ Test executable from command line first
  • ✅ Check logs in plugin data directory
  • ✅ Verify all dependencies are included

Example Plugin​

Here's the minimal code for a working plugin:

plugin.js
// Simplified example - see templates for complete code
socket.on('connect', () => {
  // Authenticate
  socket.emit('authenticate', {
    pluginId: process.env.HYPERHQ_PLUGIN_ID,
    challenge: process.env.HYPERHQ_AUTH_CHALLENGE
  });
});

socket.on('authenticated', (response) => {
  if (response.success) {
    sessionToken = response.sessionToken;

    // Register plugin
    socket.emit('plugin:register', {
      id: pluginId,
      type: 'executable',
      capabilities: ['socketio']
    });
  }
});

Need Help?​

Join the community: