Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
d3827c9e5a
|
|||
330322dfa0
|
|||
256f3df4e8 | |||
2a3a56043e | |||
d976e94696 | |||
2f035c60bd | |||
cb8140f705 | |||
2293ce47e8 | |||
83ef34bf34 | |||
cfa8257071 | |||
42c844fffd | |||
64893b7484 | |||
0a5e62e3e7 | |||
98194b3917 | |||
7a6fca9462 |
33
.editorconfig
Normal file
33
.editorconfig
Normal 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
72
.github/workflows/mega-linter.yml
vendored
Normal 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
|
10
DEV.md
10
DEV.md
@ -2,7 +2,7 @@
|
||||
|
||||
**SML compatible mutator development guide**
|
||||
|
||||
# Mutator template
|
||||
## Mutator template
|
||||
|
||||
You can use this template to make the mutator compatible with SML.
|
||||
Here I will use `Example` as mutator name. **Replace it with yours.**
|
||||
@ -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.
|
||||
|
||||
# Limitations
|
||||
## Limitations
|
||||
❌ 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.
|
||||
|
||||
# Tips
|
||||
## Tips
|
||||
## 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:
|
||||
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.
|
||||
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).
|
||||
|
||||
## 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:
|
||||
```unrealscript
|
||||
WorldInfo.Game.DefaultPawnClass = class'ExamplePawn_Human'; // Put this to `PostBeginPlay()` of your Example.uc
|
||||
|
27
README.md
27
README.md
@ -1,19 +1,26 @@
|
||||
# KF2-SafeMutLoader
|
||||
|
||||
[](https://github.com/GenZmeY/KF2-SafeMutLoader/releases)
|
||||
[](https://github.com/GenZmeY/KF2-SafeMutLoader/actions/workflows/mega-linter.yml)
|
||||
[](https://github.com/GenZmeY/KF2-SafeMutLoader/releases)
|
||||
[](LICENSE)
|
||||
|
||||
## Description
|
||||
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).**
|
||||
|
||||
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!**
|
||||
|
||||
# Usage (server only)
|
||||
## Usage (server only)
|
||||
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`
|
||||
* **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:
|
||||
```
|
||||
```text
|
||||
?Mutator=SML.Mut,UnofficialKFPatch.UKFPMutator,AAL.AALMut,DiscordMessage.DMMutator,YAS.YASMut,CTI.CTIMut,CVC.CVCMut,ZedSpawner.ZedSpawnerMut
|
||||
```
|
||||
(add/remove **compatible** mutators you need)
|
||||
@ -24,7 +31,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 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
|
||||
🟢 [Admin Auto Login](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
|
||||
🟢 [Controlled Vote Collector](https://steamcommunity.com/sharedfiles/filedetails/?id=2847465899)
|
||||
@ -33,15 +40,17 @@ Purchasing a DLC weapon will unrank the server if currently there is no player w
|
||||
Since KF2 [v1133](https://wiki.killingfloor2.com/index.php?title=Update_1133_(Killing_Floor_2)) the content preload causes the server to unrank for some reason. Disable it in CTI settings (`bPreloadContent=False`) to stay ranked.
|
||||
🟢 [Discord Link [Edited]](https://steamcommunity.com/sharedfiles/filedetails/?id=2891475864)
|
||||
🟢 [Looted Trader Inventory](https://steamcommunity.com/sharedfiles/filedetails/?id=2864857909)
|
||||
🟡 [StartWave](https://github.com/GenZmeY/KF2-StartWave)
|
||||
`mutate startwave X` command not working.
|
||||
🟢 [Unofficial Killing Floor 2 Patch](https://steamcommunity.com/sharedfiles/filedetails/?id=2875147606)
|
||||
🟢 [Yet Another Scoreboard](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524)
|
||||
🟡 [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.
|
||||
|
||||
# Making SML-compatible mutators
|
||||
## Making SML-compatible mutators
|
||||
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.
|
||||
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:
|
||||
@ -54,9 +63,9 @@ See [developer guide](https://github.com/GenZmeY/KF2-SafeMutLoader/blob/master/D
|
||||
`./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
|
||||
## 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](https://github.com/GenZmeY/KF2-SafeMutLoader/issues))
|
||||
|
||||
# License
|
||||
[GNU GPLv3](LICENSE)
|
||||
## License
|
||||
[](LICENSE)
|
||||
|
@ -129,6 +129,7 @@ private function ModifyLoad()
|
||||
`Log_Info("Loader modified, do server travel...");
|
||||
|
||||
WorldInfo.ServerTravel(LoadURL, true);
|
||||
WorldInfo.ForceGarbageCollection(true);
|
||||
}
|
||||
|
||||
private static function String Subst(String Option)
|
||||
@ -138,5 +139,5 @@ private static function String Subst(String Option)
|
||||
|
||||
defaultproperties
|
||||
{
|
||||
|
||||
GroupNames.Add("AccessControl")
|
||||
}
|
@ -28,15 +28,22 @@ public function PreBeginPlay()
|
||||
}
|
||||
|
||||
public function PostBeginPlay()
|
||||
{
|
||||
`Log_Trace();
|
||||
|
||||
Super.PostBeginPlay();
|
||||
|
||||
RestoreServerActors();
|
||||
|
||||
SetTimer(2.0f, false, nameof(CheckStatus));
|
||||
}
|
||||
|
||||
private function CheckStatus()
|
||||
{
|
||||
local KFGI_Access KFGIA;
|
||||
|
||||
`Log_Trace();
|
||||
|
||||
Super.PreBeginPlay();
|
||||
|
||||
RestoreServerActors();
|
||||
|
||||
KFGIA = GetKFGIA();
|
||||
if (KFGIA == None)
|
||||
{
|
||||
@ -318,6 +325,9 @@ private static function class<Actor> GetMutStringReplacement(String MutString)
|
||||
|
||||
defaultproperties
|
||||
{
|
||||
// Looks like this method is no longer needed to load UKFP
|
||||
// But I'll leave this commented just in case
|
||||
/*
|
||||
CustomMutReplacements.Add({(
|
||||
Mutator="UnofficialKFPatch.UKFPMutator",
|
||||
Replacement="UnofficialKFPatch.UKFPReplicationInfo"
|
||||
@ -326,6 +336,7 @@ defaultproperties
|
||||
Mutator="UnofficialKFPatch.UKFPMutatorNW",
|
||||
Replacement="UnofficialKFPatch.UKFPReplicationInfo"
|
||||
)})
|
||||
*/
|
||||
|
||||
SystemServerActors.Add("IpDrv.WebServer")
|
||||
}
|
2
tools
2
tools
Submodule tools updated: 88b35bd7eb...fb458ac61f
Reference in New Issue
Block a user