Skip to content

Commit

Permalink
[Union] Patch files article
Browse files Browse the repository at this point in the history
  • Loading branch information
muczc1wek committed Jun 25, 2024
1 parent afac05d commit 8e89b47
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/zengin/union/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Union
Union is a system to patch and extend Gothic's engine the ZenGin. It allows you to load `.dll` files - ZenGin extensions created using the Gothic/Union SDK and `.patch` files - files designed to patch the game's executable. The Union installer also contains the SystemPack a collection of bug fixes and engine edits that improve performance.

## Plug-ins
## [Plug-ins](plugins/index.md)
Union plugins are shipped in the form of a `.dll` library. This library contains the compiled C++ code with the Union SDK and an embedded `.patch` file.

## Union SDK & Gothic API
## [Union SDK](sdk/index.md) & Gothic API
Union software development kit is a collection of tools and the Gothic API that allow you to create Union plugins and alter the engine's behavior.
Gothic API is a set of 4 interfaces (each for one different ZenGin version) that allow you to interface with the engine, access the engine objects, change their behavior and introduce new classes and functionality.

## PATCH file format
## [PATCH file format](patch.md)
The `.patch` file contains one or more small programs that are designed to change the engine code (game executable). This is usually done to fix bugs. Union plug-ins contain an embedded `.patch` file and this file usually contains changes to the binary necessary for the proper function of the plug-in.
7 changes: 7 additions & 0 deletions docs/zengin/union/patch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Patch files
`.patch` files are scripts that are used to change memory values or committing some actions when starting the engine. Files patches are launched from any directories monitored by the file system (System, Saves, _Work and any others at the request of the engine). The launch is performed both from physical directories and from VDF & MOD. If physical and virtual directories contain identical patches with identical paths, physical copies will have read priority.

!!! Info
An additional [patch name] .MAP file can be created. This happens when the patch file has at least one patch marked 'static' (see the description of the patch format for more details). This file allows you to immediately download all previously made changes to process memory, skipping re-parsing of static blocks. By default, the file cannot be seen through standard files explorer. To make the file hidden, but visible, set the value SystemPack.ini -> ShowHiddenFiles = true.

[Description of the patch format](https://worldofplayers.ru/threads/42178/)

0 comments on commit 8e89b47

Please sign in to comment.