diff --git a/README.md b/README.md index 063fb56d..ba9f6c58 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,53 @@ This package provides utilities for manipulating Divinity Original Sin 1, Enhanc - Importing and exporting meshes and animations (conversion from/to GR2 format) - Editing story (OSI) databases -Requirements + +Installation ============ +For regular users, download the latest release, unzip it, and run ConverterApp.exe. + +1. On this page, look for Releases and click the one that says Latest. + + Image + +2. Click ExportTool.zip to download it. + + Image + +3. In your downloads folder, right click the zip, and extract it to a new folder. + + Image + +4. Open the new folder, open Packed, and double click ConverterApp.exe to open it. + + Image + -To build the tools you'll need to get the following dependencies: +Build From Source +================= +Once you've downloaded and extracted the latest source code, here's how to build the solution using visual studio. +1. Get the following **dependencies**: - Download GPLex 1.2.2 [from here](https://s3.eu-central-1.amazonaws.com/nb-stor/dos-legacy/ExportTool/gplex-distro-1_2_2.zip) and extract it to the `External\gplex\` directory - Download GPPG 1.5.2 [from here](https://s3.eu-central-1.amazonaws.com/nb-stor/dos-legacy/ExportTool/gppg-distro-1_5_2.zip) and extract it to the `External\gppg\` directory - Protocol Buffers 3.6.1 compiler [from here](https://github.com/protocolbuffers/protobuf/releases/download/v3.6.1/protoc-3.6.1-win32.zip) and extract it to the `External\protoc\` directory + +2. You'll need visual studio, i.e. [Visual Studio Community 2022](https://visualstudio.microsoft.com/downloads/) + +3. Your visual studio needs .NET and C++. To get it, in the visual studio installer click Modify, tick the boxes for **.NET desktop development** and **Desktop development with C++**, then install. + + Image + +4. Launch your visual studio. File > Open > Project/Solution, and find your LSTools.sln. + +5. Switch from Debug to Release, then do Build > Build Solution. + + Image + +6. The last step is to get granny2. Releases now include it, but the latest source code doesn't, so to make the latest source code work you can either grab granny2.dll from the latest release package, or from an older source version. Copy granny2.dll into these three folders: `Release\Packed\`, `ConverterApp\`, and `ConverterApp\bin\Release\net8.0-windows\` + + Image + +7. The built executables will end up in `Release\Packed\`. + + Image