Ultra Modding | Unreal Engine Modding

[Tutorial] Adding A Custom ZED To The Game

UltraKill — Fri, 15 Mar 2013 18:02:39 GMT

This tutorial is currently out of date due to the 1044 update. I will be amending this soon.
This tutorial will show you how to add a custom ZED into the game.

Prerequisites

Creating A Basic Mutator by Benjamin

The Mutator

Version 1
Code:
class NewSquadMut extends Mutator;var string PackageName;

function PostBeginPlay()
{
local int i;
local string MID;
local KFGameType KF;

//Add the package with your new zed to the server
if (Level.NetMode != NM_Standalone)
AddToPackageMap(PackageName);

//Only for KFGameType or and extending GameType
KF = KFGameType(Level.Game);
if (KF == none)
{
Destroy();
return;
}

// Get new slot in monster list
i = KFGameType(Level.Game).StandardMonsterClasses.Length;
KFGameType(Level.Game).StandardMonsterClasses.Length = i + 1;
MID = Chr(65 + i); //Get the next character in the alphabet

// Add monster to monster list
KFGameType(Level.Game).StandardMonsterClasses.MClassName = PackageName$".NEWZED"; KFGameType(Level.Game).StandardMonsterClasses[i].MID = MID;

// Add monster to squads
KFGameType(Level.Game).StandardMonsterSquads[25] $= "2" $ MID; //Add 2 of the new Zed to the 25th squad
KFGameType(Level.Game).StandardMonsterSquads[26] $= "1" $ MID; //Add 1 of the new Zed to the 26th squad

SetTimer(0.1, false);
}

function Timer()
{
Destroy(); // Destroy here (after mut is loaded) otherwise it won't appear as set in webadmin
}

defaultproperties
{
PackageName="CustomZedPackage"
GroupName="KF-AddToSquad"
FriendlyName="Add to squad"
Description="Adds a to squad in spawn list."
}
Breakdown

Code:
var string PackageName;function PostBeginPlay()
{
local int i;
local string MID;
local KFGameType KF;
We declare the variables we will be using. Again [i]PostBeginPlay() play because we want to make these changes before we start the match.

Code:
if (Level.NetMode != NM_Standalone) AddToPackageMap(PackageName);
This statement checks to see if the game is a server or not. If it is a server it adds the package to the serverpackages. Similar to thebAddToServerPackages mutator variable. The difference being that this way allows the zed package to be dependent of the mutator you are using.
Code:
KF = KFGameType(Level.Game);if (KF == none)
{
Destroy();
return;
}
Here is an alternative to the error check we had in the previous ZED mutator. This works the same way, the difference being instead of logging the error it simply kills the mutator.
Code:
i = KFGameType(Level.Game).StandardMonsterClasses.Length;KFGameType(Level.Game).StandardMonsterClasses.Length = i + 1;
MID = Chr(65 + i);
Here we define i the value of the StandardMonsterClasses array length. Then we define a new array length by adding 1 to i. As each squad is assigned a letter we need to find the next avalible one. Becuase we've already found out the array length we can use i to do this as well. In the Uni8 encoding the alphabet begins at 65. So 65 is A, 65+8 would be I.
Code:
KFGameType(Level.Game).StandardMonsterClasses.MClassName = PackageName$".NEWZED";KFGameType(Level.Game).StandardMonsterClasses[i].MID = MID;
Now we use the information we've built to add our custom ZED to the standard monster load out. But that's not enough to get him in the game. [i]KFGameType calls on squads though out the game. So let's add our ZED to some existing squads.
Code:
KFGameType(Level.Game).StandardMonsterSquads[25] $= "2" $ MID;KFGameType(Level.Game).StandardMonsterSquads[26] $= "1" $ MID;
There are currently 26 squads in KF, so lets add him to the last two. Two in squad 25, One in 26.

Finally
Code:
SetTimer(0.1, false);}
So we can destroy the mutator after it has loaded, as it's no longer needed. We also do this so the WebAdmin can flag the mutator as on. Destroy it too early and WebAdmin wouldn't know the mutator was active.
Code:
function Timer(){
Destroy();
}
Finally we add the defualt properties
Code:
defaultproperties{
PackageName="CustomZedPackage"
GroupName="KF-AddToSquad"
FriendlyName="Add to squad"
Description="Adds a to squad in spawn list."
}
You're done.

I'd like to thank matttthias aka J1gS4w for the code on this one. In his words "I want to do something for the community because they helped me so much to start with coding." Honourable mention to Benjamin for the original code.
Part 2 to follow soon.

---
Gartley

Creating a Basic Mutator

UltraKill — Fri, 15 Mar 2013 17:39:25 GMT

Prerequisites: Killing Floor SDK (Steam->Library->Tools)

Creating a Basic Mutator

Step-by-step Instructions

1. Create directory hierarchy

Create a directory in .../steamapps/common/killingfloor with the same name you wish to give your mutator. Create a subdirectory inside this named Classes. You should now have a directory structure that looks like this:

.../steamapps/common/killingfloor/ExampleMutator/Classes

2. Create main mutator script file

Inside the classes subdirectory create a file with a .uc extension with a name matching the mutator's main directory name, for example ExampleMutator.uc. The path of this file should look like this:

.../steamapps/common/killingfloor/ExampleMutator/Classes/ExampleMutator.uc

3. Tell compiler we want to include this mutator in the compilation

In order to have the compiler actually compile your mutator you must add an entry for it in a file named killingfloor.ini, located in the game's system directory. Open this file, search for the section with several lines beginning with EditPackages=PackageName. Add an entry at the bottom of this list to include the name of your mutator package, which should look like this:

EditPackages=ExampleMutator

4. Add some code to the mutator script

Code:
class ExampleMutator extends Mutator;defaultproperties
{
GroupName="KFExampleMutator"
FriendlyName="Example Mutator"
Description="Mutator description here"
}
This is the bare minimum for compiling a mutator that can be seen in Killing Floor (actually, FriendlyName and Description aren't strictly necessary but why compile without them?). The GroupName property must start with the letters KF else it won't be seen by the game.

5. Compile using UCC

Compiling the mutator is as simple as calling ucc make, which can be found in the system directory (in fact the file is simply calleducc.exe and make is a command line argument). Note that if you have previously compiled the mutator you must remove its .u file from the system directory in order to recompile (otherwise the mutator will be ignored in the compilation process).

If you cannot find ucc.exe you may not have the Killing Floor SDK installed. Find it on Steam in the 'tools' section.

Additionally you may want to remove certain files and have the console wait before closing, so that you can view the compilation output (and thus determine if it failed and why). You could do all this by opening command prompt and typing the commands manually, but it's far simpler to use a batch file. Create a batch file (anywhere - the desktop is good for easy access) with a name such as ExampleMutator.bat and copy the following lines in:

Code:
del "C:\Program Files\Steam\steamapps\common\killingfloor\System\ExampleMutator.u""C:\Program Files\Steam\steamapps\common\killingfloor\System\UCC.exe" make
del "C:\Program Files\Steam\steamapps\common\killingfloor\System\steam_appid.txt"
pause
You may need to alter the paths if you have the game installed to a different hard drive or have a different directory structure. The third line removes a file generated by UCC which while exists will prevent connecting to servers (may not apply to all).

Run the batch file and tada! If compilation was successful, you have just made your first mutator. If not, you have made a mistake.

6. Functional mutator example

Here is a functional, more interesting mutator to take a look at:

Code:
class ExampleMutator extends Mutator;function PostBeginPlay()
{
SetTimer(1, true);
}

function Timer()
{
local KFHumanPawn Player;

foreach DynamicActors(class 'KFHumanPawn', Player)
{
if (Player.Health + 2 <= Player.HealthMax) Player.Health += 2;
else Player.Health = Player.HealthMax;
}
}

defaultproperties
{
GroupName="KFExampleMutator"
FriendlyName="Example Mutator"
Description="Mutator description here"
}
What does it do? It increases the health of each player by 2 points every second.

7. Where do I go from here?

Now that you understand how to compile a mutator, I'd recommend first taking a look at the official UnrealScript Language Referencewhich covers all aspects of the language itself. If you plan to write mutators which work online it's vital that you understand how the networking is handled, and I'd suggest reading the Unreal Networking Architecture article on this. If you want to know more about the engine (and particularly which classes are available to use) you can either browse through the script files yourself, or check out theBeyondUnreal Wiki.

I'd recommend getting a good text editor with support for line numbers (I suggest Notepad++ for this) and a search tool for searching the entire library of script files for finding where specific classes and variables are defined (I'd recommend Windows Grep as it's powerful, fast, and free).

---
Benjamin

Mut : Advanced HUD ServerPerkV3

UltraKill — Fri, 15 Mar 2013 17:36:58 GMT

Mut : Advanced HUD ServerPerkV3 (Original author : Marco)

Download Link:: Click

I received Marco's ServerPerkV3 Source Code,
and added perk HUD.

If Player PerkLevel was high, displayed many StarMaterial in Original ServerPerkV3

- Commando Level 20.

So, I modified HUDKillingfloor and added this mutator.

- Perk Level is 11~15, display Green Perkicon.

-Perk Level is 16~20, display Blue Perkicon.

- Display new Perk HUD

Next, substance of Advanced HUD ServerPerkV3
- Rrebalancing All perk's abilities for perkLevel 20.
- Added Green, Blue Perk Icon. (:: KillingFloor3HUD.utx)
- Lobby, MainScreen, ScoreBoard applicated this Custom HUD.

Thanks to Marco and YoYoBatty.

Quote:
Originally Posted by Marco
This mutator brings the perks stats tracking back the way it were in KF 2.5 in Unreal Tournament 2004: All player stats are being tracked by the server individually.

Download from here. (Version 3.01)

Download source codes from here.

Upsides about this mutator:

It allows server host to run any mutator/modification/map they ever want without having to whitelist them all.
Server host can add/remove standard/custom perks.
Clients can't cheat their stats in offline games then join the server with level 5 everything.
Fixed some menu issues while at it.

And downsides of this mutator:

Clients will don't have their stats following from server to server (anything they do in that server will stay within that server)!
Archivements aren't earned.

Version history:
3.01:
- Fixed minor problems with updated Firebug perk.
3.00:
- Updated to support updated perks in latest KF version.
- Updated network codes of this mod to resolve some other bugs.
- Added 'Maximum perk levels' value for defining max level you can get (you can set max level up to 254).
- Added 'Requirements scaler' to scale the requirements (1 = default, 0.5 = half scaling; i.e: 60 headshot kills becomes 30 headshot kills).
- Added Mutator config/Webadmin config pages for some settings of this mutator.
2.55:
- This time (hopefully) fixed the perk selection problem.
- Added option (bForceGivePerk) to force players with no perk selected to start with a random perk available.
- Added another option (bNoSavingProgress) to disable progress saving (for level 6 perks only servers).
2.30:
- Fixed perk selection in Trader and Lobby menus.
- Fixed some problems with not being able to select perk sometimes.
- While at it fixed a memory leak problem on Lobby menu.
2.10:
- Fixed an issue with demolition stats loading.
2.00:
- Fixed a crash with "SRPerkSelectList" menu.
- Updated it to work on latest KF version.
- Added in Demolition perk.
- Updated all perks to be equally to latest KF version.
- Added a new option to specify minimum perk level for all players (edit ServerPerksV2.ini).
- Added to lobby menu a "Main Menu" button where people can access perks selection and map voting.
1.00:
- Released.

How to use this mutator (eighter way):

In mutators list, add "Server Veterancy Handler V2" to active mutators.
Add to server startup commandline "?Mutator=ServerPerksV2.ServerPerksMut"

To add/remove perks, simply edit "ServerPerksV2.ini" and add/remove lines.

If there are any bugs, please report them here (or have any comments/suggestions)!