Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/applejag/Newtonsoft.Json-for-Unity
Newtonsoft.Json (Json.NET) 10.0.3, 11.0.2, 12.0.3, & 13.0.1 for Unity IL2CPP builds, available via Unity Package Manager
https://github.com/applejag/Newtonsoft.Json-for-Unity
hacktoberfest newtonsoft-json unity-package-manager unity3d unity3d-plugin upm
Last synced: 3 months ago
JSON representation
Newtonsoft.Json (Json.NET) 10.0.3, 11.0.2, 12.0.3, & 13.0.1 for Unity IL2CPP builds, available via Unity Package Manager
- Host: GitHub
- URL: https://github.com/applejag/Newtonsoft.Json-for-Unity
- Owner: applejag
- License: mit
- Archived: true
- Fork: true (JamesNK/Newtonsoft.Json)
- Created: 2019-04-12T20:50:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-03T20:38:49.000Z (over 2 years ago)
- Last Synced: 2024-05-21T07:36:10.160Z (6 months ago)
- Topics: hacktoberfest, newtonsoft-json, unity-package-manager, unity3d, unity3d-plugin, upm
- Language: C#
- Homepage: https://github.com/jilleJr/Newtonsoft.Json-for-Unity
- Size: 32.5 MB
- Stars: 1,095
- Watchers: 18
- Forks: 120
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
#  Newtonsoft.Json for Unity
[](https://openupm.com/packages/jillejr.newtonsoft.json-for-unity/)
[](https://cloudsmith.io/~jillejr/repos/newtonsoft-json-for-unity/packages/detail/npm/jillejr.newtonsoft.json-for-unity/latest/)
[](https://circleci.com/gh/jilleJr/Newtonsoft.Json-for-Unity)
[](https://www.codacy.com/manual/jilleJr/Newtonsoft.Json-for-Unity?utm_source=github.com&utm_medium=referral&utm_content=jilleJr/Newtonsoft.Json-for-Unity&utm_campaign=Badge_Grade)
[](https://opencollective.com/newtonsoftjson-for-unity)
[](/CODE_OF_CONDUCT.md)
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][newtonsoft.json.git]
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)**.
## ⚠ Deprecation warning
Since late February 2022, **Unity has now published an updated version of their
package**: [`[email protected]`](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)
Their package, since v2.0.0-preview.1, is a fork of this fork of
Newtonsoft.Json. This is still true for their latest release of v3.0.1. This
means that by switching over to their official package you will get:
- The `Newtonsoft.Json.Utilities.AotHelper` type I forked from SaladLab that has
been a core part of this fork since the get-go.
- All my IL2CPP and managed code stripping specific bugfixes.
- Continue to use an up-to-date fork of Newtonsoft.Json, but now kept up-to-date
by Unity employees instead of me.
- Also, it's practically always included in newer versions of Unity as many of
Unity's internal packages depend on it, so you probably don't even have to
install it any more!
I will continue to provide as much support as I can bare in my free time in the
[issues](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/issues) and
[discussions](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/discussions),
however, **please focus your support tickets towards ,
, and .**
To get started with their official package, you can follow my installation guide
here:
### [Installing the official UPM package](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Install-official-via-UPM)
---
---
---
## Features
- Provides Newtonsoft.Json v10.0.3, v11.0.2, v12.0.3, and v13.0.1 alternatives.
- [Newtonsoft.Json-for-Unity.Converters][json.net-4-unity.converters]
package for converting Unity types, such as the Vector3, Quaternion, Color,
and [many, many more!][json.net-4-unity.converters-compatability]
- Full support for IL2CPP builds
- Delivered via Unity Package Manager for easy updating and version switching
- 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
- [_Newtonsoft.Json.Utility_.**AotHelper**][wiki-fix-aot-using-aothelper]
utility class for resolving common Ahead-Of-Time issues.
[(Read more about AOT)][wiki-what-even-is-aot]
- Extensive [documentation of solving AOT issues with `link.xml`][wiki-fix-aot-using-link.xml]
## Frequently asked questions (FAQ)
### Is this project dead? I see no activity in a long time
Yes. Now it is. Ever since Unity adopted this package since late February 2022
to provide an officially maintained Newtonsoft.Json package to the Unity
ecosystem. ♥
My goal was before to be the most up-to-date fork of Newtonsoft.Json for Unity.
Unity Technologies has now taken on this role.
This repository has completed its task: to provide Newtonsoft.Json. And is now
that it's fully endorced by Unity themselves, I can happily deprecate this
project like no other.
### Help! I get `GUID [...] for assets '...' conflicts with: '...'`
```
GUID [6c694cfdc33ae264fb33e0cd1c7e25cf] for asset 'Packages/jillejr.newtonsoft.json-for-unity/Plugins/Newtonsoft.Json AOT/Newtonsoft.Json.dll' conflicts with:
'Packages/com.unity.nuget.newtonsoft-json/Runtime/AOT/Newtonsoft.Json.dll' (current owner)
We can't assign a new GUID because the asset is in an immutable folder. The asset will be ignored.
```
This is because Unity's package, `com.unity.nuget.newtonsoft-json`, and this
package exists in the project at the same time. This is not supported, and
there's no direct plans on making this work.
You have to sadly uninstall this package, `jillejr.newtonsoft.json-for-unity`,
and rely completely on their package instead.
```diff
diff --git a/Packages/manifest.json b/Packages/manifest.json
index 49a3afa..f0edd27 100644
--- a/Packages/manifest.json
+++ b/Packages/manifest.json
@@ -18,7 +18,7 @@
"com.unity.collab-proxy": "1.2.16",
"com.unity.test-framework": "1.1.22",
"com.unity.ugui": "1.0.0",
- "jillejr.newtonsoft.json-for-unity": "13.0.102",
+ "com.unity.nuget.newtonsoft-json": "3.0.1",
"jillejr.newtonsoft.json-for-unity.converters": "1.0.0",
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
```
Read more:
### What's the status of this repo vs `com.unity.nuget.newtonsoft-json`?
I've tried so summarize it as best I can over at
## Installation
### Installation of the official UPM package
I've written documentation on installing the new officially adopted fork (of my
fork) of Newtonsoft.Json, which can be found here:
### Deprecated installations
> #### Installation via [Package Installer][package-installer] _(experimental)_
>
> 1. [Click here to download `Install-jillejr.newtonsoft.json-for-unity-13.0.102.unitypackage`](https://package-installer.glitch.me/v1/installer/jilleJr/jillejr.newtonsoft.json-for-unity?registry=https%3A%2F%2Fnpm.cloudsmith.io%2Fjillejr%2Fnewtonsoft-json-for-unity)
>
> 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 :heart: to [@needle-tools](https://github.com/needle-tools) for
> making such a great tool!
>
> #### Installation via [OpenUPM][openupm] ![OpenUPM icon][openupm-icon.png]
>
> ```sh
> openupm add jillejr.newtonsoft.json-for-unity
> ```
>
> Full installation guide over at the wiki:
> [Installation via OpenUPM
> ![OpenUPM icon][openupm-icon.png]][wiki-installation-via-openupm]
>
> Much love :heart: to [@favoyang](https://github.com/favoyang) for making such a
> great tool!
>
> #### Installation via pure UPM
>
> Full installation guide over at the wiki:
> [Installation via pure UPM][wiki-installation-via-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.
>
> 
>
> Supply the following URL:
>
> ```none
> https://github.com/jilleJr/Newtonsoft.Json-for-Unity.git#upm
> ```
Full installation guide over at the wiki:
[Installation via Git in UPM][wiki-installation-via-git-in-upm]
## Newtonsoft.Json-for-Unity specific links
- Newtonsoft.Json-for-Unity Wiki: [Wiki of this fork](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki)
- Newtonsoft.Json-for-Unity release notes: [Release notes of this fork](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/releases)
- Newtonsoft.Json-for-Unity package repo: [Cloudsmith package](https://cloudsmith.io/~jillejr/repos/newtonsoft-json-for-unity/packages/detail/npm/jillejr.newtonsoft.json-for-unity/latest/)
- Newtonsoft.Json-for-Unity QA: [GitHub discussions](https://github.com/jilleJr/Newtonsoft.Json-for-Unity/discussions/categories/q-a)
## Newtonsoft.Json links
- Newtonsoft.Json repo: [github.com/JamesNK/Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json)
- Newtonsoft.Json homepage: [www.newtonsoft.com/json](https://www.newtonsoft.com/json)
- Newtonsoft.Json documentation: [www.newtonsoft.com/json/help](https://www.newtonsoft.com/json/help)
- Newtonsoft.Json release notes: [Release Notes of source repository](https://github.com/JamesNK/Newtonsoft.Json/releases)
- Newtonsoft.Json QA: [Stack Overflow posts tagged with `json.net`](https://stackoverflow.com/questions/tagged/json.net)
## 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][issue-create]. Could be a feature request for a new converter,
or maybe you've found a bug?
- [Tackle one of the unassigned issues][issue-list-unassigned]. 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][json.net-4-unity.converters] 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](/CONTRIBUTING.md) file that contains some
guidelines. It may be good to read it beforehand.
## Development
### Building
These docs have been moved to [./ci/README.md](./ci/README.md).
### Linting markdown
All pull requests must comply with the remark styling rules found in the
`.remarkrc` files within this repo. The `.md` files are linted automatically
by Codacy, but to run them locally you must first install some prerequisites:
1. Install NPM
2. Install `remark-cli` and some styling packages
```sh
# You may need to add "sudo"
npm install --global remark-cli
# Intentionally not globally
npm install remark-lint remark-preset-lint-markdown-style-guide remark-frontmatter
```
Then lint away! For example:
```sh
$ remark .github
.github/ISSUE_TEMPLATE/bug_report.md: no issues found
.github/ISSUE_TEMPLATE/feature_request.md: no issues found
.github/ISSUE_TEMPLATE/not-working-as-expected.md: no issues found
.github/ISSUE_TEMPLATE/question.md: no issues found
.github/PULL_REQUEST_TEMPLATE/code-update.md: no issues found
.github/PULL_REQUEST_TEMPLATE/docs-update.md: no issues found
```
### 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-workingwithbranches#merging] wiki page.
### Backporting changes
Most changes to this repo can be applied to all the different versions. For
example changes to the `link.xml` or bugfixes in the IL2CPP hotfixes should
be applied to all the different versions, 10.0.3, 11.0.2, 12.0.3, etc.
This repo has a `.backportrc.json` file that is used by the
[sqren/backport](https://github.com/sqren/backport) CLI to make this easier. It
is a tool that basically just does `git cherry-pick`, but with some other
features such as automatically create branches and PRs.
1. Install Node.js:
2. Install the `backport` CLI globally
```sh
npm install -g backport
```
3. Configure the `backport` tool. It needs a GitHub access token and username
inside `~/.backport/config.json`.
More info here:
4. After a PR merge, checkout `master` and pull the newly merged PR you want to
backport, then run the `backport` CLI. It's interactive, so just follow the
steps.
```sh
git checkout master
git pull
# The tool is interactive. Choose the merge commit you want to backport
# and it takes care of the rest.
backport
```
## 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][opencollective-img-induvidual]][opencollective-url]
---
This package is licensed under The MIT License (MIT)
Copyright © 2019 Kalle Jillheden (jilleJr)
See full copyrights in [LICENSE.md][license.md] inside repository
[issue-create]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/issues/new/choose
[issue-list-unassigned]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/issues?q=is%3Aopen+is%3Aissue+no%3Aassignee
[json.net-4-unity.converters-compatability]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity.Converters/blob/master/Doc/Compatability-table.md
[json.net-4-unity.converters]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity.Converters
[license.md]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/blob/master/LICENSE.md
[newtonsoft.json.git]: https://github.com/JamesNK/Newtonsoft.Json
[opencollective-img-induvidual]: https://opencollective.com/newtonsoftjson-for-unity/individuals.svg?width=890
[opencollective-url]: https://opencollective.com/newtonsoftjson-for-unity
[openupm]: https://openupm.com/packages/jillejr.newtonsoft.json-for-unity/
[openupm-icon.png]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/raw/c43046bc4763c0a5d3b0164a4f0a92e40de9d10e/Doc/icons/openupm-icon-16.png
[package-installer]: https://package-installer.glitch.me/
[wiki-fix-aot-using-aothelper]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Fix-AOT-using-AotHelper
[wiki-fix-aot-using-link.xml]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Fix-AOT-using-link.xml
[wiki-installation-via-openupm]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Installation-via-OpenUPM
[wiki-installation-via-upm]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Installation-via-UPM
[wiki-installation-via-git-in-upm]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Installation-via-Git-in-UPM
[wiki-what-even-is-aot]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/What-even-is-AOT
[wiki-workingwithbranches#merging]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Working-with-branches#merging-changes-from-jamesnks-repo
[wiki-workingwithbranches]: https://github.com/jilleJr/Newtonsoft.Json-for-Unity/wiki/Working-with-branches