diff --git a/README.md b/README.md index 2abdf1b..0d4ffaf 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,29 @@ depends on it. ## For mod development +Set the `COMMANDHOOK` environment variable to the folder containing +`CommandHook.dll` (i.e. wherever you've built CommandHook), the same way +`VINTAGE_STORY` points at your game install. + +**Linux/macOS** (add to `~/.bashrc`, `~/.zshrc`, etc.): +```bash +export COMMANDHOOK="/path/to/CommandHook/CommandHook/bin/Release" +``` + +**Windows (PowerShell):** +```powershell +[Environment]::SetEnvironmentVariable("COMMANDHOOK", "C:\path\to\CommandHook\CommandHook\bin\Release", "User") +``` + +Then add a `Reference` to your `.csproj` next to your other game references: + +```xml + + $(COMMANDHOOK)/CommandHook.dll + false + +``` + Add it as a dependency in your `modinfo.json`: ```json