This is a template for mods, that more organized approach to Killing Floor 1 mod development, that replaces the traditional single Classes folder with a structured sources directory. Instead of dumping all files into Classes
folder, you make a directory called sources
and organize your files in many smaller folders.
TEMPLATE_KF1_MOD_ADVANCED/
├── sources/
│ ├── my actors/
│ │ └── my_actor.uc
│ ├── other/
│ │ ├── ...uc
│ │ └── dummy.uc
│ └── TemplateMut.uc
└── your other non-source files
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Important
Key information users need to know to achieve their goal.
Warning
Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
Spoiler Text Example!
Note that it's important to have a space after the summary tag. You should be able to write any markdown you want inside the <details>
tag... just make sure you close <details>
afterward.
Here, take a pic from our media folder.
log("I'm a pepe!");
Detailed information how to enable your mod - for example, add TEMPLATE_KF1_MOD_ADVANCED.TemplateMut
to your mod list in the server's launch script or KFMapVotingV2 config.
Or in a short, easy to copy-paste way:
Mutator=TEMPLATE_KF1_MOD_ADVANCED.TemplateMut
Note
If your mod depends on other mods, don't forget to mention it and give links to sources.
add your dependencies if there any!
EditPackages=TEMPLATE_KF1_MOD_ADVANCED
This template relies on KFCompileTool, here is a config entry for it.
Link to workshop? And you can keep description file here to make Steam Workshop updates easier.
Be nice and provide releases, in same consistent format. Here is an example for you.
Pick an appropriate license for your mod, so people would know whether they can distribute, contribute or share it.