RocketSim Documentation

https://docs.rocketsim.app
Admin
RocketSim is a tool for simulating app features, comparing designs, and monitoring network traffic....
Tokens:9,924
Snippets:16
Trust Score:8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Integrate RocketSim Connect via Breakpoint

Source: https://docs.rocketsim.app/9173248f5a7c45beb3638580d2680a54

This method allows integrating RocketSim Connect by setting a symbolic breakpoint for `UIApplicationMain` in Xcode. A debugger command is used to dynamically load the RocketSim Connect linker framework at runtime.

```shell
expr (void *)dlopen("/Applications/RocketSim.app/Contents/Frameworks/RocketSimConnectLinker.nocache.framework/RocketSimConnectLinker", 0x2)
```

--------------------------------

### Integrate RocketSim Connect via Breakpoint

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/introduction--setup/iXHZvJWvedgZuVTN5V3YS1

This method allows integrating RocketSim Connect by setting a symbolic breakpoint for `UIApplicationMain` in Xcode. A debugger command is used to dynamically load the RocketSim Connect linker framework at runtime.

```shell
expr (void *)dlopen("/Applications/RocketSim.app/Contents/Frameworks/RocketSimConnectLinker.nocache.framework/RocketSimConnectLinker", 0x2)
```

--------------------------------

### Integrate RocketSim Connect via Breakpoint

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/introduction/iXHZvJWvedgZuVTN5V3YS1

This method allows integrating RocketSim Connect by setting a symbolic breakpoint for `UIApplicationMain` in Xcode. A debugger command is used to dynamically load the RocketSim Connect linker framework at runtime.

```shell
expr (void *)dlopen("/Applications/RocketSim.app/Contents/Frameworks/RocketSimConnectLinker.nocache.framework/RocketSimConnectLinker", 0x2)
```

--------------------------------

### Run systemextensionsctl list for RocketSim Troubleshooting

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

This terminal command lists all system extensions currently installed on your system. It is used to gather diagnostic information when network speed control issues persist after other troubleshooting steps. The output should be shared with support for further analysis.

```shell
systemextensionsctl list
```

--------------------------------

### Copy Color as Code

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/magnifier/b2La1KT6b3cKuPHjqWkg9N

Demonstrates the code representations for a specific color value obtained using the Magnifier's 'Copy as code' feature. It shows how to represent the color in Swift's Color, UIKit's UIColor, and AppKit's NSColor.

```Swift
Color(red: 0.32, green: 0.32, blue: 0.32)
```

```Objective-C
UIColor(red: 0.32, green: 0.32, blue: 0.32, alpha: 1.0)
```

```Objective-C
NSColor(red: 0.32, green: 0.32, blue: 0.32, alpha: 1.0)
```

--------------------------------

### xcrun simctl Comparison

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

RocketSim utilizes the `xcrun simctl` command-line tool but enhances its output and provides interfaces for quicker access. For instance, recordings are improved with touches and device bezels, which are not available through the standard command-line tools.

```APIDOC
xcrun simctl:
  Description: A command-line tool for controlling and managing iOS simulators.
  Enhancements by RocketSim:
    - Enriched recording output (e.g., touches, device bezels).
    - Provides interfaces for quicker access to simulator features.
  Limitations compared to RocketSim:
    - Lacks enhanced recording features.
    - Does not offer the same level of user-friendly interfaces.
```

--------------------------------

### Troubleshooting Launch Argument

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/simulator-camera-support/58tQ5jvevLNSnyUEA7VgAv

To enable detailed debug logs for troubleshooting camera simulation issues, add a specific launch argument to your app's configuration. This helps in identifying and resolving edge cases.

```APIDOC
Launch Argument:
  -com.swiftlee.rocketsim.debug 1

Description:
  Adds a debug flag to the application's launch arguments to enable verbose logging for RocketSim's camera simulation feature. This is crucial for diagnosing issues and providing detailed logs when reporting bugs.
```

--------------------------------

### RocketSim Camera Simulation - Known Issues

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/simulator-camera-support/58tQ5jvevLNSnyUEA7VgAv

Details on current limitations and known issues with the RocketSim Camera Simulation feature, including resolution discrepancies, lack of audio in videos, camera switching behavior, and compatibility with specific view controllers.

```APIDOC
Known Issues:

1.  **Resolution Mismatch**:
    -   Description: The macOS camera resolution is used as the resolution for returned sample buffers. This means the captured frames will not match the resolution of the original (Simulator) device camera.

2.  **No Audio in Videos**:
    -   Description: Video recordings captured using the simulator camera do not contain any audio.

3.  **Camera Switching**:
    -   Description: Switching between 'front' and 'back' cameras has no effect, as only one camera source is available to the simulator.

4.  **DataScannerViewController Compatibility**:
    -   Description: The `DataScannerViewController` does not currently work with the simulator camera simulation. Refer to issue #769 on the project's GitHub repository for more details.
```

--------------------------------

### App Store Video Acceptance Specifications

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

Videos submitted to App Store Connect for app previews must adhere to specific technical specifications. Not all simulator devices are supported for these previews, so users should select a simulator that matches the approved device list.

```APIDOC
App Store Video Acceptance:
  Specifications:
    - Must follow App Previews specifications (refer to Apple's documentation).
  Device Compatibility:
    - Not all simulator devices are accepted.
  Recommendation:
    - Use a Simulator that matches a device listed in the App Preview specifications.
  Reference:
    - [Apple's App Store Connect Documentation](https://help.apple.com/app-store-connect/?lang=en/#/dev4e413fcb8)
```

--------------------------------

### App Store Connect Optimization Requirements

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

App Store Connect (ASC) requires specific image formats for optimization, particularly JPEG without an alpha layer, to ensure compatibility and efficient processing for app previews.

```APIDOC
App Store Connect (ASC) Optimization:
  Image Format Requirement:
    - Type: JPEG
    - Constraint: Must not contain an alpha layer.
  Purpose:
    - Ensures compatibility with App Store Connect's requirements for app preview images.
  To get PNG images:
    - Disable the 'App Store Connect (ASC) Optimization' option.
```

--------------------------------

### RocketSim Screen Recording Permissions

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

RocketSim requires screen recording permissions to read the titles of Simulator windows, which is essential for identifying the currently active Simulator instance. This permission is necessary because RocketSim operates in a sandboxed environment.

```APIDOC
RocketSim Permissions:
  Required Permission:
    - Type: Screen Recording
  Justification:
    - Enables RocketSim to read NSWindow titles.
    - Essential for determining the active Simulator window.
  Context:
    - Necessary due to RocketSim's sandboxed nature.
```

--------------------------------

### Transparent Captures Configuration

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/faq/p3eKWj5LcsvBE7AqGuSty9

To create transparent captures with RocketSim, users need to disable a specific optimization setting and configure the simulator's background color.

```APIDOC
Transparent Captures:
  Configuration Steps:
    1. Disable 'App Preview Optimized' setting.
    2. Set the simulator's background color to transparent.
  Result:
    - Enables the creation of captures with transparent backgrounds.
```

--------------------------------

### Pulse Framework - Open Source Network Logger

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/network-traffic-monitoring/guS2qEK2RWWc3coihRQXZT

RocketSim's network monitoring capabilities are built upon the open-source Pulse framework. Pulse provides advanced network logging features, including filtering and response inspection, and is available for integration into your projects.

```APIDOC
Pulse Framework:
  - Open-source library for network logging.
  - Developed by Alex Grebenyuk.
  - Provides advanced features like mocking, filtering, and response inspection (in Pulse Pro).

Repository:
  - https://github.com/kean/Pulse

Related Product:
  - Pulse Pro: For more advanced features.
  - https://pulselogger.com/
```

--------------------------------

### Submit Feature Requests on GitHub

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/requesting-a-feature/vL5fkJfxG6xD1RcZcivb9q

RocketSim uses a public GitHub repository to manage feature requests, allowing users to submit ideas and track their progress. This mirrors common development workflows for open-source and community-driven projects.

```APIDOC
GitHub Repository for Feature Requests:
  URL: https://github.com/AvdLee/RocketSimApp/issues
  Purpose: To collect, discuss, and track user-submitted feature requests and improvements for RocketSim.
  Usage:
    - Create a new issue for each distinct feature request.
    - Provide a clear title and detailed description of the desired functionality.
    - Use existing issues to add comments or upvotes if your request is similar.
  Related Actions:
    - Voting on the public roadmap to prioritize development.
```

--------------------------------

### RocketSim Connect Network Monitoring Mechanism

Source: https://docs.rocketsim.app/features/hzQMSrSga7BGWvxdNVdwYs/network-traffic-monitoring/guS2qEK2RWWc3coihRQXZT

RocketSim Connect integrates by loading a dynamic library at runtime. This library intercepts network requests by swizzling URLSession methods, enabling the monitoring of in- and outgoing network activity within your application.

```APIDOC
RocketSim Connect Integration:
  - Loads a dynamic library at runtime.
  - Swizzles URLSession methods (e.g., dataTaskWithRequest:completionHandler:).
  - Captures network requests and responses.

Dependencies:
  - RocketSim Connect framework.

Functionality:
  - Monitors in- and outgoing network requests.
  - Displays request details, responses, and failure reasons.

Limitations:
  - Does not support configuring breakpoints.
  - Does not support adjusting responses before they return to the app.
```

--------------------------------

### RocketSim Public Roadmap Voting

Source: https://docs.rocketsim.app/support/4FNpAbMLD25WbYwAhdxd37/requesting-a-feature/vL5fkJfxG6xD1RcZcivb9q

Users can influence the development direction of RocketSim by voting on features listed in the public roadmap. This process helps the developers prioritize building the most requested improvements.

```APIDOC
Accessing and Voting on the RocketSim Roadmap:
  Steps:
    1. Open the Status Bar Menu within the RocketSim application.
    2. Select the 'Roadmap' option.
    3. Submit your votes for desired features.
  Purpose: To provide community feedback and guide the prioritization of future RocketSim features.
  Outcome: Ensures development efforts align with user needs and popular demand.
```
Tokens:
Raw