tsira / Newtonsoft.Json-for-Unity

Newtonsoft.Json (Json.NET) 12.0.3 for Unity via Unity Package Manager

Newtonsoft.Json for Unity

Json.NET is a popular high-performance JSON framework for .NET and the most used framework throughout the whole .NET ecosystem.

This repo is a fork of JamesNK/Newtonsoft.Json containing custom builds for regular standalone, but more importantly AOT targets such as all IL2CPP builds (WebGL, iOS, Android, Windows, Mac OS X) and portable .NET (UWP, WP8).

Features

• Expected always up-to-date fork of Newtonsoft.Json

• Full Newtonsoft.Json.Tests test suite passes on Unity 2018.4.14f1 and 2019.2.11f1 with Mono and IL2CPP as scripting backend.

• Precompiled as DLLs for faster builds

• Full support for IL2CPP builds

• Delivered via Unity Package Manager for easy updating and version switching

• Newtonsoft.Json.Utility.AotHelper utility class for resolving common Ahead-Of-Time issues. (Read more about AOT)

• Extensive documentation of solving AOT issues with link.xml

Installation guide

Click the header. It goes to the Wiki where the guide is now located. Here is the raw url:

• Installation via UPM

• Installation via OpenUPM

Newtonsoft.Json-for-Unity specific links

• Wiki about this project
• Release Notes on GitHub from this repository
• Cloudsmith package

Official Json.NET links

• Source repository (github.com/JamesNK/Newtonsoft.Json)
• Homepage (www.newtonsoft.com/json)
• Documentation (www.newtonsoft.com/json/help)
• Release Notes on GitHub from source repository
• Stack Overflow posts tagged with json.net

Contributing

To contribute please read the CONTRIBUTING.md guidelines. It contains info about

• How to edit the Src/Newtonsoft.Json projects to remain the ability to merge from JamesNKs repository without difficulties.

• Coding style.

• Naming style.

• Our level of usage of "git-flow".

• Keep the repo clean, both code & branches.

Development

Edit code

Open the Src/Newtonsoft.Json.sln solution file in Visual Studio and start hacking.

Rule of thumb: Don't commit edits of the Src/Newtonsoft.Json/, Src/Newtonsoft.Json.Tests/, or Src/Newtonsoft.Json.TestConsole/ folders for forking reasons. Exception is when doing a new release, as explained in a section little further down below.

Build

When using Visual Studio, open the Src/Newtonsoft.Json.sln solution and just Ctrl+Shift+B 😜

When using command line, recommended to use MSBuild.exe for building and not the dotnet CLI.

PS> MSBuild.exe -t:build -restore .\Src\Newtonsoft.Json -p:Configuration=Debug

Run tests

Run the Newtonsoft.Json.Tests normally via the Test Runner inside Visual Studio.

For testing inside Unity locally, look inside the Src/Newtonsoft.Json-for-Unity.Tests/README.md for more information.

Merging changes from JamesNK/Newtonsoft.Json

Common enough occurrence that we have a wiki page for just this.

Read the Working with branches, section "Merging changes from JamesNKs repo" wiki page.

---

This package is licensed under The MIT License (MIT)

Copyright © 2019 Kalle Jillheden (jilleJr)
https://github.com/jilleJr/Newtonsoft.Json

See full copyrights in LICENSE.md inside repository