Dashboard Setup & Configuration - Help Center | Oplix

Dashboard Setup & Configuration

This comprehensive guide walks you through integrating the Oplix feedback system into your game engine project. Whether you’re using Unity, Unreal Engine, or building a custom integration via API, this guide covers everything from template creation to plugin deployment.

💡 Before You Begin

Ensure you have:

  • An active Oplix account with appropriate permissions
  • Admin or developer access to your organization’s dashboard
  • Your game project ready for plugin integration

Overview

The Game Engine Integration process enables your players to submit feedback, bug reports, and feature requests directly from within your game. The integration captures not just player input, but also critical context like screenshots, device information, and game state data.

Integration Benefits

  1. Seamless Player Experience - In-game feedback forms without leaving the game
  2. Rich Context Capture - Automatic collection of screenshots, device specs, and game state
  3. Flexible Form Design - Customizable templates tailored to your feedback needs
  4. Secure Communication - API key-based authentication and encrypted data transfer
  5. Cross-Platform Support - Works across PC, console, and mobile platforms
Setup Process
Create Templates

Design feedback forms with custom fields and validation

Create Game App

Generate API keys and configure game settings

Link Templates

Connect templates to app and configure deployment

Install Plugin

Integrate into Unity, Unreal, or use REST API

Detailed Configuration Guide

Step 1: Template Creation & Configuration

Templates define what information you collect from players and how it’s presented. Navigate to Dashboard > Configuration > Templates and click Create New Template.

Template Components

Template Structure

Field Name Type Required Notes
Template Name String Required Internal identifier (e.g., 'Bug Report', 'Feature Request')
Template Description String Optional Helps team members understand the template's purpose
Form Type Enum Required Bug Report, Feature Request, General Feedback, Custom
Form Fields Array Required Collection of questions and input types

Available Field Types

Form Field Types

Field Name Type Required Notes
Text Input Short/Long Text Optional Free-form text entry. Use for: Bug descriptions, feature suggestions, player comments. Supports: Character limits, required validation, placeholder text
Rating Scale Numeric/Star Optional Numerical or star-based ratings. Use for: Severity ratings, satisfaction scores, importance rankings. Supports: 1-5 stars, 1-10 scale, custom ranges
Dropdown Single Select Optional Single-select from predefined options. Use for: Bug categories, feature areas, priority levels. Supports: Dynamic options, default selection
Checkboxes Multi Select Optional Multi-select from options. Use for: Multiple issue types, affected systems, reproduction steps. Supports: Min/max selections, required validation
Toggle Switch Boolean Optional Boolean yes/no input. Use for: Reproducibility, consent flags, feature preferences. Supports: Custom labels, default state

Field Configuration Options

For each field, you can configure:

Required Status - Force players to answer before submission Exclude Flag - Mark sensitive data to exclude from AI processing Conditional Logic - Show/hide fields based on other answers Validation Rules - Character limits, numeric ranges, regex patterns

Template Best Practices

✨ Designing Effective Forms
  • Keep forms under 8 fields to maintain high completion rates
  • Always include a free-text description field
  • Use rating scales for severity/priority to enable automatic triaging
  • Mark PII fields (names, emails) with the exclude flag
  • Create separate templates for different feedback types

Step 2: Game App Creation & API Key Generation

Each game title requires its own App configuration in Oplix. Navigate to Dashboard > Configuration > Game Engine and click Create New App.

App Configuration

Game App Settings

Field Name Type Required Notes
App Name String Required Your game's title (e.g., 'Space Adventure', 'Racing Legends')
App Description String Optional Brief description for internal reference
Platform Multi-Select Required PC, Console, Mobile, Web
Engine Type Enum Required Unity, Unreal Engine, Custom/API
Environment Enum Required Development, Staging, Production

API Key Generation

Once your app is created, Oplix automatically generates two credentials:

App Key (Public) - Used for client-side authentication

  • Safe to include in game builds
  • Identifies which app is sending feedback
  • Format: oplix_app_XXXXXXXXXXXX

Client Secret (Private) - Used for secure token exchange

  • Should be handled securely
  • Never commit to version control
  • Store in environment variables or secure configuration
  • Format: oplix_secret_XXXXXXXXXXXXXXXXXXXXXXXX
⚠️ Security Best Practice

While the App Key can be distributed with your game, treat the Client Secret like a password. For production builds, consider implementing additional security measures like certificate pinning or request signing.

Key Management

You can:

  • Regenerate Keys - If compromised, generate new credentials
  • Create Multiple Environments - Separate keys for dev/staging/production
  • Monitor Usage - Track API calls and submissions per key
  • Revoke Keys - Disable compromised or old keys

Step 3: Template-to-App Linking

Link your created templates to your game app to make them available in-game.

Linking Process

From your Game App settings page:

  1. Navigate to the Templates section
  2. Click Link Template
  3. Select from your created templates
  4. Configure deployment settings
  5. Save and activate

Deployment Configuration

Template Deployment Settings

Field Name Type Required Notes
Active Status Boolean Required Enable/disable template without unlinking
Display Order Number Optional Order templates appear in multi-template apps
Access Rules Object Optional Restrict by game version, player tier, or region
Cooldown Period Duration Optional Minimum time between submissions per player

Multi-Template Strategy

You can link multiple templates to a single app:

Bug Report Template - High priority, detailed technical fields Quick Feedback - Simple 2-3 field form for rapid input Feature Request - Future-focused with voting/importance ratings Quality Survey - Periodic satisfaction checks

✨ Template Tabs

When multiple templates are linked, players see tabs in the feedback window allowing them to choose the appropriate form type.

Version Control

Templates can be updated without breaking existing integrations:

  • Changes propagate automatically on next template fetch
  • Old form submissions remain intact with their original structure
  • A/B test different form layouts by version

Step 4: Plugin Installation & Configuration

Now it’s time to integrate Oplix into your game project.