diff --git a/README.md b/README.md index 718dc5c..7991fa7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # TimeWeatherChanger -Change the weather and time with GUI-based mod \ No newline at end of file +Change the weather and time with GUI-based mod + +### Controls + +In order to open panel, press keypad "Home" or open game console with ` and write "twc" + +### How to install + +1. Download the latest release here: [link](https://dev.sp-tarkov.com/Terkoiz/Freecam/releases) -OR- build from source (instructions below) +2. Simply drop the folder `SamSWAT-TWChanger` into your SPT-AKI `user/mods/` directory. + +### Preview + +![preview](https://media.discordapp.net/attachments/891823733499629619/928128516720062495/unknown.png) + +### How to build from source + +1. Download/clone this repository +2. Download/clone the `SPT-AKI/Modules` repository: [link](https://dev.sp-tarkov.com/SPT-AKI/Modules) +3. Move the contents of the `project` folder over to the SPT-AKI Modules `project` folder +4. Add the `SamSWAT.TimeWeatherChanger` project to the SPT-AKI Modules solution +5. Build modules - `SamSWAT.TimeWeatherChanger.dll` should appear under `Build/EscapeFromTarkov_Data/Managed` in the SPT-AKI Modules directory +6. Copy the .dll into the `mod/SamSWAT-TWChanger` folder and rename to `module.dll` +7. That's it, you have a working release of this mod! Follow the `How to install` instructions on how to get the mod into your game \ No newline at end of file