ml-opensource / reality-check Goto Github PK

Level up your AR development workflow with RealityCheck: an open-source Mac app for streamlined debugging and real-time preview of AR projects built with RealityKit

Swift 98.52% Metal 0.97% C 0.51%

augmented-reality composable-architecture debug ios macos realitykit swift spatial-computing

reality-check's Introduction

RealityCheck

Important If you are looking to use RealityCheck with visionOS, take a look to the feature/visionOS branch. It is nearing completion and will soon be merged 🥽

RealityCheck is an open-source Mac app designed to help AR development teams streamline their workflows and improve the quality of their projects. It provides a debugger for RealityKit, a powerful framework for building AR experiences, that allows developers to inspect the Entity Component System (ECS) structure and properties, and make changes in real-time for preview/debug purposes.

Features

Inspect and modify entity and component properties in real-time for debugging and preview purposes
Stream the current state of your AR app to the RealityCheck debugger in real-time
Support for custom representations for different types of properties, such as transform matrices and light intensity
Built with SwiftUI and The Composable Architecture for clean, modular code and a great user experience

Getting Started

To use RealityCheck in your AR project, you'll need to import the RealityCheck library and connect to a live session running on an iOS device. Please refer to the Documentation for detailed instructions on how to integrate RealityCheck into your project.

Thanks

Yasuhito Nagatomo is an inspiration with the highly useful RealityDump.swift helper and his many contributions to the field.

Max Cobb thanks for all your articles and repositories. Many roadblocks have been cleared up because of this.

Andy Jazz there's no related question in stack overflow that he hasn't answered (and many times created) in the best way possible.

Contributing

We welcome contributions from the AR development community! If you'd like to contribute to RealityCheck, please see our Contributing Guidelines for instructions on how to get started.

License

RealityCheck is released under the MIT License.

Contact

If you have any questions or feedback about RealityCheck, please contact us at [[email protected]]. We'd love to hear from you!

That's just a rough example, but I hope it gives you an idea of what to include in your README. Let me know if you have any questions or need any further assistance!

References

reality-check's People

Contributors

Stargazers

Watchers

reality-check's Issues

Display ModelComponent selection

When an entity with a model component is selected in the navigator, some visual and audio announcement would be helpful to connect action and effect.
Library to consider: https://github.com/gonchar/GoncharKit

Filter by Entity type

When added 'Statistics' or try to stop recording without permission cause app crashed

Device: iPhone 15 Pro Max
iOS version: 17.2

Xcode version: 15.1

The first error report:
Error message:
-[MTLDebugRenderCommandEncoder validateCommonDrawErrors:]:5775: failed assertion `Draw Errors Validation
Vertex Function(vsSdfFont): the offset into the buffer viewConstants that is bound at buffer index 4 must be a multiple of 256 but was set to 61840.

How to reproduce:
After all set, add 'Statistics' on the 'ARView debug Option', then the iOS app crashed

The second error report:
Error message:
-[RPScreenRecorder stopCaptureWithHandler:]:555 failed to stop in app capture because we're not recording

How to reproduce:
When I tap record on the iPhone, it will ask for my permission, even if I do not grant it, it still works fine. When I pressed the button to try to stop recording, the iOS app crashed.

Consider using ScreenCaptureKit
CGWindowListCopyWindowInfo(::) can help to restrict captures to simulator

// Define a function to capture the screen of the Xcode simulator app window
func captureSimulatorWindow() {
    let targetAppName = "Simulator"  // The name of the Xcode simulator app
    
    if let windowList = CGWindowListCopyWindowInfo(.optionOnScreenOnly, kCGNullWindowID) as? [[String: AnyObject]] {
        for window in windowList {
            if let windowOwnerName = window[kCGWindowOwnerName] as? String, windowOwnerName.contains(targetAppName) {
                if let windowID = window[kCGWindowNumber] as? CGWindowID {
                    let screenCaptureSession = ScreenCaptureSession(windowID: windowID)
                    
                    // Start the screen capture session for the Xcode simulator window
                    screenCaptureSession.startCapture { image, error in
                        if let image = image {
                            // Process the captured image
                            // For example, you can save the image to a file
                            saveImageToFile(image: image)
                        } else if let error = error {
                            // Handle the error
                            print("Error capturing the simulator window: \(error.localizedDescription)")
                        }
                    }
                }
            }
        }
    }
}