Rekon-unity

KO | EN

gitlite — search

#swift #automation #cross-platform #python #pdf #gemini #postgresql #proxy #open-source #dotnet

(★ 9)

Bug reporting infrastructure for Unity game dev teams — auto-capture video, screenshots, and logs from play mode, then route them to a web dashboard and Jira.

File Explorer

ZIP Download

- - bug_report.md
  - feature_request.md
- - deploy-notify.yml
  - release.yml
- PULL_REQUEST_TEMPLATE.md
- - rekon-demo.gif
- - CrashBundleScanner.cs
  - CrashBundleScanner.cs.meta
  - CrashJiraSubmitter.cs
  - CrashJiraSubmitter.cs.meta
  - CrashRecoveryWindow.cs
  - CrashRecoveryWindow.cs.meta
- - BundleManagerWindow.cs
  - BundleManagerWindow.cs.meta
  - RekonSettingsWindow.cs
  - RekonSettingsWindow.cs.meta
- CrashRecovery.meta
- Rekon.Editor.asmdef
- Rekon.Editor.asmdef.meta
- RekonEditor.cs
- RekonEditor.cs.meta
- RekonVersionSync.cs
- RekonVersionSync.cs.meta
- UI.meta
- - AuthBrokerClient.cs
  - AuthBrokerClient.cs.meta
  - LicenseValidator.cs
  - LicenseValidator.cs.meta
  - OAuthFlowManager.cs
  - OAuthFlowManager.cs.meta
  - ReAuthHandler.cs
  - ReAuthHandler.cs.meta
  - SessionTokenStore.cs
  - SessionTokenStore.cs.meta
  - SupabaseAuthClient.cs
  - SupabaseAuthClient.cs.meta
  - TokenRefreshManager.cs
  - TokenRefreshManager.cs.meta
- - BundleManifest.cs
  - BundleManifest.cs.meta
  - BundleRepository.cs
  - BundleRepository.cs.meta
  - BundleRetentionPolicy.cs
  - BundleRetentionPolicy.cs.meta
  - BundleWriter.cs
  - BundleWriter.cs.meta
  - ManifestGenerator.cs
  - ManifestGenerator.cs.meta
  - SHA256HashUtility.cs
  - SHA256HashUtility.cs.meta
  - SubmissionQueue.cs
  - SubmissionQueue.cs.meta
- - ContextProviderRegistry.cs
  - ContextProviderRegistry.cs.meta
  - IContextProvider.cs
  - IContextProvider.cs.meta
  - ILogCollector.cs
  - ILogCollector.cs.meta
  - IScreenshotCapturer.cs
  - IScreenshotCapturer.cs.meta
  - IStateSnapshotCollector.cs
  - IStateSnapshotCollector.cs.meta
  - LogEntry.cs
  - LogEntry.cs.meta
  - LogRingBuffer.cs
  - LogRingBuffer.cs.meta
  - LogSerializer.cs
  - LogSerializer.cs.meta
  - RekonContext.cs
  - RekonContext.cs.meta
  - ReplayLogCollector.cs
  - ReplayLogCollector.cs.meta
  - ReplayMetadata.cs
  - ReplayMetadata.cs.meta
  - ScreenshotCapturer.cs
  - ScreenshotCapturer.cs.meta
  - ScreenshotQueue.cs
  - ScreenshotQueue.cs.meta
  - StateSnapshot.cs
  - StateSnapshot.cs.meta
  - StateSnapshotCollector.cs
  - StateSnapshotCollector.cs.meta
- - CaptureOrchestrator.cs
  - CaptureOrchestrator.cs.meta
  - CaptureProgressEvent.cs
  - CaptureProgressEvent.cs.meta
  - CaptureResult.cs
  - CaptureResult.cs.meta
  - IBundleStateUpdater.cs
  - IBundleStateUpdater.cs.meta
  - ICaptureOrchestrator.cs
  - ICaptureOrchestrator.cs.meta
  - RekonBootstrap.cs
  - RekonBootstrap.cs.meta
  - RekonCoroutineRunner.cs
  - RekonCoroutineRunner.cs.meta
  - SilentSubmitManager.cs
  - SilentSubmitManager.cs.meta
- - AbnormalExitDetector.cs
  - AbnormalExitDetector.cs.meta
  - CrashBundleRetentionPolicy.cs
  - CrashBundleRetentionPolicy.cs.meta
  - CrashBundleWriter.cs
  - CrashBundleWriter.cs.meta
  - ManagedExceptionHandler.cs
  - ManagedExceptionHandler.cs.meta
  - MappedFileWriter.cs
  - MappedFileWriter.cs.meta
  - PeriodicFlushManager.cs
  - PeriodicFlushManager.cs.meta
- - HotkeyManager.cs
  - HotkeyManager.cs.meta
  - IHotkeyProvider.cs
  - IHotkeyProvider.cs.meta
  - LegacyInputProvider.cs
  - LegacyInputProvider.cs.meta
  - NewInput.meta
- - JiraApiClient.cs
  - JiraApiClient.cs.meta
  - JiraIssueCreator.cs
  - JiraIssueCreator.cs.meta
  - JiraMetadataService.cs
  - JiraMetadataService.cs.meta
  - JiraSubmissionService.cs
  - JiraSubmissionService.cs.meta
- - IRekonHttpClient.cs
  - IRekonHttpClient.cs.meta
  - PendingUploadManager.cs
  - PendingUploadManager.cs.meta
  - R2Uploader.cs
  - R2Uploader.cs.meta
  - UnityHttpClient.cs
  - UnityHttpClient.cs.meta
- - PerformanceEvent.cs
  - PerformanceEvent.cs.meta
  - PerformanceSample.cs
  - PerformanceSample.cs.meta
  - PerformanceSnapshot.cs
  - PerformanceSnapshot.cs.meta
  - PerformanceTimeline.cs
  - PerformanceTimeline.cs.meta
  - PerformanceTimelineCollector.cs
  - PerformanceTimelineCollector.cs.meta
- - ClientRateLimiter.cs
  - ClientRateLimiter.cs.meta
  - LogMasker.cs
  - LogMasker.cs.meta
  - MaskingRuleLoader.cs
  - MaskingRuleLoader.cs.meta
  - TokenEncryptor.cs
  - TokenEncryptor.cs.meta
- - FilesJsonBuilder.cs
  - FilesJsonBuilder.cs.meta
  - R2UploadService.cs
  - R2UploadService.cs.meta
  - ReportSubmitService.cs
  - ReportSubmitService.cs.meta
- - RekonSettings.cs
  - RekonSettings.cs.meta
  - RekonSettingsProvider.cs
  - RekonSettingsProvider.cs.meta
- - CaptureOverlay.cs
  - CaptureOverlay.cs.meta
  - SubmitToast.cs
  - SubmitToast.cs.meta
- - FfmpegHelper.cs
  - FfmpegHelper.cs.meta
  - FfmpegProcessRunner.cs
  - FfmpegProcessRunner.cs.meta
  - FrameCapturer.cs
  - FrameCapturer.cs.meta
  - FrameData.cs
  - FrameData.cs.meta
  - FramePool.cs
  - FramePool.cs.meta
  - FrameRingBuffer.cs
  - FrameRingBuffer.cs.meta
  - IFfmpegProcessRunner.cs
  - IFfmpegProcessRunner.cs.meta
  - IFrameCapturer.cs
  - IFrameCapturer.cs.meta
  - IVideoEncoder.cs
  - IVideoEncoder.cs.meta
  - Mp4VideoEncoder.cs
  - Mp4VideoEncoder.cs.meta
  - StreamingVideoRecorder.cs
  - StreamingVideoRecorder.cs.meta
  - VideoEncoderConfig.cs
  - VideoEncoderConfig.cs.meta
  - VideoSegmentWriter.cs
  - VideoSegmentWriter.cs.meta
- Auth.meta
- Bundle.meta
- Capture.meta
- Core.meta
- CrashRecovery.meta
- Input.meta
- Jira.meta
- Network.meta
- Performance.meta
- Rekon.cs
- Rekon.cs.meta
- Rekon.Runtime.asmdef
- Rekon.Runtime.asmdef.meta
- Security.meta
- Services.meta
- Settings.meta
- UI.meta
- Video.meta
- - README.md
- masking-rules.json
- masking-rules.json.meta
- - CrashRecovery.meta
  - UI.meta
- - E2E.meta
  - Performance.meta
  - Rekon.IntegrationTests.asmdef
  - Rekon.IntegrationTests.asmdef.meta
  - Security.meta
- - Auth.meta
  - Bundle.meta
  - Capture.meta
  - Core.meta
  - CrashRecovery.meta
  - Input.meta
  - Jira.meta
  - Network.meta
  - Security.meta
  - UI.meta
  - Video.meta
- Editor.meta
- Integration.meta
- Rekon.Tests.asmdef
- Rekon.Tests.asmdef.meta
- Runtime.meta
.env.example
.gitignore
.upmignore
CHANGELOG.md
CHANGELOG.md.meta
Editor.meta
LICENSE
LICENSE.meta
package.json
package.json.meta
README.ko.md
README.ko.md.meta
README.md
README.md.meta
Runtime.meta
SECURITY.md
SECURITY.md.meta
Settings.meta
Tests.meta

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**English** | [한국어](./README.ko.md)

### When the bug hit, it was already recording.

The moment you press the hotkey, the last **~60 seconds of video, logs, and performance data** are already on disk.
A rolling buffer is always running — so pressing it *after* the bug happens is never too late.

[![Unity](https://img.shields.io/badge/Unity-2022.3%2B-black?logo=unity)](https://unity.com)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/RekonOps/Rekon-unity/main/LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-brightgreen.svg)](https://raw.githubusercontent.com/RekonOps/Rekon-unity/main/CHANGELOG.md)

![Rekon in action — press the hotkey, and the last 60s of video, the FPS graph, and console logs land aligned on one timeline](https://raw.githubusercontent.com/RekonOps/Rekon-unity/main/Documentation~/images/rekon-demo.gif)

▶ [Watch the full 60-second demo on YouTube](https://youtu.be/67jy1jBXn2c)

> In Play Mode, press `Ctrl/Cmd + Shift + B` → the last ~60s of video + screenshots + logs + game state (Scene/FPS/memory)
> is captured in one shot and lands on the web dashboard. Filing a Jira issue from there is one click.

```
# UPM Git URL (Package Manager > Add package from git URL...)
https://github.com/RekonOps/Rekon-unity.git#v1.0.0
```

---

## Sound familiar?

A non-technical QA writes in the ticket — **"The character looks weird."**

Holding one screenshot and that single line, you start debugging on guesswork.
Which scene it was, whether the FPS dropped, what hit the Console — nothing.
It won't reproduce, and the ticket gets closed as "cannot reproduce."

Rekon turns debugging that starts with guesses into **debugging that starts with evidence**.

---

## Why it's different

Existing tools try to find "the moment the bug happened" after the fact. Rekon starts from the premise that the moment is **already captured**.

### 1. Press after the fact — the last 60 seconds are still there

There is no record button. While you're in Play Mode, a rolling (ring) buffer keeps the most recent window at all times.
Even if you press the hotkey *after* seeing the bug, the last ~60 seconds of video are already on disk. (default 15fps · 1280×720)

> "I forgot to hit record" is structurally impossible.

### 2. Video and performance share one timeline

At any point in the captured video — that instant's **FPS drop**, **memory spike**, and **Console error** line up together.
The frame where the video "hitched" maps straight onto what the graphs were doing at that moment.

The 1-in-100 intermittent crash, the "only on that one device" bug — you see the moment on screen and in numbers, at the same time.

### 3. Unity context, in full

Scene name, device info, Unity version, frame rate, recent logs — the game state at the moment of capture is attached automatically.
This is Play Mode context that generic SDKs don't have.

---

## Invisible by design

Rekon is designed to be forgotten. No always-on overlay, no dashboard living inside your game.
It only appears when summoned by hotkey; otherwise it quietly keeps the rolling buffer turning. It doesn't break your flow.

---

## Installation

In Unity, open **Window > Package Manager > +  > Add package from git URL...** and enter:

```
https://github.com/RekonOps/Rekon-unity.git#v1.0.0
```

Or add it directly to `Packages/manifest.json`:

```json
{
  "dependencies": {
    "dev.rekonops.rekon": "https://github.com/RekonOps/Rekon-unity.git#v1.0.0"
  }
}
```

> Check [GitHub Releases](https://github.com/RekonOps/Rekon-unity/releases) for the latest version.

---

## Usage

Video capture is encoded with **FFmpeg**. It is not bundled with the package, so install it once per OS if you want video capture (PC/Mac — not supported on mobile):

| OS | Install |
|----|---------|
| **macOS** | `brew install ffmpeg` |
| **Windows** | `choco install ffmpeg` or `winget install ffmpeg` |
| **Linux** | `sudo apt install ffmpeg` (per your distro) |

> Rekon automatically searches PATH plus the default brew/choco/winget install locations (works even when the Unity editor doesn't inherit your shell PATH). Without FFmpeg, capture still works — screenshots and logs, just no video.

Once that's done, all you need is the hotkey.

1. A bug happens in **Play Mode**
2. **`Ctrl/Cmd + Shift + B`** — the last ~60 seconds are captured (configurable in Settings)
3. Enter a title and description → **[Save to Web]** → it lands on the web dashboard

Open the report on the dashboard and create the issue with the **[Send to Jira]** button.

> **Honest boundaries**: the Unity plugin only does *capture and save*. Connect Jira once from the web dashboard (`/settings/jira`). Unity never talks to Jira directly.

<details>
<summary>Web login / Jira integration internals (expand)</summary>

**Web login** — `Project Settings > Rekon > [Web Login]`
1. The plugin sends a `device_id` to the backend and receives a one-time login URL.
2. Your browser opens automatically and you sign in.
3. On completion, the token and workspace are saved to Settings automatically.
4. Settings shows **"Connected (workspace name)"**.

**Jira** — authenticate Jira Cloud OAuth in the web dashboard under `Settings > Jira`.
After that, the [Send to Jira] button is enabled on report detail pages.

</details>

---

## Settings (`Project Settings > Rekon`)

| Setting | Description | Default |
|---------|-------------|---------|
| Hotkey | Capture shortcut | `Ctrl/Cmd+Shift+B` |
| Video FPS | Frame capture rate | 15 |
| Video resolution | Capture resolution | 1280×720 |
| Log buffer | Number of recent logs kept | last N |
| Bundle retention | Max local bundle count/size | auto-pruned |
| Web connection | Login status and workspace name | disconnected |

---

## Why we built this

We've had tickets we couldn't close because the bug wouldn't reproduce.
We've closed tickets where QA wrote "the character looks weird" — without ever once seeing that moment.

The truth of that moment evaporates in 60 seconds. So we built something that keeps the evidence alive.

---

## Nothing gets lost

- **Offline auto-retry** — if the network drops, captures are stored locally (`pending/`) and retried in the background once you're back online (up to 3 attempts, exponential backoff). No data slips through the cracks.
- **Sensitive data masking** — emails, IPs, and tokens in logs are masked automatically.
- **Integrity verification** — every Release ships with SHA-256 checksums and a CycloneDX SBOM. You can verify the tarball yourself → [SECURITY.md](./SECURITY.md).
- **MIT OSS** — the code is open. Your evidence is never locked behind someone else's wall.

---

## Requirements

| Item | Requirement |
|------|-------------|
| Unity | 2022.3 LTS or newer |
| .NET | Standard 2.1 |
| FFmpeg | Required for video capture on PC/Mac — **not supported on mobile** |

> Video capture does not work in mobile builds. We're telling you up front.

---

## Contributing

Rekon is open source for transparency and distribution. **We're not accepting external pull requests at this time** — but bug reports and feature requests via [Issues](https://github.com/RekonOps/Rekon-unity/issues) are very welcome.

For security vulnerabilities, please use the private channels described in [SECURITY.md](SECURITY.md) instead of public issues.

## License

**MIT License** — see [LICENSE](LICENSE).

Rekon-unity

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README