KF2-SafeMutLoader/README.md

KF2-SafeMutLoader

Use non-whitelisted mutators and stay ranked.

Disclaimer

SML only uses KF2 and UnrealScript features, it doesn't change game executables or RAM or anything like that, so it's not a hack and it doesn't violate Killing Floor 2 EULA.

However, AccessPlus is also not a hack for the same reason, but it is constantly banned in the steam workshop. Why? I dont know.

So use this at your own risk!

Usage (server only)

1. Add SML to your server. There are two ways:

• without workshop: download SML.u from releases and put it to KFGame/BrewedPC
• with workshop: Use the instructions below to build the SML and upload it to your workshop, then subscribe your server to SML

2. Add SML.Mut first to your list of mutators, example:

?Mutator=SML.Mut,UnofficialKFPatch.UKFPMutator,AAL.AALMut,DiscordMessage.DMMutator,YAS.YASMut,CTI.CTIMut,CVC.CVCMut,ZedSpawner.ZedSpawnerMut

(add/remove compatible mutators you need)

⚠️ Doesn't work in single player
⚠️ SML must be first in the mutators list or it won't work.
⚠️ SML only has an effect when compatible mutators are used (the list below). If you use incompatible mutators you will lose ranked status.
⚠️ SML is a server-side mutator, clients never download it. Therefore, no one will know about you using SML if you don’t tell yourself (or if you share with the whole world the BrewedPC folder where you put the SML, lol).
⚠️ SML is incompatible with AccessPlus and other mods based on it. If you need something from there, implement it as an SML compatible mutator using developer guide.

Compatible mutators

🟢 Any whitelisted mutators
🟢 Admin Auto Login
🟢 Controlled Vote Collector
🟡 Custom Trader Inventory
Purchasing a DLC weapon will unrank the server if currently there is no player with the purchased DLC. This can be bypassed by replacing all DLC weapons with their clones.
Since KF2 v1133 the content preload causes the server to unrank for some reason. Disable it in CTI settings (bPreloadContent=False) to stay ranked.
🟢 Discord Link [Edited]
🟢 Looted Trader Inventory
🟢 Unofficial Killing Floor 2 Patch
🟢 Yet Another Scoreboard
🟡 Zed Spawner
Since KF2 v1133 zed preload causes the server to unrank for some reason. Disable it in ZedSpawner settings (bPreloadContentServer=False) to stay ranked.

Making SML-compatible mutators

See developer guide

Build & Upload

Note: If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow these instructions instead of what is described here.

1. Install Killing Floor 2, Killing Floor 2 - SDK and git for windows;
2. open git-bash and go to any folder where you want to store sources:
   cd <ANY_FOLDER_YOU_WANT>
3. Clone this repository and go to the source folder:
   git clone https://github.com/GenZmeY/KF2-SafeMutLoader && cd KF2-SafeMutLoader
4. Download dependencies:
   git submodule init && git submodule update
5. Build and upload to steam workshop:
   ./tools/builder -cbu
6. Find SafeMutLoader in your workshop and change Visibility to Unlisted so your server can download it (don't use Public visibility)

Contributing

If you make a mod compatible with SML I'll be happy to add it to the list of compatible mutators.
Contact me in any convenient way (for example, create an issue)

License

GNU GPLv3