Updating and Uninstalling

Updating and Uninstalling

Check for a new OpenJoystickDriver version, and remove the app and its data when you no longer need them.

Note: This page applies to OpenJoystickDriver 0.6.0-alpha.1 and later. Version 0.5.0-beta.4 and earlier do not have all of the features on this page.

Contents

• Update
  • How Update Checks Work
  • Release Builds and Tester Builds
  • Check For Updates
  • Install a New Version
  • Get a Fix
• Uninstall
  • Remove the App
  • Files That Stay On Your Mac
  • Remove the Data
• Further Reading

Update

This section explains how to check for a new OpenJoystickDriver (OJD) version and how to get a fix.

How Update Checks Work

OJD checks for updates only when you ask. It has no timer and does not check in the background. An update check never downloads or installs anything.

A check reads the version tags of the OJD repository on GitHub and reports the highest version. By default it ignores prerelease versions. All current releases are prereleases (0.5.0-beta.*), so a default check may find nothing. To include prereleases, turn on Include prerelease updates in Settings. In the command line, add --prerelease to update check.

When a newer version exists, View Update opens the tag page in your browser. You download and install the new version yourself.

Release Builds and Tester Builds

A release build is a public DMG named OpenJoystickDriver-VERSION-macOS.dmg. The maintainer notarizes it.

A tester build is a private, notarized DMG that the maintainer sends to testers. It contains a fix that is not in a release yet. It also contains OpenJoystickDriver-TESTER-BUILD.txt, which names the commit and the build version. A tester build version has the form VERSION+build.NUMBER.sha.COMMIT.

An update check does not find tester builds. The maintainer sends them directly.

Check For Updates

1. Open OJD.
2. Open Settings.
3. In Updates, click Check Now.
4. If the result is Update available, click View Update.

To check from the terminal, run the following command. Add --prerelease to include prerelease versions.

ojd update check

Install a New Version

1. Quit OJD.
2. Open the new DMG.
3. Drag OpenJoystickDriver to Applications. Replace the old app when macOS asks.
4. Open OJD.

Your profiles stay in place because they are stored outside the app.

Get a Fix

If a bug is fixed in the source but not yet released, you have two options:

• Wait for the next tester build.
• Build the branch yourself. For more information, see Building OpenJoystickDriver.

The CHANGELOG.md file in the repository lists what each build contains.

Uninstall

This section explains how to remove OpenJoystickDriver (OJD) and the files it leaves on your Mac.

Removing the app alone leaves a login item, privacy entries, a system extension, and data files. Follow the steps in order.

Remove the App

1. Turn off the login item. Run the following command.

   ojd setting set launchAtLogin false

2. If you approved the OJD driver extension, remove it. In Overview, on the Xbox USB Driver card, click Uninstall. Or run the following command.

   ojd extension deactivate

3. Quit OJD from the menu bar item.

4. Move OpenJoystickDriver from Applications to the Trash.

Both commands work only from the copy in /Applications.

Files That Stay On Your Mac

Removing the app does not remove these items.

Item	Location
Profiles and profile backups	~/Library/Application Support/OpenJoystickDriver/
Your controller records	~/Library/Application Support/OpenJoystickDriver/Controllers/
Logs	~/Library/Logs/OpenJoystickDriver/
Settings	Preferences domain com.openjoystickdriver
Privacy entries	System Settings > Privacy & Security

Each profile is a file in Profiles/, and ActiveProfiles.json lists the active profiles. Files whose names contain .backup- are recovery copies.

Remove the Data

1. Remove the folder ~/Library/Application Support/OpenJoystickDriver.

2. Remove the folder ~/Library/Logs/OpenJoystickDriver.

3. Remove the settings. Run the following command.

   defaults delete com.openjoystickdriver

4. In System Settings > Privacy & Security, remove OpenJoystickDriver from Input Monitoring and Accessibility. Select the entry and click the minus button.

Note

Export the profiles you want to keep before you remove the data. For more information, see Importing and exporting profiles.

The notification entry stays in System Settings > Notifications. Not verified: whether macOS removes it by itself.

Further Reading

• Known issues
• Reporting a bug
• Permissions and security