KillingFloor2/KF2-SafeMutLoader
KillingFloor2/KF2-SafeMutLoader
1
0
Fork 0
Code Releases 7 Activity

Merge pull request #4 from GenZmeY/MegaLinter

Browse Source 
Mega linter
This commit is contained in:
GenZmeY 2023-05-14 04:52:20 +03:00 committed by GitHub
commit 83ef34bf34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 690 additions and 585 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
.editorconfig Normal file
View File

@ -0,0 +1,33 @@
root = true
# Global
[*]
indent_style = unset
indent_size = 4
tab_width = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = unset
# Unreal Engine 3 / Source
[*.uc]
indent_style = tab
[*.{uci,upkg}]
# Unreal Engine 3 / i18n
[*.{chn,cht,cze,dan,deu,dut,esl,esn,fra,frc,hun,int,ita,jpn,kor,pol,por,ptb,rus,tur,ukr}]
charset = utf-16le
# Other
[*.md]
indent_style = space
trim_trailing_whitespace = false
[*.yml]
indent_style = space
indent_size = 2
[*.{txt,cfg,conf}]
indent_style = tab

72
.github/workflows/mega-linter.yml vendored Normal file
View File

@ -0,0 +1,72 @@
---
name: MegaLinter
permissions: read-all
on:
push:
pull_request:
branches: [master]
env:
APPLY_FIXES: none
APPLY_FIXES_EVENT: pull_request
APPLY_FIXES_MODE: commit
DISABLE: SPELL
concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true
jobs:
build:
name: MegaLinter
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
- name: MegaLinter
id: ml
uses: oxsecurity/megalinter@v6
env:
VALIDATE_ALL_CODEBASE: true
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Archive production artifacts
if: ${{ success() }} || ${{ failure() }}
uses: actions/upload-artifact@v3
with:
name: MegaLinter reports
path: |
megalinter-reports
mega-linter.log
- name: Create Pull Request with applied fixes
id: cpr
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
commit-message: "[MegaLinter] Apply linters automatic fixes"
title: "[MegaLinter] Apply linters automatic fixes"
labels: bot
- name: Create PR output
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
- name: Prepare commit
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
run: sudo chown -Rc $UID .git/
- name: Commit and push applied linter fixes
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
commit_message: "[MegaLinter] Apply linters fixes"
commit_user_name: megalinter-bot
commit_user_email: nicolas.vuillamy@ox.security

112
DEV.md
View File

@ -2,7 +2,7 @@
**SML compatible mutator development guide** **SML compatible mutator development guide**
# Mutator template ## Mutator template
You can use this template to make the mutator compatible with SML. You can use this template to make the mutator compatible with SML.
Here I will use `Example` as mutator name. **Replace it with yours.** Here I will use `Example` as mutator name. **Replace it with yours.**
@ -10,64 +10,64 @@ Here I will use `Example` as mutator name. **Replace it with yours.**
**ExampleMut.uc** **ExampleMut.uc**
```unrealscript ```unrealscript
class ExampleMut extends KFMutator; class ExampleMut extends KFMutator;
var private Example Example; var private Example Example;
public simulated function bool SafeDestroy() public simulated function bool SafeDestroy()
{ {
return (bPendingDelete || bDeleteMe || Destroy()); return (bPendingDelete || bDeleteMe || Destroy());
} }
public event PreBeginPlay() public event PreBeginPlay()
{ {
Super.PreBeginPlay(); Super.PreBeginPlay();
if (WorldInfo.NetMode == NM_Client) return; if (WorldInfo.NetMode == NM_Client) return;
foreach WorldInfo.DynamicActors(class'Example', Example) foreach WorldInfo.DynamicActors(class'Example', Example)
{ {
break; break;
} }
if (Example == None) if (Example == None)
{ {
Example = WorldInfo.Spawn(class'Example'); Example = WorldInfo.Spawn(class'Example');
} }
if (Example == None) if (Example == None)
{ {
`Log("Example: FATAL: Can't Spawn 'Example'"); `Log("Example: FATAL: Can't Spawn 'Example'");
SafeDestroy(); SafeDestroy();
} }
} }
public function AddMutator(Mutator Mut) public function AddMutator(Mutator Mut)
{ {
if (Mut == Self) return; if (Mut == Self) return;
if (Mut.Class == Class) if (Mut.Class == Class)
ExampleMut(Mut).SafeDestroy(); ExampleMut(Mut).SafeDestroy();
else else
Super.AddMutator(Mut); Super.AddMutator(Mut);
} }
public function NotifyLogin(Controller C) public function NotifyLogin(Controller C)
{ {
Example.NotifyLogin(C); Example.NotifyLogin(C);
Super.NotifyLogin(C); Super.NotifyLogin(C);
} }
public function NotifyLogout(Controller C) public function NotifyLogout(Controller C)
{ {
Example.NotifyLogout(C); Example.NotifyLogout(C);
Super.NotifyLogout(C); Super.NotifyLogout(C);
} }
static function String GetLocalString(optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2) static function String GetLocalString(optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2)
{ {
return String(class'Example'); return String(class'Example');
} }
defaultproperties defaultproperties
@ -82,34 +82,34 @@ class Example extends Info;
public event PreBeginPlay() public event PreBeginPlay()
{ {
Super.PreBeginPlay(); Super.PreBeginPlay();
// do some initialization here // do some initialization here
} }
public event PostBeginPlay() public event PostBeginPlay()
{ {
Super.PostBeginPlay(); Super.PostBeginPlay();
// do some initialization here // do some initialization here
} }
public function NotifyLogin(Controller C) public function NotifyLogin(Controller C)
{ {
// Do what you need here when the player log in // Do what you need here when the player log in
} }
public function NotifyLogout(Controller C) public function NotifyLogout(Controller C)
{ {
// Do what you need here when the player log out // Do what you need here when the player log out
} }
public simulated function vector GetTargetLocation(optional actor RequestedBy, optional bool bRequestAlternateLoc) public simulated function vector GetTargetLocation(optional actor RequestedBy, optional bool bRequestAlternateLoc)
{ {
local Controller C; local Controller C;
C = Controller(RequestedBy); C = Controller(RequestedBy);
if (C != None) { bRequestAlternateLoc ? NotifyLogout(C) : NotifyLogin(C); } if (C != None) { bRequestAlternateLoc ? NotifyLogout(C) : NotifyLogin(C); }
return Super.GetTargetLocation(RequestedBy, bRequestAlternateLoc); return Super.GetTargetLocation(RequestedBy, bRequestAlternateLoc);
} }
defaultproperties defaultproperties
@ -120,21 +120,21 @@ defaultproperties
That's all. You can create new classes and add any code to `Example.uc` (yay!), but refrain from implementing anything else in `ExampleMut.uc` because it will not be used. That's all. You can create new classes and add any code to `Example.uc` (yay!), but refrain from implementing anything else in `ExampleMut.uc` because it will not be used.
# Limitations ## Limitations
❌ Can't make ranked game mode this way; ❌ Can't make ranked game mode this way;
❌ SML can only emulate [`NotifyLogin(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/Mutator.uc#L147) and [`NotifyLogout(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/Mutator.uc#L141), other functions of the [`Mutator`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/master/Engine/Classes/Mutator.uc) and [`KFMutator`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/master/KFGame/Classes/KFMutator.uc) classes are not supported - look for workarounds in this case. ❌ SML can only emulate [`NotifyLogin(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/Mutator.uc#L147) and [`NotifyLogout(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/Mutator.uc#L141), other functions of the [`Mutator`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/master/Engine/Classes/Mutator.uc) and [`KFMutator`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/master/KFGame/Classes/KFMutator.uc) classes are not supported - look for workarounds in this case.
# Tips ## Tips
## Alternative to the InitMutator(...) function ## Alternative to the InitMutator(...) function
Even though the [`InitMutator(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFMutator.uc#L22) function is not supported, you can still parse the startup string if you need to: Even though the [`InitMutator(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFMutator.uc#L22) function is not supported, you can still parse the startup string if you need to:
Refer to [`WorldInfo.GetLocalURL()`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/WorldInfo.uc#L1315) and get the option from there. It's best to do this in `PreBeginPlay()` or `PostBeginPlay()` of your `Example.uc` (as well as other initializations). Refer to [`WorldInfo.GetLocalURL()`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/Engine/Classes/WorldInfo.uc#L1315) and get the option from there. It's best to do this in `PreBeginPlay()` or `PostBeginPlay()` of your `Example.uc` (as well as other initializations).
## XP for custom Zeds / Weapons ### XP for custom Zeds / Weapons
While custom weapons and zeds won't make your server unranked, the [`ValidateForXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2564) function will not allow you to gain experience if it detects a custom zed or custom damage type. While custom weapons and zeds won't make your server unranked, the [`ValidateForXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2564) function will not allow you to gain experience if it detects a custom zed or custom damage type.
Therefore, if you want to gain experience - make sure that [`ValidateForXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2564) does not receive custom zed classes or custom damage types. Therefore, if you want to gain experience - make sure that [`ValidateForXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2564) does not receive custom zed classes or custom damage types.
For example you can change your custom weapon to use only default damage types or try changing the `DamageHistory` and/or `MonsterClass` before it gets into [`DistributeMoneyAndXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2489). For example you can change your custom weapon to use only default damage types or try changing the `DamageHistory` and/or `MonsterClass` before it gets into [`DistributeMoneyAndXP(...)`](https://github.com/GenZmeY/KF2-Dev-Scripts/blob/23d1ca3a9a2f62692741e77039f03fe0a913be1d/KFGame/Classes/KFGameInfo.uc#L2489).
## Replacing base classes to bypass restrictions ### Replacing base classes to bypass restrictions
In some cases, changing the base classes of the game can help. For example, we cannot make [TAWOD](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040) and SML compatible because the [PreventDeath(...)](https://github.com/GenZmeY/KF2-TAWOD/blob/master/TAWOD/Classes/TAWODMut.uc#L19) function is not supported. But this can be bypassed by replacing the player's Pawn base class with custom Pawn class: In some cases, changing the base classes of the game can help. For example, we cannot make [TAWOD](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040) and SML compatible because the [PreventDeath(...)](https://github.com/GenZmeY/KF2-TAWOD/blob/master/TAWOD/Classes/TAWODMut.uc#L19) function is not supported. But this can be bypassed by replacing the player's Pawn base class with custom Pawn class:
```unrealscript ```unrealscript
WorldInfo.Game.DefaultPawnClass = class'ExamplePawn_Human'; // Put this to `PostBeginPlay()` of your Example.uc WorldInfo.Game.DefaultPawnClass = class'ExamplePawn_Human'; // Put this to `PostBeginPlay()` of your Example.uc
@ -146,13 +146,13 @@ class ExamplePawn_Human extends KFPawn_Human;
public function ThrowWeaponOnDeath() public function ThrowWeaponOnDeath()
{ {
local KFWeapon KFW; local KFWeapon KFW;
if (InvManager == None) return; if (InvManager == None) return;
foreach InvManager.InventoryActors(class'KFWeapon', KFW) foreach InvManager.InventoryActors(class'KFWeapon', KFW)
if (KFW.bDropOnDeath && KFW.CanThrow()) if (KFW.bDropOnDeath && KFW.CanThrow())
KFP.TossInventory(KFW); KFP.TossInventory(KFW);
} }
``` ```

18
README.md
View File

@ -1,19 +1,19 @@
# KF2-SafeMutLoader # KF2-SafeMutLoader
Use non-whitelisted mutators and stay ranked. Use non-whitelisted mutators and stay ranked.
# Disclaimer ## 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](https://store.steampowered.com/eula/232090_eula_0).** **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](https://store.steampowered.com/eula/232090_eula_0).**
However, [AccessPlus](https://forums.tripwireinteractive.com/index.php?threads/utility-admin-access-plus-manager.118740) is also not a hack for the same reason, but it is constantly banned in the steam workshop. Why? I dont know. However, [AccessPlus](https://forums.tripwireinteractive.com/index.php?threads/utility-admin-access-plus-manager.118740) 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!** **So use this at your own risk!**
# Usage (server only) ## Usage (server only)
1. Add SML to your server. There are two ways: 1. Add SML to your server. There are two ways:
* **without workshop:** download `SML.u` from [releases](https://github.com/GenZmeY/KF2-SafeMutLoader/releases) and put it to `KFGame/BrewedPC` * **without workshop:** download `SML.u` from [releases](https://github.com/GenZmeY/KF2-SafeMutLoader/releases) and put it to `KFGame/BrewedPC`
* **with workshop:** Use the [instructions below](https://github.com/GenZmeY/KF2-SafeMutLoader#build--upload) to build the SML and upload it to your workshop, then subscribe your server to SML * **with workshop:** Use the [instructions below](https://github.com/GenZmeY/KF2-SafeMutLoader#build--upload) 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: 2. Add `SML.Mut` **first** to your list of mutators, example:
``` ```text
?Mutator=SML.Mut,UnofficialKFPatch.UKFPMutator,AAL.AALMut,DiscordMessage.DMMutator,YAS.YASMut,CTI.CTIMut,CVC.CVCMut,ZedSpawner.ZedSpawnerMut ?Mutator=SML.Mut,UnofficialKFPatch.UKFPMutator,AAL.AALMut,DiscordMessage.DMMutator,YAS.YASMut,CTI.CTIMut,CVC.CVCMut,ZedSpawner.ZedSpawnerMut
``` ```
(add/remove **compatible** mutators you need) (add/remove **compatible** mutators you need)
@ -24,7 +24,7 @@ However, [AccessPlus](https://forums.tripwireinteractive.com/index.php?threads/u
⚠️ 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 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](https://github.com/th3-z/kf2-acpp) and other mods based on it. If you need something from there, implement it as an SML compatible mutator using [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/DEV.md). ⚠️ SML is incompatible with [AccessPlus](https://github.com/th3-z/kf2-acpp) and other mods based on it. If you need something from there, implement it as an SML compatible mutator using [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/DEV.md).
# Compatible mutators ## Compatible mutators
🟢 Any whitelisted mutators 🟢 Any whitelisted mutators
🟢 [Admin Auto Login](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389) 🟢 [Admin Auto Login](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
🟢 [Controlled Vote Collector](https://steamcommunity.com/sharedfiles/filedetails/?id=2847465899) 🟢 [Controlled Vote Collector](https://steamcommunity.com/sharedfiles/filedetails/?id=2847465899)
@ -38,10 +38,10 @@ Since KF2 [v1133](https://wiki.killingfloor2.com/index.php?title=Update_1133_(Ki
🟡 [Zed Spawner](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931) 🟡 [Zed Spawner](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931)
Since KF2 [v1133](https://wiki.killingfloor2.com/index.php?title=Update_1133_(Killing_Floor_2)) zed preload causes the server to unrank for some reason. Disable it in ZedSpawner settings (`bPreloadContentServer=False`) to stay ranked. Since KF2 [v1133](https://wiki.killingfloor2.com/index.php?title=Update_1133_(Killing_Floor_2)) zed preload causes the server to unrank for some reason. Disable it in ZedSpawner settings (`bPreloadContentServer=False`) to stay ranked.
# Making SML-compatible mutators ## Making SML-compatible mutators
See [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/DEV.md) See [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/DEV.md)
# Build & Upload ## Build & Upload
**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. **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); 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: 2. open git-bash and go to any folder where you want to store sources:
@ -54,9 +54,9 @@ See [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/D
`./tools/builder -cbu` `./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) 6. Find `SafeMutLoader` in your workshop and change `Visibility` to `Unlisted` so your server can download it (don't use `Public` visibility)
# Contributing ## Contributing
If you make a mod compatible with SML I'll be happy to add it to the list of compatible mutators. 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](https://github.com/GenZmeY/KF2-SafeMutLoader/issues)) Contact me in any convenient way (for example, create an [issue](https://github.com/GenZmeY/KF2-SafeMutLoader/issues))
# License ## License
[GNU GPLv3](LICENSE) [![license](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](LICENSE)

2
SML/Classes/KFGI_Access.uc
View File

@ -7,5 +7,5 @@ public function bool IsRankedGame()
defaultproperties defaultproperties
{ {
} }

282
SML/Classes/Mut.uc
View File

@ -1,142 +1,142 @@
class Mut extends KFMutator; class Mut extends KFMutator;
const SML = class'SafeMutLoader'; const SML = class'SafeMutLoader';
const OptAC = "AccessControl"; const OptAC = "AccessControl";
const OptMut = "Mutator"; const OptMut = "Mutator";
var private E_LogLevel LogLevel; var private E_LogLevel LogLevel;
public function PreBeginPlay() public function PreBeginPlay()
{ {
Super.PreBeginPlay(); Super.PreBeginPlay();
LogLevel = SML.static.GetLogLevel(); LogLevel = SML.static.GetLogLevel();
`Log_Trace(); `Log_Trace();
if (CorrectLoadOrder()) if (CorrectLoadOrder())
{ {
ModifyLoad(); ModifyLoad();
} }
else else
{ {
`Log_Fatal(SML.static.GetName(Self) @ "must be loaded first."); `Log_Fatal(SML.static.GetName(Self) @ "must be loaded first.");
} }
} }
public function AddMutator(Mutator Mut) public function AddMutator(Mutator Mut)
{ {
`Log_Trace(); `Log_Trace();
if (CorrectLoadOrder() || Mut == Self) return; if (CorrectLoadOrder() || Mut == Self) return;
if (Mut.Class == Class) if (Mut.Class == Class)
{ {
Mut.Destroy(); Mut.Destroy();
} }
else else
{ {
Super.AddMutator(Mut); Super.AddMutator(Mut);
} }
} }
private function bool CorrectLoadOrder() private function bool CorrectLoadOrder()
{ {
`Log_Trace(); `Log_Trace();
return ( return (
WorldInfo.Game.BaseMutator == None || WorldInfo.Game.BaseMutator == None ||
WorldInfo.Game.BaseMutator == Self); WorldInfo.Game.BaseMutator == Self);
} }
private function ModifyLoad() private function ModifyLoad()
{ {
local String LoadURL; local String LoadURL;
local String LoadParams; local String LoadParams;
local String MutatorsRaw; local String MutatorsRaw;
local String AccessControlRaw; local String AccessControlRaw;
local Array<String> Mutators; local Array<String> Mutators;
local int PrevServerActorsCount; local int PrevServerActorsCount;
local int Index; local int Index;
local GameEngine GameEngine; local GameEngine GameEngine;
`Log_Trace(); `Log_Trace();
LoadURL = WorldInfo.GetLocalURL(); LoadURL = WorldInfo.GetLocalURL();
LoadParams = Mid(LoadURL, InStr(LoadURL, "?")); LoadParams = Mid(LoadURL, InStr(LoadURL, "?"));
MutatorsRaw = WorldInfo.Game.ParseOption(LoadParams, OptMut); MutatorsRaw = WorldInfo.Game.ParseOption(LoadParams, OptMut);
AccessControlRaw = WorldInfo.Game.ParseOption(LoadParams, OptAC); AccessControlRaw = WorldInfo.Game.ParseOption(LoadParams, OptAC);
LoadURL = Repl(LoadURL, Subst(OptMut) $ MutatorsRaw, ""); LoadURL = Repl(LoadURL, Subst(OptMut) $ MutatorsRaw, "");
LoadURL = Repl(LoadURL, Subst(OptAC) $ AccessControlRaw, ""); LoadURL = Repl(LoadURL, Subst(OptAC) $ AccessControlRaw, "");
SML.static.ClearMutators(); SML.static.ClearMutators();
SML.static.ClearServerActors(); SML.static.ClearServerActors();
ParseStringIntoArray(MutatorsRaw, Mutators, ",", true); ParseStringIntoArray(MutatorsRaw, Mutators, ",", true);
Index = 0; Index = 0;
while (Index < Mutators.Length) while (Index < Mutators.Length)
{ {
if (SML.static.AddMutator(Mutators[Index]) || if (SML.static.AddMutator(Mutators[Index]) ||
Mutators[Index] ~= SML.static.GetName(Self)) Mutators[Index] ~= SML.static.GetName(Self))
{ {
Mutators.Remove(Index, 1); Mutators.Remove(Index, 1);
} }
else else
{ {
++Index; ++Index;
} }
} }
GameEngine = GameEngine(Class'Engine'.static.GetEngine()); GameEngine = GameEngine(Class'Engine'.static.GetEngine());
if (GameEngine == None) if (GameEngine == None)
{ {
`Log_Error("GameEngine is None, skip loading server actors"); `Log_Error("GameEngine is None, skip loading server actors");
} }
else else
{ {
PrevServerActorsCount = GameEngine.ServerActors.Length; PrevServerActorsCount = GameEngine.ServerActors.Length;
Index = 0; Index = 0;
while (Index < GameEngine.ServerActors.Length) while (Index < GameEngine.ServerActors.Length)
{ {
if (SML.static.AddServerActor(GameEngine.ServerActors[Index])) if (SML.static.AddServerActor(GameEngine.ServerActors[Index]))
{ {
GameEngine.ServerActors.Remove(Index, 1); GameEngine.ServerActors.Remove(Index, 1);
} }
else else
{ {
++Index; ++Index;
} }
} }
if (GameEngine.ServerActors.Length != PrevServerActorsCount) if (GameEngine.ServerActors.Length != PrevServerActorsCount)
{ {
GameEngine.SaveConfig(); GameEngine.SaveConfig();
} }
} }
SML.static.StaticSaveConfig(); SML.static.StaticSaveConfig();
JoinArray(Mutators, MutatorsRaw); JoinArray(Mutators, MutatorsRaw);
LoadURL $= (Subst(OptMut) $ MutatorsRaw); LoadURL $= (Subst(OptMut) $ MutatorsRaw);
if (SML.static.WantsToSpawn()) if (SML.static.WantsToSpawn())
{ {
LoadURL $= (Subst(OptAC) $ SML.static.GetName()); LoadURL $= (Subst(OptAC) $ SML.static.GetName());
} }
`Log_Info("Loader modified, do server travel..."); `Log_Info("Loader modified, do server travel...");
WorldInfo.ServerTravel(LoadURL, true); WorldInfo.ServerTravel(LoadURL, true);
} }
private static function String Subst(String Option) private static function String Subst(String Option)
{ {
return ("?" $ Option $ "="); return ("?" $ Option $ "=");
} }
defaultproperties defaultproperties
{ {
} }

8
SML/Classes/SML.upkg
View File

@ -1,4 +1,4 @@
[Flags] [Flags]
AllowDownload=False AllowDownload=False
ClientOptional=False ClientOptional=False
ServerSideOnly=True ServerSideOnly=True

660
SML/Classes/SafeMutLoader.uc
View File

@ -1,331 +1,331 @@
class SafeMutLoader extends KFAccessControl class SafeMutLoader extends KFAccessControl
config(SML); config(SML);
struct CMR struct CMR
{ {
var String Mutator; var String Mutator;
var String Replacement; var String Replacement;
}; };
var private Array<Actor> ActiveMutators; var private Array<Actor> ActiveMutators;
var private Array<Actor> ActiveServerActors; var private Array<Actor> ActiveServerActors;
var private Array<CMR> CustomMutReplacements; var private Array<CMR> CustomMutReplacements;
var private Array<String> SystemServerActors; var private Array<String> SystemServerActors;
var private config E_LogLevel LogLevel; var private config E_LogLevel LogLevel;
var private config Array<String> Mutators; var private config Array<String> Mutators;
var private config Array<String> ServerActors; var private config Array<String> ServerActors;
public function PreBeginPlay() public function PreBeginPlay()
{ {
LogLevel = GetLogLevel(); LogLevel = GetLogLevel();
`Log_Trace(); `Log_Trace();
Super.PreBeginPlay(); Super.PreBeginPlay();
LoadMutators(); LoadMutators();
LoadServerActors(); LoadServerActors();
} }
public function PostBeginPlay() public function PostBeginPlay()
{ {
local KFGI_Access KFGIA; local KFGI_Access KFGIA;
`Log_Trace(); `Log_Trace();
Super.PostBeginPlay(); Super.PostBeginPlay();
RestoreServerActors(); RestoreServerActors();
KFGIA = GetKFGIA(); KFGIA = GetKFGIA();
if (KFGIA == None) if (KFGIA == None)
{ {
`Log_Error("Can't check ranked status"); `Log_Error("Can't check ranked status");
} }
else if (KFGIA.IsRankedGame()) else if (KFGIA.IsRankedGame())
{ {
`Log_Info("Mutators and server actors successfully loaded! Your server is RANKED!"); `Log_Info("Mutators and server actors successfully loaded! Your server is RANKED!");
} }
else else
{ {
`Log_Warn("Your server is UNRANKED! Check the mutators and server actors you are using. Maybe some of them are incompatible with SML"); `Log_Warn("Your server is UNRANKED! Check the mutators and server actors you are using. Maybe some of them are incompatible with SML");
} }
} }
private function KFGI_Access GetKFGIA() private function KFGI_Access GetKFGIA()
{ {
local KFGameInfo KFGI; local KFGameInfo KFGI;
if (WorldInfo == None || WorldInfo.Game == None) if (WorldInfo == None || WorldInfo.Game == None)
{ {
return None; return None;
} }
KFGI = KFGameInfo(WorldInfo.Game); KFGI = KFGameInfo(WorldInfo.Game);
if (KFGI == None) if (KFGI == None)
{ {
return None; return None;
} }
return new(KFGI) class'KFGI_Access'; return new(KFGI) class'KFGI_Access';
} }
private function LoadMutators() private function LoadMutators()
{ {
local String MutString; local String MutString;
local class<Mutator> MutClass; local class<Mutator> MutClass;
local class<Actor> ActClass; local class<Actor> ActClass;
local Actor ServerActor; local Actor ServerActor;
`Log_Trace(); `Log_Trace();
foreach Mutators(MutString) foreach Mutators(MutString)
{ {
MutClass = class<Mutator>(DynamicLoadObject(MutString, class'Class')); MutClass = class<Mutator>(DynamicLoadObject(MutString, class'Class'));
if (MutClass == None) if (MutClass == None)
{ {
`Log_Error("Can't load mutator:" @ MutString); `Log_Error("Can't load mutator:" @ MutString);
continue; continue;
} }
ActClass = GetMutReplacement(MutClass); ActClass = GetMutReplacement(MutClass);
if (ActClass == None) if (ActClass == None)
{ {
`Log_Warn("Incompatible:" @ MutString @ "(skip)"); `Log_Warn("Incompatible:" @ MutString @ "(skip)");
continue; continue;
} }
ServerActor = WorldInfo.Spawn(ActClass); ServerActor = WorldInfo.Spawn(ActClass);
if (ServerActor == None) if (ServerActor == None)
{ {
`Log_Error("Can't spawn:" @ MutString); `Log_Error("Can't spawn:" @ MutString);
continue; continue;
} }
ActiveMutators.AddItem(ServerActor); ActiveMutators.AddItem(ServerActor);
`Log_Info("Loaded:" @ MutString); `Log_Info("Loaded:" @ MutString);
} }
} }
private function LoadServerActors() private function LoadServerActors()
{ {
local String ActorString; local String ActorString;
local class<Actor> ActorClass; local class<Actor> ActorClass;
local Actor ServerActor; local Actor ServerActor;
foreach ServerActors(ActorString) foreach ServerActors(ActorString)
{ {
ActorClass = class<Actor>(DynamicLoadObject(ActorString, class'Class')); ActorClass = class<Actor>(DynamicLoadObject(ActorString, class'Class'));
if (ActorClass == None) if (ActorClass == None)
{ {
`Log_Error("Can't load server actor:" @ ActorString); `Log_Error("Can't load server actor:" @ ActorString);
continue; continue;
} }
ServerActor = WorldInfo.Spawn(ActorClass); ServerActor = WorldInfo.Spawn(ActorClass);
if (ServerActor == None) if (ServerActor == None)
{ {
`Log_Error("Can't spawn:" @ ActorString); `Log_Error("Can't spawn:" @ ActorString);
continue; continue;
} }
ActiveServerActors.AddItem(ServerActor); ActiveServerActors.AddItem(ServerActor);
`Log_Info("Loaded:" @ ActorString); `Log_Info("Loaded:" @ ActorString);
} }
} }
private function RestoreServerActors() private function RestoreServerActors()
{ {
local GameEngine GameEngine; local GameEngine GameEngine;
local String ActorString; local String ActorString;
local int PrevServerActorsCount; local int PrevServerActorsCount;
GameEngine = GameEngine(Class'Engine'.static.GetEngine()); GameEngine = GameEngine(Class'Engine'.static.GetEngine());
if (GameEngine == None) if (GameEngine == None)
{ {
`Log_Error("GameEngine is None! Can't restore ServerActors!"); `Log_Error("GameEngine is None! Can't restore ServerActors!");
return; return;
} }
PrevServerActorsCount = GameEngine.ServerActors.Length; PrevServerActorsCount = GameEngine.ServerActors.Length;
foreach ServerActors(ActorString) foreach ServerActors(ActorString)
{ {
if (GameEngine.ServerActors.Find(ActorString) != INDEX_NONE) if (GameEngine.ServerActors.Find(ActorString) != INDEX_NONE)
{ {
GameEngine.ServerActors.AddItem(ActorString); GameEngine.ServerActors.AddItem(ActorString);
} }
} }
if (GameEngine.ServerActors.Length != PrevServerActorsCount) if (GameEngine.ServerActors.Length != PrevServerActorsCount)
{ {
GameEngine.SaveConfig(); GameEngine.SaveConfig();
} }
} }
public static function bool AddServerActor(String ServerActor) public static function bool AddServerActor(String ServerActor)
{ {
local class<Actor> ActorClass; local class<Actor> ActorClass;
if (default.SystemServerActors.Find(ServerActor) != INDEX_NONE) if (default.SystemServerActors.Find(ServerActor) != INDEX_NONE)
{ {
return false; return false;
} }
ActorClass = class<Actor>(DynamicLoadObject(ServerActor, class'Class')); ActorClass = class<Actor>(DynamicLoadObject(ServerActor, class'Class'));
if (ActorClass == None) if (ActorClass == None)
{ {
return false; return false;
} }
if (ClassIsChildOf(ActorClass, class'Mutator')) if (ClassIsChildOf(ActorClass, class'Mutator'))
{ {
return false; return false;
} }
if (default.ServerActors.Find(ServerActor) == INDEX_NONE) if (default.ServerActors.Find(ServerActor) == INDEX_NONE)
{ {
default.ServerActors.AddItem(ServerActor); default.ServerActors.AddItem(ServerActor);
} }
return true; return true;
} }
public static function bool AddMutator(String MutString) public static function bool AddMutator(String MutString)
{ {
if (GetMutStringReplacement(MutString) != None) if (GetMutStringReplacement(MutString) != None)
{ {
if (default.Mutators.Find(MutString) == INDEX_NONE) if (default.Mutators.Find(MutString) == INDEX_NONE)
{ {
default.Mutators.AddItem(MutString); default.Mutators.AddItem(MutString);
} }
return true; return true;
} }
return false; return false;
} }
public static function ClearMutators() public static function ClearMutators()
{ {
default.Mutators.Length = 0; default.Mutators.Length = 0;
} }
public static function ClearServerActors() public static function ClearServerActors()
{ {
default.ServerActors.Length = 0; default.ServerActors.Length = 0;
} }
public static function bool WantsToSpawn() public static function bool WantsToSpawn()
{ {
return (default.Mutators.Length > 0); return (default.Mutators.Length > 0);
} }
public static function String GetName(optional Object O) public static function String GetName(optional Object O)
{ {
if (O == None) if (O == None)
{ {
return (default.class.GetPackageName() $ "." $ String(default.class)); return (default.class.GetPackageName() $ "." $ String(default.class));
} }
else else
{ {
return (O.class.GetPackageName() $ "." $ String(O.class)); return (O.class.GetPackageName() $ "." $ String(O.class));
} }
} }
public static function String GetMutName(class<Mutator> CMut) public static function String GetMutName(class<Mutator> CMut)
{ {
if (CMut == None) return ""; if (CMut == None) return "";
return CMut.GetPackageName() $ "." $ String(CMut); return CMut.GetPackageName() $ "." $ String(CMut);
} }
public function PostLogin(PlayerController C) public function PostLogin(PlayerController C)
{ {
local Actor A; local Actor A;
`Log_Trace(); `Log_Trace();
if (C != None) if (C != None)
{ {
foreach ActiveMutators(A) foreach ActiveMutators(A)
{ {
A.GetTargetLocation(C, false); A.GetTargetLocation(C, false);
} }
} }
Super.PostLogin(C); Super.PostLogin(C);
} }
public function OnClientConnectionClose(Player ClientConnection) public function OnClientConnectionClose(Player ClientConnection)
{ {
local Controller C; local Controller C;
local Actor A; local Actor A;
`Log_Trace(); `Log_Trace();
C = ClientConnection.Actor; C = ClientConnection.Actor;
if (C != None) if (C != None)
{ {
foreach ActiveMutators(A) foreach ActiveMutators(A)
{ {
A.GetTargetLocation(C, true); A.GetTargetLocation(C, true);
} }
} }
Super.OnClientConnectionClose(ClientConnection); Super.OnClientConnectionClose(ClientConnection);
} }
public static function E_LogLevel GetLogLevel() public static function E_LogLevel GetLogLevel()
{ {
if (default.LogLevel == LL_WrongLevel) if (default.LogLevel == LL_WrongLevel)
{ {
default.LogLevel = LL_Info; default.LogLevel = LL_Info;
StaticSaveConfig(); StaticSaveConfig();
} }
return default.LogLevel; return default.LogLevel;
} }
private static function class<Actor> GetMutReplacement(class<Mutator> MutClass) private static function class<Actor> GetMutReplacement(class<Mutator> MutClass)
{ {
local int Index; local int Index;
local String Replacement; local String Replacement;
if (MutClass == None) return None; if (MutClass == None) return None;
Index = default.CustomMutReplacements.Find('Mutator', GetMutName(MutClass)); Index = default.CustomMutReplacements.Find('Mutator', GetMutName(MutClass));
if (Index != INDEX_NONE) if (Index != INDEX_NONE)
{ {
Replacement = default.CustomMutReplacements[Index].Replacement; Replacement = default.CustomMutReplacements[Index].Replacement;
} }
else if (MutClass.static.GetLocalString() == "") else if (MutClass.static.GetLocalString() == "")
{ {
return None; return None;
} }
else else
{ {
Replacement = MutClass.GetPackageName() $ "." $ MutClass.static.GetLocalString(); Replacement = MutClass.GetPackageName() $ "." $ MutClass.static.GetLocalString();
} }
return class<Actor>(DynamicLoadObject(Replacement, class'Class')); return class<Actor>(DynamicLoadObject(Replacement, class'Class'));
} }
private static function class<Actor> GetMutStringReplacement(String MutString) private static function class<Actor> GetMutStringReplacement(String MutString)
{ {
return GetMutReplacement(class<Mutator>(DynamicLoadObject(MutString, class'Class'))); return GetMutReplacement(class<Mutator>(DynamicLoadObject(MutString, class'Class')));
} }
defaultproperties defaultproperties
{ {
CustomMutReplacements.Add({( CustomMutReplacements.Add({(
Mutator="UnofficialKFPatch.UKFPMutator", Mutator="UnofficialKFPatch.UKFPMutator",
Replacement="UnofficialKFPatch.UKFPReplicationInfo" Replacement="UnofficialKFPatch.UKFPReplicationInfo"
)}) )})
CustomMutReplacements.Add({( CustomMutReplacements.Add({(
Mutator="UnofficialKFPatch.UKFPMutatorNW", Mutator="UnofficialKFPatch.UKFPMutatorNW",
Replacement="UnofficialKFPatch.UKFPReplicationInfo" Replacement="UnofficialKFPatch.UKFPReplicationInfo"
)}) )})
SystemServerActors.Add("IpDrv.WebServer") SystemServerActors.Add("IpDrv.WebServer")
} }

40
SML/Classes/_Logger.uc
View File

@ -1,20 +1,20 @@
class _Logger extends Object class _Logger extends Object
abstract; abstract;
enum E_LogLevel enum E_LogLevel
{ {
LL_WrongLevel, LL_WrongLevel,
LL_None, LL_None,
LL_Fatal, LL_Fatal,
LL_Error, LL_Error,
LL_Warning, LL_Warning,
LL_Info, LL_Info,
LL_Debug, LL_Debug,
LL_Trace, LL_Trace,
LL_All LL_All
}; };
defaultproperties defaultproperties
{ {
} }

4
SML/Constants.uci
View File

@ -1,2 +1,2 @@
// Constants // Constants
`define NO_CONFIG 0 `define NO_CONFIG 0

6
SML/Globals.uci
View File

@ -1,3 +1,3 @@
// Imports // Imports
`include(Logger.uci) `include(Logger.uci)
`include(Constants.uci) `include(Constants.uci)

30
SML/Logger.uci
View File

@ -1,15 +1,15 @@
// Logger // Logger
`define Log_Tag 'SML' `define Log_Tag 'SML'
`define LocationStatic "`{ClassName}::" $ GetFuncName() `define LocationStatic "`{ClassName}::" $ GetFuncName()
`define Log_Base(msg, cond) `log(`msg `if(`cond), `cond`{endif}, `Log_Tag) `define Log_Base(msg, cond) `log(`msg `if(`cond), `cond`{endif}, `Log_Tag)
`define Log_Fatal(msg) `log("FATAL:" @ `msg, (LogLevel >= LL_Fatal), `Log_Tag) `define Log_Fatal(msg) `log("FATAL:" @ `msg, (LogLevel >= LL_Fatal), `Log_Tag)
`define Log_Error(msg) `log("ERROR:" @ `msg, (LogLevel >= LL_Error), `Log_Tag) `define Log_Error(msg) `log("ERROR:" @ `msg, (LogLevel >= LL_Error), `Log_Tag)
`define Log_Warn(msg) `log("WARN:" @ `msg, (LogLevel >= LL_Warning), `Log_Tag) `define Log_Warn(msg) `log("WARN:" @ `msg, (LogLevel >= LL_Warning), `Log_Tag)
`define Log_Info(msg) `log("INFO:" @ `msg, (LogLevel >= LL_Info), `Log_Tag) `define Log_Info(msg) `log("INFO:" @ `msg, (LogLevel >= LL_Info), `Log_Tag)
`define Log_Debug(msg) `log("DEBUG:" @ `msg, (LogLevel >= LL_Debug), `Log_Tag) `define Log_Debug(msg) `log("DEBUG:" @ `msg, (LogLevel >= LL_Debug), `Log_Tag)
`define Log_Trace(msg) `log("TRACE:" @ `Location `if(`msg) @ `msg`{endif}, (LogLevel >= LL_Trace), `Log_Tag) `define Log_Trace(msg) `log("TRACE:" @ `Location `if(`msg) @ `msg`{endif}, (LogLevel >= LL_Trace), `Log_Tag)
`define Log_TraceStatic(msg) `log("TRACE:" @ `LocationStatic `if(`msg) @ `msg`{endif}, (LogLevel >= LL_Trace), `Log_Tag) `define Log_TraceStatic(msg) `log("TRACE:" @ `LocationStatic `if(`msg) @ `msg`{endif}, (LogLevel >= LL_Trace), `Log_Tag)

6
builder.cfg
View File

@ -7,7 +7,7 @@ StripSource="True"
# Mutators to be compiled # Mutators to be compiled
# Specify them with a space as a separator, # Specify them with a space as a separator,
# Mutators will be compiled in the specified order # Mutators will be compiled in the specified order
PackageBuildOrder="SML" PackageBuildOrder="SML"
@ -16,7 +16,7 @@ PackageBuildOrder="SML"
# Packages you want to brew using @peelz's patched KFEditor. # Packages you want to brew using @peelz's patched KFEditor.
# Useful for cases where regular brew doesn't put *.upk inside the package. # Useful for cases where regular brew doesn't put *.upk inside the package.
# Specify them with a space as a separator, # Specify them with a space as a separator,
# The order doesn't matter # The order doesn't matter
PackagePeelzBrew="" PackagePeelzBrew=""
@ -24,7 +24,7 @@ PackagePeelzBrew=""
# Mutators that will be uploaded to the workshop # Mutators that will be uploaded to the workshop
# Specify them with a space as a separator, # Specify them with a space as a separator,
# The order doesn't matter # The order doesn't matter
PackageUpload="SML" PackageUpload="SML"

2
tools

@ -1 +1 @@
Subproject commit 88b35bd7ebb7e30448579f1564220398f990541c Subproject commit fb458ac61f7e6c6426b8dff366dd5e7499e0d95f