Modding:JSON Patching: Difference between revisions

From Vintage Story Wiki
Note that the RFC is not complete and point to the source
(Update version)
(Note that the RFC is not complete and point to the source)
Line 10: Line 10:


<!--T:4-->
<!--T:4-->
Below is a basic guide to help you understand how patches are working. A [https://tools.ietf.org/html/rfc6902 full reference doc] is also available however. To make your patching live easier in the long term you can also use the ModMaker 3000™, which is a command line tool that ships with the game itself. If you modify vanilla assets, you can run ModMaker 3000™ to create a mod consisting of a set of patches based on the changes you made to the assets. You can then undo or reinstall the game to get your original files back.
Below is a basic guide to help you understand how patches are working. You can use the ModMaker 3000™ to start writing a patch. It is a a command line tool that ships with the game itself. If you modify vanilla assets, you can run ModMaker 3000™ to create a mod consisting of a set of patches based on the changes you made to the assets. You can then undo or reinstall the game to get your original files back. Note that before packaging the output of the ModMaker 3000™ in a mod, some edits should be made as described later in this document.
 
The patch syntax is based on [https://tools.ietf.org/html/rfc6902 rfc6902]. However, in addition to what's described in the RFC, it also has "addmerge" and "addeach" operations. The source code for the json patcher is [https://github.com/anegostudios/vsessentialsmod/blob/master/Loading/JsonPatchLoader.cs JsonPatchLoader.cs] and the customized [https://github.com/anegostudios/Tavis.JsonPatch/tree/0fc44b73c8412c561506745b1944fc18e88c1d83 Tavis.JsonPatch].


=== The basics === <!--T:5-->
=== The basics === <!--T:5-->
Confirmedusers
261

edits