Placeholder Name for your KF1 Mod

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.

Bla bla bla, some general info.

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!");

Installation

Detailed information how to enable your mod - for example, add TEMPLATE_KF1_MOD_CLASSIC.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_CLASSIC.TemplateMut

Building

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_CLASSIC

You can share information and links about your custom build scripts, if you have them. Or advise existing ones, like KFCompileTool. For later one, here is a config entry.

Steam workshop

Link to workshop? And you can keep description file here to make Steam Workshop updates easier.

Releases

Be nice and provide releases, in same consistent format. Here is an example for you.

Licenses

Pick an appropriate license for your mod, so people would know whether they can distribute, contribute or share it.