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

👀 Be aware of my crazy versioning scheme!

Not using semantic versioning. As Unity does not support assembly binding redirects, this repo was forced to have multiple releases one for each version of Newtonsoft.Json.

As Newtonsoft.Json assemblies only have major version defined (ex: 12.0.1, 12.0.2, and 12.0.3 all technically have assembly version 12.0.0.0) then we are able to abuse that and only having to re-publish this package once for every major Json .NET version.

Therefore, the major version is reserved to mimic the Newtonsoft.Json major version. As such, we're masking out the major in our versions.

  • The first release of Newtonsoft.Json-for-Unity.Converters is x.1.0.
  • To use together with Newtonsoft.Json 12.0.3, use the UPM version 12.1.0

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.