diff --git a/PublicationContent/description.txt b/PublicationContent/description.txt index 3139b14..a6ff416 100644 --- a/PublicationContent/description.txt +++ b/PublicationContent/description.txt @@ -1,9 +1,50 @@ -[h1]Custom Trader Inventory[/h1] +[h1]Features[/h1] +- remove and/or add items; +- unlock DLC weapons; +- correct items sorting (by price); +- can preload content (no lags during trader time); +- don't have to worry about adding new guns after each Tripware update. -[h1]Description[/h1] -description will come later... +[h1]Whitelisted?[/h1] +No. This mod is not whitelisted and will unrank your server. Any XP gained will not be saved. -[b]Mutator:[/b] CTI.CTIMut +[h1]Usage (single player)[/h1] +1. Subscribe to this mutator; +2. Start KF2; +3. Open console (`) and input: +[b]open KF-BioticsLab?Mutator=CTI.CTIMut[/b] +(replace the map and add the parameters you need) +4. . + +[h1]Usage (server)[/h1] +[b]Note:[/b] [i]If you don't understand what is written here, read the article [url=https://wiki.killingfloor2.com/index.php?title=Dedicated_Server_(Killing_Floor_2)][u]Dedicated Server (KF2 wiki)[/u][/url] before following these instructions.[/i] + +1. Open your [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b]; +2. Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section (create one if it doesn't exist): +[b]ServerSubscribedWorkshopItems=2830826239[/b] +3. Start the server and wait while the mutator is downloading; +4. Add mutator to server start parameters: [b]?Mutator=CTI.CTIMut[/b] and restart the server. + +[h1]Note[/h1] +📌 Mutator does not contain custom weapons. You must have the required weapon packs in your subscriptions to be able to add them to the trader. +📌 If you are using this mutator to add weapons, you should [b]not[/b] use mutators from weapon packs (just having them in subscriptions is enough). + +[h1]Setup (KFCTI.ini)[/h1] +Config will be created at the first start. + +Set [b]UnlockDLC=True[/b] to allow all players to buy DLC weapons. + +Set [b]bForcePreloadContent=True[/b] to preload weapon models and have no lags during trader time. + +Use [b][CTI.RemoveItems][/b] to remove items from the trader inventory. +For example: [b]Item=KFGame.KFWeapDef_Mac10[/b] will remove MAC10 from sale. +Set [b]bAll=True[/b] if you want to remove all items (can be useful if you want to set the entire sale list in the [b][CTI.AddItems][/b] section yourself). + +Use [b][CTI.AddItems][/b] to add items to the trader inventory. +For example: [b]Item=WeaponPack.KFWeapDef_XM25[/b] will add [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1147408497]XM25[/url] to sale. + +[h1]Example config(s)[/h1] +🔗 [url=https://steamcommunity.com/workshop/filedetails/discussion/2830826239/3409804177172972154/]Reinforcement Weapon Pack[/url] [h1]Sources[/h1] -[url=https://github.com/GenZmeY/KF2-CustomTraderInventory]https://github.com/GenZmeY/KF2-CustomTraderInventory[/url] +[url=https://github.com/GenZmeY/KF2-CustomTraderInventory]https://github.com/GenZmeY/KF2-CustomTraderInventory[/url] (GNU GPLv3) diff --git a/PublicationContent/preview.png b/PublicationContent/preview.png index c1fc1c3..7e25b61 100644 Binary files a/PublicationContent/preview.png and b/PublicationContent/preview.png differ diff --git a/README.md b/README.md index 1e5510f..a9f56cc 100644 --- a/README.md +++ b/README.md @@ -1 +1,49 @@ -# KF2-CustomTraderInventory \ No newline at end of file +# Custom Trader Inventory + +[![Steam Workshop](https://img.shields.io/static/v1?message=workshop&logo=steam&labelColor=gray&color=blue&logoColor=white&label=steam%20)](https://steamcommunity.com/sharedfiles/filedetails/?id=2830826239) +[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/2830826239)](https://steamcommunity.com/sharedfiles/filedetails/?id=2830826239) +[![Steam Favorites](https://img.shields.io/steam/favorites/2830826239)](https://steamcommunity.com/sharedfiles/filedetails/?id=2830826239) +[![Steam Update Date](https://img.shields.io/steam/update-date/2830826239)](https://steamcommunity.com/sharedfiles/filedetails/?id=2830826239) +[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-CustomTraderInventory)](https://github.com/GenZmeY/KF2-CustomTraderInventory/tags) +[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-CustomTraderInventory)](LICENSE) + +# Description +Add/Remove Items in the Trader's Inventory + +# Features +- remove and/or add items; +- unlock DLC weapons; +- correct items sorting (by price); +- can preload content (no lags during trader time); +- don't have to worry about adding new guns after each Tripware update. + +# Usage & Setup +[See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2830826239) + +# Build +**Note:** If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow [these instructions](https://tripwireinteractive.atlassian.net/wiki/spaces/KF2SW/pages/26247172/KF2+Code+Modding+How-to) instead of what is described here. +1. Install [Killing Floor 2](https://store.steampowered.com/app/232090/Killing_Floor_2/), Killing Floor 2 - SDK and [git for windows](https://git-scm.com/download/win); +2. open git-bash and go to any folder where you want to store sources: +`cd ` +3. Clone this repository and go to the source folder: +`git clone https://github.com/GenZmeY/KF2-CustomTraderInventory && cd KF2-CustomTraderInventory` +4. Download dependencies: +`git submodule init && git submodule update` +5. Compile: +`./tools/builder -c` +5. The compiled files will be here: +`C:\Users\\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\` + +# Testing +Open git-bash in the source folder and run command: +`./tools/builder -t` +(or `./tools/builder -ct` if you haven't compiled the mutator yet) + +A local single-user test will be launched with parameters from `builder.cfg` (edit this file if you want to test mutator with different parameters). + +# Bug reports +If you find a bug, go to the [issue page](https://github.com/GenZmeY/KF2-CustomTraderInventory/issues) and check if there is a description of your bug. If not, create a new issue. +Describe what the bug looks like and how reproduce it. + +# License +[GNU GPLv3](LICENSE)