PlayCover

https://docs.playcover.io
Admin
PlayCover is software that allows running iOS apps and games on Apple Silicon Macs with custom...
Tokens:6,578
Snippets:126
Trust Score:8.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install SwiftLint

Source: https://docs.playcover.io/building_from_source/install_prerequisites

Execute this command in the Terminal to install SwiftLint, a tool for enforcing Swift style and conventions.

```bash
brew install swiftlint
```

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

### Install PlayCover via Homebrew

Source: https://docs.playcover.io/getting_started/download_playcover

Commands to add the PlayCover tap and install the stable community version.

```bash
brew tap PlayCover/playcover
brew install --cask playcover-community
```

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

### Update Homebrew and Install Carthage

Source: https://docs.playcover.io/building_from_source/install_prerequisites

Run this command in the Terminal to update Homebrew and install the Carthage dependency manager.

```bash
brew update && brew install carthage
```

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

### Alternative nvram boot-args for Login

Source: https://docs.playcover.io/getting_started/troubleshoot_login

If the primary boot-args do not resolve login issues, try this alternative command. This may be necessary for specific application compatibility.

```bash
sudo nvram boot-args="amfi_get_out_of_my_way=1"
```

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

### Re-enable System Integrity Protection (SIP)

Source: https://docs.playcover.io/getting_started/troubleshoot_login

After successfully logging in, use this command in the Terminal during startup options to re-enable SIP for system security.

```bash
csrutil enable
```

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

### Clear nvram boot-args

Source: https://docs.playcover.io/getting_started/troubleshoot_login

Use this command to fully revert the boot-args changes if necessary. This is typically not required for most users but can be done for a clean state.

```bash
sudo nvram boot-args=""
```

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

### Remove Keymap, Settings, and Entitlements Directories

Source: https://docs.playcover.io/other_features/playcover_settings

Details the specific files cleared for 'Remove keymap', 'Remove settings', and 'Remove entitlements' during app uninstallation. Replace the bundle ID as needed.

```shell
~/Library/Containers/io.playcover.PlayCover/Keymapping/<com.bundle.id>.plist
~/Library/Containers/io.playcover.PlayCover/App Settings/<com.bundle.id>.plist
~/Library/Containers/io.playcover.PlayCover/Entitlements/<com.bundle.id>.plist
```

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

### Clone PlayCover Repository

Source: https://docs.playcover.io/building_from_source/building

Use git clone to download the PlayCover source code to your local machine. This is the recommended method for development.

```bash
git clone https://github.com/PlayCover/PlayCover.git
```

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

### Disable System Integrity Protection (SIP)

Source: https://docs.playcover.io/getting_started/troubleshoot_login

Use this command in the Terminal during startup options to disable SIP. This is a prerequisite for modifying boot arguments.

```bash
csrutil disable
```

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

### Modify nvram boot-args for Login

Source: https://docs.playcover.io/getting_started/troubleshoot_login

Execute this command in the Terminal after disabling SIP to enable necessary bypasses for certain applications. Restart your Mac after applying.

```bash
sudo nvram boot-args="amfi_get_out_of_my_way=0x1 ipc_control_port_options=0"
```

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

### Clear Data Directories for App Uninstall

Source: https://docs.playcover.io/other_features/playcover_settings

Specifies directories cleared when 'Clear data' is selected during app uninstallation. Ensure the bundle ID is correctly replaced.

```shell
~/Library/Application Scripts/<com.bundle.id>
~/Library/Caches/<com.bundle.id>
~/Library/Containers/<com.bundle.id>
~/Library/HTTPStorages/<com.bundle.id>
~/Library/Saved Application State/<com.bundle.id>
```

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

### Default Directories for Apple Sandbox Profiles

Source: https://docs.playcover.io/miscellaneous/entitlements

These directories contain Apple's default sandbox profiles and can be useful when creating new sandbox profiles for PlayCover applications.

```text
/Library/Sandbox/Profiles
/System/Library/Sandbox/Profiles
/usr/share/sandbox
```

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

### Uninstall PlayCover via Homebrew

Source: https://docs.playcover.io/getting_started/download_playcover

Commands to remove the PlayCover cask and untap the repository.

```bash
brew uninstall --cask playcover-community
brew untap PlayCover/playcover
```

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

### Commit Changes

Source: https://docs.playcover.io/contributing/forking_making_pr

Stage and commit your code changes with a descriptive message. This records your progress and explains the purpose of the commit.

```git
git commit -m 'Add some AmazingFeature'
```

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

### IPA Source JSON Structure

Source: https://docs.playcover.io/other_features/ipa_library

This is the required JSON structure for an IPA source file. Each object represents an app, with 'link' needing to end in '.ipa'. The 'itunesLookup' field is optional.

```json
[
    {
        "bundleID": "xyz.skitty.Aidoku",
        "name": "Aidoku",
        "version": "0.5",
        "itunesLookup": "",
        "link": "https://github.com/Aidoku/Aidoku/releases/download/v0.5/Aidoku.ipa"
    }
]
```

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

### Create a Feature Branch

Source: https://docs.playcover.io/contributing/forking_making_pr

Before making changes, create a new branch for your feature. This isolates your work from the main codebase.

```git
git checkout -b feature/AmazingFeature
```

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

### Push to Branch

Source: https://docs.playcover.io/contributing/forking_making_pr

Upload your committed changes to your fork on the remote repository. This makes your feature branch accessible for creating a pull request.

```git
git push origin feature/AmazingFeature
```
Tokens:
Raw