Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Install Converters via OpenUPM

Kalle Jillheden edited this page Apr 28, 2020 · 7 revisions

Unity Package Manager, or UPM for short, is Unity's new solution for managing packages so they don't need to be included inside the /Assets folder.

Have a look at the Unity Package Manager docs for more info.

OpenUPM icon

OpenUPM is wonderful initiative by @favoyang that takes this one step further by providing a unified registry and command-line tool for distributing various packages supporting UPM deployment.

Versioning format

👀 Not using semantic versioning! Be aware of my crazy versioning scheme!

To use the package with Newtonsoft.Json, you must match the Major component of the versions for it to compile. The rest of the components are reserved for the iterations of the converters package, Newtonsoft.Json-for-Unity.Converters.

explanation of version

Example: To get a compatible mix of the official Json.NET 12.0.1, you would get..

  • jillejr.newtonsoft.json-for-unity 12.0.1xx
  • jillejr.newtonsoft.json-for-unity.converters 12.xx.xx

As long as the major version matches, i.e. the first integer in version components, then it will all work fine.

Prerequisites

  1. You already have installed Newtonsoft.Json installed to your Unity project.

    You may visit the any of the "Getting started > Install Newtonsoft.Json-for-Unity" wiki pages to install that beforehand.

  2. OpenUPM icon OpenUPM-CLI

Installing the package (Cloudsmith registry)

Requires Unity Editor 2018.1 or above, as UPM was first shipped with 2018.1.

✔ This is the recommended solution.

Run the following on the command line:

openupm --registry https://npm.cloudsmith.io/jillejr/newtonsoft-json-for-unity/ add jillejr.newtonsoft.json-for-unity.converters

Installing the package (OpenUPM registry)

//not yet available

Updating the package

Updating the UPM package, even if installed via OpenUPM, is identical to the instructions found in the wiki page Installation via UPM - Updating the package.