diff --git a/BUILD.md b/BUILD.md index 33182ded..a80ae42f 100644 --- a/BUILD.md +++ b/BUILD.md @@ -5,19 +5,32 @@ Building instructions for the plugin. ### Requirements - [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) + - (You can use VS2022, just make sure you're on at least MSVC 14.34) - [xmake](https://github.com/xmake-io/xmake/releases) +- [git](https://git-scm.com/downloads) +### Build 1. Navigate to the repository using a command prompt. -2. cmd: `xmake -y` -3. The files should be in `build\windows\x64\release` +2. Check out the correct branch/tag if you're not working against master +3. Run `git submodule update --init` to pull in vendored dependencies +4. Run `xmake -y` (add `-v` for verbose output) + ### Visual Studio If you want visual studio projects execute `xmake project -k vsxmake` and you will find the sln in the newly created `vsxmake` folder. + +### Additional configuration / troubleshooting + +- You can specify the VS version with `xmake f --vs=2019|2022` in case it's not detected right +- Use Visual Studio Installer to install any missing components in the toolset if needed + ### Install -1. Copy `build\windows\x64\release\cyber_engine_tweaks.asi` to `\bin\x64\plugins\cyber_engine_tweaks.asi` +1. Configure the install path, run: `xmake f --installpath=\bin\x64\plugins` (not the base dir!) +2. `xmake install` (or `xmake i` for short.) + #### ASI Loader