-
Notifications
You must be signed in to change notification settings - Fork 18
[Union] Redesigned index and some minor improvements #157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
muczc1wek
merged 2 commits into
Gothic-Modding-Community:dev
from
muczc1wek:union/redesigned-index
Oct 7, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,42 @@ | ||
| # 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](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. | ||
| <div class="grid cards" markdown> | ||
|
|
||
| ## [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. | ||
| - :octicons-plug-16:{ .lg .middle } __Plugins__ | ||
|
|
||
| ## [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. | ||
| --- | ||
|
|
||
| Union plugins are shipped in the form of a `.dll` library. This library contains the compiled C++ code that interfaces with game engine. | ||
|
|
||
| [:octicons-arrow-right-24: Read more](plugins/index.md) | ||
|
|
||
|
|
||
| - :material-code-block-tags:{ .lg .middle } __Union SDK__ | ||
|
|
||
| --- | ||
|
|
||
| Create plugins with Union SDK, a community-made software development kit for ZenGin. | ||
|
|
||
| [:octicons-arrow-right-24: Read more](sdk/index.md) | ||
|
|
||
| - :material-tools:{ .lg .middle } __PATCH file format__ | ||
|
|
||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| [:octicons-arrow-right-24: Read more](patch.md) | ||
|
|
||
|
|
||
|
|
||
| - :material-download:{ .lg .middle } __Install Union__ | ||
|
|
||
| --- | ||
|
|
||
| Install the latest Union and enjoy the bug-free gameplay. | ||
|
|
||
| [:octicons-arrow-right-24: Download installer](https://drive.google.com/drive/u/0/folders/1SMY3PuSZnZuAlov8GKKXtv5lny-jZl-a) | ||
|
|
||
|
|
||
| </div> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,15 @@ | ||
| # 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. | ||
| `.patch` files are scripts that are used to patch game executable. They are especially useful when fixing engine bugs. | ||
|
|
||
| !!! 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/) | ||
| ## Loading | ||
| Patches could be launched from any directory monitored by the file system (`System`, `Saves`, `_work` etc.). The launch is performed both from physical directories and from VDF/MOD volumes. If physical and virtual directories contain identical patches with identical paths, physical copies will have read priority. | ||
|
|
||
| ## Documentation | ||
| The description of the patch format could be found [here](https://worldofplayers.ru/threads/42178/). | ||
|
|
||
| ## Community patches | ||
| Following repositories contain collections of various patches: | ||
|
|
||
| - [:fontawesome-brands-github: Gothic-Modding-Community/zengin-patches](https://github.com/Gothic-Modding-Community/zengin-patches) | ||
| - [:fontawesome-brands-github: UnresolvedExternal/Gothic-Patches](https://github.com/UnresolvedExternal/Gothic-Patches) | ||
| - [:fontawesome-brands-github: VaanaCZ/gothic-engine-patches](https://github.com/VaanaCZ/gothic-engine-patches) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.