KF2-CustomTraderInventory/PublicationContent/description.txt

101 lines
7.5 KiB
Plaintext
Raw Permalink Normal View History

2022-08-14 11:54:31 +00:00
[img]https://img.shields.io/static/v1?logo=GitHub&labelColor=gray&color=blue&logoColor=white&label=&message=Open Source[/img] [img]https://img.shields.io/github/license/GenZmeY/KF2-CustomTraderInventory[/img] [img]https://img.shields.io/steam/downloads/2830826239[/img] [img]https://img.shields.io/steam/favorites/2830826239[/img] [img]https://img.shields.io/steam/update-date/2830826239[/img] [url=https://steamcommunity.com/sharedfiles/filedetails/changelog/2830826239][img]https://img.shields.io/github/v/tag/GenZmeY/KF2-CustomTraderInventory[/img][/url]
2022-07-11 07:27:16 +00:00
2024-01-05 11:11:34 +00:00
[h1]Description[/h1]
Trader inventory management
2022-07-06 19:54:49 +00:00
[h1]Features[/h1]
2022-07-11 01:28:00 +00:00
[list]
[*]remove/add items to trader;
[*]can preload weapon models (no lags when someone buys weapons);
[*]unlock DLC weapons;
[*]correct items sorting (by price);
2024-01-04 07:09:16 +00:00
[*]don't have to worry about adding new guns after each KF2 update;
[*]add an unlimited number of items to the trader;
2024-01-07 17:12:12 +00:00
[*]players can sell weapons excluded from trader inventory.
2022-07-11 01:28:00 +00:00
[/list]
2022-07-05 13:09:48 +00:00
2022-07-06 19:54:49 +00:00
[h1]Whitelisted?[/h1]
2022-07-11 07:27:16 +00:00
No. This mod is not whitelisted and will de-rank your server. Any XP gained will not be saved.
2022-07-05 13:09:48 +00:00
2022-07-06 19:54:49 +00:00
[h1]Usage (single player)[/h1]
2022-07-11 01:28:00 +00:00
[olist]
[*]Subscribe to this mutator;
2024-01-05 11:11:34 +00:00
[*]Create a file [b](*)[/b]: [b]C:\Users\<username>\Documents\My Games\KillingFloor2\KFGame\Config\KFCTI.ini[/b]
with the following content:
[b][CTI.CTI]
Version=0[/b]
2024-04-28 17:53:02 +00:00
[*]Start KF2;
[*]Open console (~) and start any map with CTI (this will generate the default KFCTI.ini content):
[b]open KF-BioticsLab?Mutator=CTI.Mut[/b]
[*]Close the game and configure CTI as you need (see the [b]Setup (KFCTI.ini)[/b] section below);
[*]Start KF2, open the console, start the game:
2023-12-31 20:17:21 +00:00
[b]open KF-BioticsLab?Mutator=CTI.Mut[/b]
2024-04-28 17:53:02 +00:00
(replace the map and add the parameters you need).
2022-07-11 01:28:00 +00:00
[/olist]
2022-07-06 19:54:49 +00:00
[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]
2022-07-11 01:28:00 +00:00
[olist]
[*]Open your [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b];
[*]Find the [b][IpDrv.TcpNetDriver][/b] section and make sure that there is a line (add if not):
[b]DownloadManagers=OnlineSubsystemSteamworks.SteamWorkshopDownload[/b]
❗️ If there are several [b]DownloadManagers=[/b] then the line above should be the first ❗️
[*]Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section (create one if it doesn't exist):
2022-07-06 19:54:49 +00:00
[b]ServerSubscribedWorkshopItems=2830826239[/b]
2022-07-11 01:28:00 +00:00
[*]Start the server and wait while the mutator is downloading;
2024-04-28 17:53:02 +00:00
[*]When the download is complete, close the server;
2024-01-05 11:11:34 +00:00
[*]Create a file [b](*)[/b]: [b]<kf2-server>\KFGame\Config\KFCTI.ini[/b]
with the following content:
[b][CTI.CTI]
Version=0[/b]
2024-04-28 17:53:02 +00:00
[*]Add mutator to server start parameters: [b]?Mutator=CTI.Mut[/b] and start the server (this will generate the default KFCTI.ini content);
[*]Close the server and configure CTI as you need (see the [b]Setup (KFCTI.ini)[/b] section below);
[*]Start the server (with [b]?Mutator=CTI.Mut[/b]) again.
2022-07-11 01:28:00 +00:00
[/olist]
2022-07-06 19:54:49 +00:00
2024-01-07 17:12:12 +00:00
[h1][b](*)[/b] Buggy config variables initialization[/h1]
2024-03-24 18:53:18 +00:00
CTI, like many other mutators, initializes the config by relying on the unreal script feature which uses default values for each data type that is not explicitly specified. For the int type (which is used to store the config version) this is zero - detecting zero allows to understand that the mutator is being used for the first time (which means it's need to generate a config). But now the game contains a bug that initializes the config values randomly if they are not explicitly set. Thus, the config may have incorrect values or not be created at all. This is why I recommend explicitly set [b]Version=0[/b] in the config for the first time.
2024-01-07 17:12:12 +00:00
2022-10-01 17:47:38 +00:00
Unfortunately I can't do anything about it because it's a game problem (not mutator). I hope TWI fixes this someday.
2022-10-01 17:21:12 +00:00
2022-07-06 19:54:49 +00:00
[h1]Setup (KFCTI.ini)[/h1]
2022-07-11 01:28:00 +00:00
[list]
2024-01-07 17:25:52 +00:00
[*][b]bDisableItemLimitCheck[/b]: The original game does not support more than 256 trader items, adding items above this limit causes bugs. If this problem is solved (For example, if you are using a mutator that has already fixed this problem or by enabling [b]bApplyPatch[/b]) then it can be set [b]bDisableItemLimitCheck=True[/b] to remove the limit, otherwise it is better to leave it [b]False[/b].
2024-01-04 07:09:16 +00:00
2024-03-24 18:53:18 +00:00
[*]Set [b]bApplyPatch=True[/b] to fix some base classes of the game: this fixes problems when adding more than 256 items to a trader and will allow players to sell weapons that have been removed from trader inventory. Note that enabling this parameter replaces the following classes: [b]KFAutoPurchaseHelper[/b], [b]KFInventoryManager[/b], [b]KFGFxMenu_Trader[/b], [b]KFGFxObject_TraderItems[/b]. There may be compatibility issues with mutators that also replace them.
2024-01-04 07:09:16 +00:00
2024-03-24 18:53:18 +00:00
[*]Set [b]bPreloadContent=True[/b] to load weapon models in advance and have no lags when someone buys weapons. In some cases (usually if there is a lot of custom content), enabling preload can cause models to disappear. It is recommended to test how this setting affects the game for your server configuration and then decide whether to enable preloading or not.
2022-07-19 10:30:41 +00:00
2024-03-24 18:53:18 +00:00
[*]Set [b]bOfficialWeaponsList=True[/b] to have an auto-updated list of all official weapons in the config (for a convenient copy-paste) or leave it [b]False[/b] if you want a clean config without unnecessary things.
2022-07-19 10:30:41 +00:00
[*]Set [b]UnlockDLC[/b] to customize DLC weapon unlocks. Here are the possible values:
2022-07-19 10:30:41 +00:00
[list]
[*][b]False[/b] - disable DLC unlock.
[*][b]ReplaceFilter[/b] - changes the trader filter allowing you to buy original DLC weapons without restrictions, unlocks future DLCs as well (no need to update this mutator). However, it replaces the - [b]KFGFxMoviePlayer_Manager[/b] class so it may not be compatible with mods that also replace it.
[*][b]ReplaceWeapons[/b] - replaces DLC weapons with their unlocked variants. Compatible with any mods, but may require a CTI update after the release of new DLC weapons.
2024-01-05 11:11:34 +00:00
[*][b]True[/b] or [b]Auto[/b] - selects the most appropriate option automatically. Recommend putting CTI.Mut last in the mutator load queue if you use this.
2022-07-19 10:30:41 +00:00
[/list]
2022-07-11 01:28:00 +00:00
[*]Use [b][CTI.RemoveItems][/b] to remove items from the trader inventory.
2022-07-19 10:30:41 +00:00
example: [b]Item=KFGame.KFWeapDef_Mac10[/b] will remove MAC10 from sale.
2024-03-24 18:53:18 +00:00
[*]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).
2022-11-27 00:37:26 +00:00
[*]Set [b]bHRG=True[/b] to remove HRG items.
[*]Set [b]bDLC=True[/b] to remove DLC items.
2022-07-19 10:30:41 +00:00
2022-07-11 01:28:00 +00:00
[*]Use [b][CTI.AddItems][/b] to add items to the trader inventory.
2023-09-19 20:11:33 +00:00
example: [b]Item=WeaponPackExt.KFWeapDef_XM25[/b] will add [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1147408497]XM25[/url] to sale.
2022-07-11 01:28:00 +00:00
[/list]
2022-07-05 13:09:48 +00:00
2022-07-08 03:26:55 +00:00
[h1]Notes[/h1]
2024-01-07 17:12:12 +00:00
📌 If you need an empty list anywhere (for example, you don't want to delete some of the traders's weapons), leave at least one line there:
[b]Item=[/b]
This is necessary to explicitly initialize the list (because of the bug I wrote about above) to avoid initialization with incorrect values.
2022-07-08 03:26:55 +00:00
📌 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]Translators:[/h1]
[url=https://steamcommunity.com/profiles/76561199126205919]cheungfatzong[/url] - Traditional [CHT] and Simplified [CHN] Chinese.
2022-07-05 13:09:48 +00:00
[h1]Sources[/h1]
2022-09-02 08:48:27 +00:00
[url=https://github.com/GenZmeY/KF2-CustomTraderInventory]https://github.com/GenZmeY/KF2-CustomTraderInventory[/url] [b](GNU GPLv3)[/b]