Documentation

Installation Guide

This guide will walk you through installing NOPE-PRO in your Unity project.

Requirements

  • Unity Version: 2021.3 LTS or higher (tested up to Unity 6000.0.41f1)
  • Render Pipeline: Compatible with Built-in, URP, and HDRP
  • Scripting Runtime: .NET Standard 2.1
  • Optional: UniTask package (for async support)

Installation Steps

Step 1: Purchase from Unity Asset Store

  1. Visit the NOPE-PRO page on the Unity Asset Store
  2. Click "Add to My Assets"
  3. Complete the purchase

Step 2: Import into Your Project

Method A: Using Package Manager (Recommended)

  1. Open your Unity project
  2. Go to Window → Package Manager
  3. Click the dropdown and select My Assets
  4. Find NOPE-PRO in the list
  5. Click Download (if not already downloaded)
  6. Click Import
  7. In the import dialog, ensure all files are selected
  8. Click Import

Method B: Direct Import

  1. In Unity, go to Assets → Import Package → Custom Package
  2. Navigate to your downloaded NOPE-PRO package
  3. Select all files in the import dialog
  4. Click Import

Step 3: Configure Project Settings

Option A: Using NOPE Settings Window (Recommended)

The easiest way to configure NOPE-PRO is through the built-in settings window:

  1. Go to Window → NOPE → Settings
  2. In the NOPE Settings window:
    • Enable Visual Debugging: Check this box to enable flow tracking and visual debugging
    • Enable UniTask Support: Check if you have UniTask installed and want async support
    • Enable Awaitable Support: Check if you're using Unity 6+ and want native async support
  3. Click Apply Settings - this will automatically add the required scripting define symbols
  4. Unity will recompile scripts automatically

💡 Tip: The settings window automatically manages scripting define symbols for you, preventing conflicts between different async options.

Option B: Manual Configuration

If you prefer to configure manually or need fine control:

Enable Visual Debugging (Recommended)
  1. Go to Edit → Project Settings → Player
  2. Under Other Settings → Configuration
  3. Add NOPE_PRO_DEBUG to Scripting Define Symbols
  4. Click Apply

This enables the visual flow debugger - highly recommended during development!

Enable Async Support (Optional)

For UniTask Support:

  1. Install UniTask package first (see UniTask Installation)
  2. Add NOPE_UNITASK to Scripting Define Symbols
  3. Click Apply

For Unity 6+ Awaitable Support:

  1. Ensure you're using Unity 6 or newer
  2. Add NOPE_AWAITABLE to Scripting Define Symbols
  3. Click Apply

⚠️ Important: Only enable ONE async option (either NOPE_UNITASK or NOPE_AWAITABLE, not both)

Step 4: Verify Installation

  1. Create a new C# script in your project
  2. Add the following test code:
1using UnityEngine;
2using NOPE.Runtime.Core;
3using NOPE.Runtime.Core.Result;
4using NOPE.PRO.VisualDebugger;
5
6public class NOPETest : MonoBehaviour
7{
8    void Start()
9    {
10        // Test basic Result creation
11        Result<int, string> result = 42;
12        Debug.Log($"NOPE-PRO installed! Result: {result.Value}");
13        
14        // Test visual debugging
15        #if NOPE_PRO_DEBUG
16        var debugResult = result.EnableDebug("TestFlow");
17        Debug.Log("Visual debugging is enabled!");
18        #endif
19    }
20}
  1. Attach this script to a GameObject
  2. Enter Play Mode
  3. Check the Console - you should see the success messages

Step 5: Open Visual Debugger (Optional)

If you enabled NOPE_PRO_DEBUG:

  1. Go to Window → NOPE → Flow Debugger
  2. The Flow Debugger window will open
  3. Run your test scene again
  4. You should see the "TestFlow" appear in the debugger

Project Structure

After installation, your project will contain:

1Assets/
2├── NOPE-PRO/
3│   ├── Runtime/          # Core runtime code
4│   │   └── Core/         # Result, Maybe, and extensions
5│   ├── Editor/           # Editor tools and windows
6│   │   ├── FlowDebuggerWindow.cs
7│   │   └── NOPESettingsWindow.cs
8│   ├── Examples/         # Example scenes and scripts
9│   └── Documentation~/   # This documentation
10├── Demo/                 # Demo comparison scripts
11└── Scenes/              # Example scenes

Configuration Options

NOPE Settings Window

Access via Window → NOPE → Settings

  • Enable Flow Tracking: Toggle visual debugging on/off
  • Max Tracked Flows: Limit memory usage (default: 100)
  • Retention Time: How long to keep completed flows (default: 300s)
  • Enable Runtime Overlay: Show in-game debugging overlay
  • Overlay Toggle Key: Key to show/hide overlay (default: F9)

Troubleshooting

Common Issues

"NOPE namespace not found"

  • Ensure the import completed successfully
  • Check that Assembly Definitions are properly configured
  • Try reimporting the package

"Visual debugger not working"

  • Verify NOPE_PRO_DEBUG is in Scripting Define Symbols
  • Check that flow tracking is enabled in NOPE Settings
  • Ensure you're calling .EnableDebug() on your Results

"Async methods not available"

  • Verify you've added either NOPE_UNITASK or NOPE_AWAITABLE
  • For UniTask, ensure the UniTask package is installed
  • For Awaitable, ensure you're using Unity 6+

Congratulations! NOPE-PRO is now ready to use in your project.

Getting StartedQuick Start Guide