EDIT: Pipe Tool is updated for Definitive Edition and will no longer work for Classic. Just be sure to select the data folder in ..\Steam\steamapps\common\Divinity Original Sin 2\DefEd
Pipe Tool is a tool to aid team development of DOS2 mod projects using source control, such as Git or SVN. It can also be used as a simple backup tool to quickly save and restore important progress.
This tool is currently necessary during the development of the mod: Arena Challenges. More info about the mod can be found here
. Mod project files are distributed in multiple locations in the DOS2 Data folder, making it difficult to work with source control repositories. Thus, this tool was born.
Letter to Larian:
I completely welcome DOS2 and Divinity Engine 2 updates that makes this tool unnecessary.
If there are no such plans, then I hope this tool can help out the community.Download the binaries.
(The executable program).Download the source,
which is public-domain.
I believe google will show a view for the zip contents. There's a download button on the top-right that will download the zip file. Let me know if that isn't the case.
If you'd like to check out and/or build the source, make sure to use QT 5.9.3 which can be found here
Be sure to place the binary in its own folder. The folder it resides in will be used as the git endpoint. Note that while it says git, the folder can be used as just a generic backup folder or save point for your mods. At the moment, every backup folder will need a pipetool.exe in it as it's designed to be packaged and shared with dos2 individual mod projects.
Update 12/9/2019: Pipe Tool has been updated to no longer require Microsoft Visual C++ Redistributable for Visual Studio 2017.Setup
Simply plop this tool into your local repository located anywhere other than in the DOS2 Data folder, and it should be fairly straight forward to use.Config
1. Set the DOS2 Data folder path.
2. All DOS2 mod projects will then be detected. Both projects in the DOS2 Data folder and projects in the repository that Pipe Tool is located in is searched. Projects are listed in the "Detected Mods" list box.
3. Double click the desired mod to extract the UUID into the "Mod UUID" input box. If everything is setup correctly, the Pipe tab will become available.Usage
Some terms should be clarified and usage should be easy to understand.
DOS2 Endpoint - The directories and files that make up where the mod project is loaded by The Divinity Engine 2 and by the game.
Git Endpoint - The directory where Pipe Tool should be located. Note that while it says Git, any version control system that allows a local repository will work.
Pipe In - Make the DOS2 endpoint contents identical to the Git endpoint contents by copying or removing files.
Pipe Out - Make the Git endpoint contents identical to the DOS2 endpoint contents by copying or removing files.
After a pipe operation, the endpoints should be synchronized.
Another important usage of Pipe Tool is the ability to delete the project files using the delete button. This is useful because DOS2 mod projects are loaded with priority over mods subscribed on Steam, even if projects are not locally exported. In order to play the published version of the mod with others, the project must be removed.
So a common usage would be to Pipe Out, then delete DOS2 endpoint contents when you want the game to load the published mod, and Pipe In later to resume development of the unpublished version.
Please let me know if there are any questions or issues here. I hope to see more team developed mods because I love Divinity Original Sin 2!