Create Patch
===========

Outputs the differences between two game datas as a file that can be used later to :doc:`DATA APPLYPATCH <data_apply_patch>` to another game data.

- :ref:`CLI Installation <CommandLine_Installation>`
- :ref:`Commands Reference <CommandLine_Commands>`
- :doc:`Universal Parameters <universal_parameters>`
- :doc:`URL-based Input/Output <remote_input_output>`

---------------
 Command
---------------

.. code-block:: bash

  # local game data (windows)
  dotnet charon DATA CREATEPATCH --dataBase "c:\my app\gamedata.json" --input "c:\my app\gamedata_patch.json" --inputFormat json
  
  # remote game data
  dotnet charon DATA CREATEPATCH --dataBase "https://charon.live/view/data/My_Game/develop/" --input "./gamedata_patch.json" --inputFormat json --credentials "<API-Key>"
  
---------------
 Parameters
---------------

--dataBase1
   Absolute or relative path to a first game data. Use quotation marks if your path contains spaces.

   .. code-block:: bash
   
     # local file
     --dataBase1 "c:\my app\gamedata.json"
     
     # remote server
     --dataBase1 "https://charon.live/view/data/My_Game/develop/"
     
--dataBase2
   Absolute or relative path to a second game data. Use quotation marks if your path contains spaces.

   .. code-block:: bash
   
     # local file
     --dataBase2 "c:\my app\gamedata.json"
     
     # remote server
     --dataBase2 "https://charon.live/view/data/My_Game/develop/"
     
--output
   Path to a patch file. If the file exists, it will be overwritten. The directory must already exist. 
   Alternatively, you can output to `Standard Error <https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr)>`_, 
   `Standard Output <https://en.wikipedia.org/wiki/Standard_streams#Standard_output_(stdout)>`_, 
   `/dev/null <https://en.wikipedia.org/wiki/Null_device>`_, or a :doc:`URL <remote_input_output>`.
  
   .. code-block:: bash

     # standart output (default)
     --output out
     --output con

     # standart error
     --output err
     
     # null device
     --output null
     
     # absolute path (windows)
     --output "c:\my app\gamedata_patch.json"
     
     # absolute path (unix)
     --output /user/data/gamedata_patch.json
     
     # relative path (universal)
     --output "./gamedata_patch.json"
     
     # remote location (HTTP)
     --output "http://example.com/gamedata_patch.json"
     
     # remote location with authentication (FTP)
     --output "ftp://user:password@example.com/gamedata_patch.json"
     
--outputFormat
   Format of exported data.
   
   .. code-block:: bash
    
     # JSON (default)
     --outputFormat json
     
     # BSON
     --outputFormat bson
     
     # Message Pack
     --outputFormat msgpack
     
     # XML (removed in 2025.1.1) 
     --outputFormat xml
     

--outputFormattingOptions
   Additional options for specified format.

--credentials
   This parameter sets the API key used to access *BOTH* remote servers. 
   If this is not suitable, consider :doc:`downloading <data_backup>` the data locally and running this command on local files instead.
 
This command supports :doc:`universal parameters <universal_parameters>`.