Skip to content

Newtonsoft.Json (Json.NET) 12.0.3 for Unity IL2CPP builds, available via Unity Package Manager

License

Notifications You must be signed in to change notification settings

xabio/Newtonsoft.Json-for-Unity

 
 

Repository files navigation

Logo Newtonsoft.Json for Unity

Latest Version @ OpenUPM Latest Version @ Cloudsmith CircleCI Codacy grade Financial Contributors on Open Collective Contributor Covenant

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

Installation

Installation via Package Installer (experimental)

  1. Click here to download Install-jillejr.newtonsoft.json-for-unity-12.0.302.unitypackage

  2. Open the downloaded .unitypackage file in Unity. Easiestly done by drag'n'dropping the file into the Unity window.

  3. Click "Import" to import it all.

  4. Once the installer has successfully compiled, it will add the correct UPM registry and package to your project, followed by removing itself.

The installer does not run until your project can successfully compile. Make sure to resolve all syntax- and other compiling errors, even just temporarily, so that the installer may execute.

Much love ❤️ to @needle-tools for making such a great tool!

Installation via OpenUPM OpenUPM icon

openupm add jillejr.newtonsoft.json-for-unity

Full installation guide over at the wiki: Installation via OpenUPM OpenUPM icon

Much love ❤️ to @favoyang for making such a great tool!

Installation via pure UPM

Full installation guide over at the wiki: Installation via pure UPM

Installation via Git in UPM

You can also install via Git. This assumes you have Git installed on your computer.

This is the least recommended version (but works as a fallback) because:

  • You will not be able to update the package via the Package Manager interface if you install via Git.

  • This requires you, your coworkers, and your CI/CD pipelines to have Git installed for the project to build.

  • It takes a lot longer to install as UPM will in most version clone the entire history of the project.

In later versions of Unity, you can import directly via the Package Manager interface.

UPM, add from Git URL dropdown

Supply the following URL:

https://github.com/jilleJr/Newtonsoft.Json-for-Unity.git#upm

Full installation guide over at the wiki: Installation via Git in UPM

Newtonsoft.Json-for-Unity specific links

Newtonsoft.Json links

Contributing

Thankful that you're even reading this :)

If you want to contribute, here's what you can do:

  • Spread the word! ❤ More users → more feedback → I get more will-power to work on this project. This is the best way to contribute!

  • Open an issue. Could be a feature request for a new converter, or maybe you've found a bug?

  • Tackle one of the unassigned issues. If it looks like a fun task to solve and no one is assigned, then just comment on it and say that you would like to try it out.

    I realize that few of the issues are trivial, so if you wish to tackle something small then look at the list of unassigned issues over at the Unity converters package repoistory.

  • Open a PR with some new feature or issue solved. Remember to ask before starting to work on anything, so no two are working on the same thing.

    Having a feature request or issue pop up and having the submitter suggesting themselves to later add a PR for a solution is the absolute greatest gift a repository maintainer could ever receive. 🎁

    I have this CONTRIBUTING.md file that contains some guidelines. It may be good to read it beforehand.

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.

Prerequisites

  • Powershell:

    For Linux users, install the dotnet CLI and then install the powershell tool:

    # This will install the command `pwsh`
    dotnet tool install --global powershell
  • Docker

Building

./ci/local_build_into_package.ps1

This script will compile the project into the Src/Newtonsoft.Json-for-Unity/Plugins directory using Docker images.

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.

Shameless plug

This project, giving a stable Newtonsoft.Json experience to the Unity community, is a hobby project for me and will always stay free.

If this tool gave you something you value, consider giving a coin back into this tool. Sponsor me with a cup of coffee, I drink the cheap stuff! ☕

OpenCollective donar link


This package is licensed under The MIT License (MIT)

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

See full copyrights in LICENSE.md inside repository

About

Newtonsoft.Json (Json.NET) 12.0.3 for Unity IL2CPP builds, available via Unity Package Manager

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.2%
  • Other 0.8%