This toolset is a simple XML diff and patch tools for X4: Foundations. It is designed to help modders to compare and patch XML files.
The format of diff XML files is compatible with the appropriate diff.xsd format definition. It is means - you can you this tool to create diff files for any XML files used in game.
Also, you can use appropriate tool to patch XML files with diff files, this action has reason to check how your diff file will be applied to the vanilla XML file. Or better understand, what other modders did in their mods.
Important note
It is highly recommended to use the diff.xsd file to validate the diff XML files. It is especially important when you creating them by XMLDiff.exe.
If the diff.xsd file if it located in the "current" folder it will be used automatically. If you want to use another diff.xsd file, you can specify it with the -x option.
How to use
- Download the latest release from:
- GitHub releases page - there is an archive file XMLDiffAndPatch.zip.
- NexusMods - there is an archive file XMLDiffAndPatch.zip.
- Extract the archive file to any useful location.
- Inside will be a folder, named XMLDiffAndPatch with two executables - XMLDiff.exe and XMLPatch.exe.
There is a command line help for the XMLDiff tool:
Code: Select all
XMLDiff 0.2.24
Developed by Chem O`Dun
-o, --original_xml Required. Path to the original XML file or directory.
-m, --modified_xml Required. Path to the modified XML file or directory.
-d, --diff_xml Required. Path for the diff XML file or directory.
-x, --xsd Path to the diff.xsd schema file.
-l, --log-to-file Log level (error, warn, info, debug).
-a, --append-to-log (Default: false) Append logs to the existing log file.
--anywhere-is-allowed (Default: false) Generate a path using the anywhere '//' construction, if possible. Instead of full path.
--use-all-attributes (Default: false) Use all attributes in XPath.
--help Display this help screen.
--version Display version information.
Code: Select all
XMLDiff.exe -o vanilla.xml -m modified.xml -d diff.xml
There the is example of the diff files created by tool:
- with add operation:
Code: Select all
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<diff>
<add sel="//ware[@id="scanningarrays"]" pos="before">
<ware id="xenon_psi_emitter_mk1" name="{1972092403, 7002}" description="{1972092403, 7002}" transport="equipment" volume="1" tags="satellite noplayerbuild">
<price min="845800" average="901420" max="1054580" />
<production time="60" amount="0" method="default" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="xenon" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="terran" name="Xenon Psi Emitter" />
<component ref="xenon_psi_emitter_macro" amount="0" />
<use threshold="0" />
</ware>
</add>
</diff>
- with replace operation:
Code: Select all
<?xml version='1.0' encoding='UTF-8'?>
<diff>
<replace sel="//do_if[@value="@$speak and not this.assignedcontrolled.nextorder and (@$defaultorder.id != 'Patrol') and (@$defaultorder.id != 'ProtectPosition') and (@$defaultorder.id != 'ProtectShip') and (@$defaultorder.id != 'ProtectStation') and (@$defaultorder.id != 'Plunder') and (@$defaultorder.id != 'Police') and (not this.assignedcontrolled.commander or (this.assignedcontrolled.commander == player.occupiedship)) and notification.npc_await_orders.active"]/@value">@$speak and not this.assignedcontrolled.nextorder and (@$defaultorder.id != 'ProtectSector') and (@$defaultorder.id != 'Patrol') and (@$defaultorder.id != 'ProtectPosition') and (@$defaultorder.id != 'ProtectShip') and (@$defaultorder.id != 'ProtectStation') and (@$defaultorder.id != 'Plunder') and (@$defaultorder.id != 'Police') and (not this.assignedcontrolled.commander or (this.assignedcontrolled.commander == player.occupiedship)) and notification.npc_await_orders.active</replace>
</diff>
Only full path
The --only-full-path option will generate only the full path to the element in the XML file. It is mean - there no // will be in the sel attribute of the add, replace or remove element.
Example:
Code: Select all
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<diff>
<add sel="/wares/ware[@id="scanningarrays"]" pos="before">
<ware id="xenon_psi_emitter_mk1" name="{1972092403, 7002}" description="{1972092403, 7002}" transport="equipment" volume="1" tags="satellite noplayerbuild">
<price min="845800" average="901420" max="1054580" />
<production time="60" amount="0" method="default" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="xenon" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="terran" name="Xenon Psi Emitter" />
<component ref="xenon_psi_emitter_macro" amount="0" />
<use threshold="0" />
</ware>
</add>
</diff>
The --use-all-attributes option will generate the sel attribute with all attributes of the element in the XML file. It is mean - there will be all attributes of the element in the sel attribute of the add, replace or remove element.
Example:
Code: Select all
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<diff>
<add sel="/wares/ware[@id="scanningarrays"][@name="{20201,3301}"][@description="{20201,3302}"][@factoryname="{20201,3304}"][@group="hightech"][@transport="container"][@volume="38"][@tags="container economy"]" pos="before">
<ware id="xenon_psi_emitter_mk1" name="{1972092403, 7002}" description="{1972092403, 7002}" transport="equipment" volume="1" tags="satellite noplayerbuild">
<price min="845800" average="901420" max="1054580" />
<production time="60" amount="0" method="default" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="xenon" name="Xenon Psi Emitter" />
<production time="60" amount="0" method="terran" name="Xenon Psi Emitter" />
<component ref="xenon_psi_emitter_macro" amount="0" />
<use threshold="0" />
</ware>
</add>
</diff>
The pos attribute of the add usually is set to after, taking in account the common logic of how the program is working. But in some cases, you may want to have a diff file with the pos attribute set to before. Mostly it is useful when it working in conjunction with the vscode - XMLDiff with VSCode.
From version 0.2.26, you can define the position of the add element in the diff file by using an in-line comment in the original XML file. The comment should be placed before the element you want to add and should contain the text <!-- pos="before" -->.
How to apply a diff file
There is a command line help for the XMLPatch tool:
Code: Select all
XMLPatch 0.2.20
Developed by Chem O`Dun
-o, --original_xml Required. Path to the original XML file or directory.
-d, --diff_xml Required. Path to the diff XML file or directory.
-u, --output_xml Required. Path for the output XML file or directory.
-x, --xsd Path to the diff.xsd schema file.
-l, --log-to-file Log level (error, warn, info, debug).
-a, --append-to-log (Default: false) Append logs to the existing log file.
--allow-doubles (Default: false) Allow doubles in the diff XML. Useful for scripts patching.
--help Display this help screen.
--version Display version information.
Code: Select all
XMLPatch.exe -o vanilla.xml -d diff.xml -u modified.xml
There is an example of the patched XML files created by the tool:
- with add operation:
Code: Select all
<ware id="satellite_mk2" name="{20201,20401}" description="{20201,20402}" transport="equipment" volume="1" tags="equipment satellite">
<price min="44380" average="52215" max="60045"/>
<production time="60" amount="1" method="default" name="{20206,101}">
<primary>
<ware ware="advancedelectronics" amount="5"/>
<ware ware="energycells" amount="10"/>
<ware ware="scanningarrays" amount="5"/>
</primary>
</production>
<production time="60" amount="1" method="xenon" name="{20206,601}" tags="noplayerbuild">
<primary>
<ware ware="energycells" amount="10"/>
<ware ware="silicon" amount="1"/>
</primary>
</production>
<component ref="eq_arg_satellite_02_macro"/>
<use threshold="0"/>
</ware>
<ware id="xenon_psi_emitter_mk1" name="{1972092403, 7002}" description="{1972092403, 7002}" transport="equipment" volume="1" tags="satellite noplayerbuild">
<price min="845800" average="901420" max="1054580"/>
<production time="60" amount="0" method="default" name="Xenon Psi Emitter"/>
<production time="60" amount="0" method="xenon" name="Xenon Psi Emitter"/>
<production time="60" amount="0" method="terran" name="Xenon Psi Emitter"/>
<component ref="xenon_psi_emitter_macro" amount="0"/>
<use threshold="0"/>
</ware>
- with replace operation:
Code: Select all
<set_to_default_flight_control_model object="this.assignedcontrolled"/>
<set_value name="$defaultorder" exact="this.assignedcontrolled.defaultorder"/>
<do_if value="@$speak and not this.assignedcontrolled.nextorder and (@$defaultorder.id != 'Patrol') and (@$defaultorder.id != 'ProtectSector') and (@$defaultorder.id != 'ProtectPosition') and (@$defaultorder.id != 'ProtectShip') and (@$defaultorder.id != 'ProtectStation') and (@$defaultorder.id != 'Plunder') and (@$defaultorder.id != 'Police') and (not this.assignedcontrolled.commander or (this.assignedcontrolled.commander == player.occupiedship)) and notification.npc_await_orders.active">
<set_value name="$speakline" exact="10304" comment="Awaiting orders."/>
If the output XML is a directory, the tool will create a new XML file with the same name as the original XML file in the output directory.
For example, if the original XML file is vanilla.xml and the output directory is output, the tool will create a new XML file output/vanilla.xml.
How to apply a tools to a directories
Applying XMLDiff to directories
You can apply the XMLDiff tool to directories. In this case, the tool will traverse the directory structure and create diff files for XML files with identical names and relative paths. The process is as follows:
- If all input parameters are directories, the tool will create diff files for all XML files in the directories.
- The tool will recursively go through the directory structure, using modified files as a "keys" for it
- For each changed file, the corresponding original XML file in the original directory with the same relative path will be checked.
- If the original XML file is not found, the operation will be skipped.
- If the original XML file is found, the diff file will be created in the output directory with the same relative path.
Code: Select all
XMLDiff.exe -o vanilla_dir -m modified_dir -d diff_dir
You can apply the XMLPatch tool to directories. In this case, the tool will traverse the directory structure and apply the patch to XML files with identical names and relative paths. The process is as follows:
- If all input parameters are directories, the tool will apply the patch to all XML files in the directories.
- The tool will recursively go through the directory structure, using diff files as a "keys" for it
- For each diff file, the corresponding original XML file in the original directory with the same relative path will be checked.
- If the original XML file is not found, the operation will be skipped.
- If the original XML file is found, the diff file will be patched with the original XML file, and a new patched XML file will be created in the output directory with the same relative path.
Code: Select all
XMLPatch.exe -o vanilla_dir -d diff_dir -u modified_dir
If you have any issues with the tool, please create an issue in the issues page.
Will be highly appreciated if you will provide a version of used tool and XMLDiff.log or XMLPatch.log file respectively to the tool.
To create such debug file please use the --log-to-file option with debug level.
License
There is a MIT license for this tool. You can find it in the LICENSE file.
Credits
Special thanks to Duncaroos for the patience, testing, and valuable feedback.
Additional links
There is a topic on the EGOSOFT forum, related to this toolset.
Antivirus scanning
Please be aware - each release archive has an appropriate link to the VirusTotal. Follow the link to be sure that the archive is safe.
![[ external image ]](http://i127.photobucket.com/albums/p129/Avadon2/X3/ETNO_Ava1.png){kind=link}