Repo ↗ · Source README ↗ · Markdown & license bundle
Image reference (original game): Killing Floor · original-game artwork, provided by IGDB. Image rights remain with their respective owners. This illustrates the referenced original game, not the actual visuals of this rewrite or mod.
Source maintainer: Scronkfinkle · Revision: 8586d1f2d3a0 · Catalogued: 2026-10-12
Source license: MIT · LICENSE-APACHE · LICENSE-MIT · Article: Source README (format adapted)
The source README follows, with formatting adapted for this site and images replaced by source links. Feature, completion and testing claims belong to its authors and have not been independently playtested here. The Traditional Chinese translation was prepared with AI assistance.
Open KF
A from-scratch Rust + Bevy reimplementation of Killing Floor (2009), reading the
original game’s files from an installed copy. It plays single-player, and
has experimental co-op multiplayer (see MULTIPLAYER.md).
No game assets are included in this repository.
README image：Open KF on KF-WestLondon: wave 1, Clots coming out of the tunnel, KF’s HUD
KF-WestLondon in Open KF: wave 1, shotgun in hand, the trader 29 m away.
See docs/DESIGN.md for how it works and the plan.
Requirements
An installed copy of Killing Floor (Steam). Open KF finds it through Steam
(every Steam library, including the Steam Flatpak and libraries on other
drives). Set KF_ROOT to its folder to override. This will not work if
you don’t have the original game files.
Playing
Download the latest build from the
Releases page:
- Windows:
open-kf-windows-x86_64.zip. Unzip it and runopen-kf.exe. - Linux:
open-kf.flatpak. Install it with
flatpak install --user open-kf.flatpak, then start Open KF from your
app menu or withflatpak run io.github.scronkfinkle.OpenKF. It can read
the usual Steam folders; for a Steam library elsewhere, run
flatpak override --user --filesystem=/path/to/library:ro io.github.scronkfinkle.OpenKF
once. Its logs, settings and screenshots are in
~/.var/app/io.github.scronkfinkle.OpenKF/data/.
On either system the launcher opens first. Pick Solo, Host or Join, a map, your name, perk and
character, then press PLAY. Your choices are remembered for next time.
The launcher. The command it will run is shown at the bottom; the same
options can be typed on the command line (below).
Building from source
Needs Nix with flakes: direnv allow or nix develop gives you Rust and the
system libraries Bevy needs. The flake files must be tracked by git
(git add flake.nix flake.lock) or Nix will not see them. During
development the game also looks in references/killing_floor (a link to
your install) before asking Steam.
cargo run --release # opens the launcher, as above
Command-line options
The release builds take the same options: open-kf.exe --map KF-Offices, or
flatpak run io.github.scronkfinkle.OpenKF --map KF-Offices.
cargo run --release # no options: the launcher (pick map, perk, solo/host/join, then PLAY)
cargo run --release -- --mode debug # what no options used to do: KF-WestLondon, no waves
cargo run --release -- --map KF-Offices # any map name from the game's Maps folder
cargo run --release -- --frames 300 # quits by itself after 300 frames (for test runs)
cargo run --release -- --fly --camera -4090,1300,-3650,-1.5708,0 --screenshot 60 # start at a saved view, screenshot, quit
cargo run --release -- --fly # start flying (the map viewer); V switches between flying and walking
cargo run --release -- --autowalk 4 # walk test: hold forward for 4 s (see logs/latest.log "walk" lines)
cargo run --release -- --fly --input 120:fire,200:1 --screenshot 126,330 # scripted input + screenshots (tests)
cargo run --release -- --zed # a Clot spawns in front of you and comes at you
cargo run --release -- --gorefast # the same with a Gorefast
cargo run --release -- --spawn fleshpound # any specimen: clot, gorefast, crawler, stalker, bloat, siren, husk, scrake, fleshpound, patriarch
cargo run --release -- --spawn patriarch --god --input 300:record,600:record # test: record a 5 s video (scripted F9)
cargo run --release -- --spawn clot --god # god mode: zeds hit you (logged) but you lose no health
cargo run --release -- --zed --always-sever # test: killing shots on limbs always sever them
cargo run --release -- --give all # test: carry every base-game weapon (or --give AK47AssaultRifle,Shotgun)
cargo run --release -- --input 200:sound:KF_9MMSnd.9mm_Fire,300:sound_at:KF_9MMSnd.9mm_Fire@600 # test: play a sound at you, then 600 units to your right
cargo run --release -- --input 200:jump # test action: jump (also "jump" in any --input list)
scripts/headless.sh --fly --camera -4090,1300,-3650,-1.5708,0 --screenshot 60 # the same, on a virtual display: no window opens
cargo run --release -- --no-vsync --frames 600 # test runs: frames do not wait for the display (a hidden window ran at 1 fps)
cargo run --release -- --mute # no sound (still logged)
cargo run --release -- --trader-menu nu # our NuMenu trader menu instead of the classic KF one (the default)
cargo run --release -- --fps 30 # cap the frame rate (vsync still caps it at the monitor's refresh rate)
cargo run --release -- --window 1600x900 --display fullscreen # graphics (also in the launcher): --display windowed|borderless|fullscreen,
# --window WxH, --fov 80-120, --brightness 50-200 (%), --msaa 0|2|4|8, --anisotropy 1|2|4|8|16
cargo run --release -- --gamma-ramp off # KF's gamma ramp (on by default: Brightness 0.8, Contrast 0.7, Gamma 0.8); or --gamma-ramp B,C,G
cargo run --release -- --zed --zed-at -4512,-230,-3816 # test: the zed starts at a map position (Unreal X,Y,Z)
Saved views for checking the viewer are listed in docs/test-views.md.
| Control | Action |
|---|---|
| Left click | capture the mouse (needed to look around) |
| Escape | release the mouse |
| Mouse | look |
| W A S D | move |
| Space or E / Ctrl or Q | up / down |
| Shift | move 4x faster |
| F12 | screenshot to work/screenshots/, with a .txt command that recreates the view |
| F9 | start / stop recording a video to work/videos/ (30 fps, H.264, up to 1280 wide); the window title shows [REC] |
| V | switch between flying and walking |
| 1 2 3 4 5 | weapon slots: melee, pistols, primary, specials, equipment; press again to cycle within a slot (KF’s rules) |
| Mouse wheel | next / previous weapon |
| Left click (mouse captured) | fire |
| Middle click (mouse captured) | alt fire (KF’s key): melee heavy attacks; full / semi auto switch on rifles (HUD shows [AUTO] / [SEMI]) |
| Right click (mouse captured) | iron sights on / off; on the Crossbow and M99 the 3D scope |
| R | reload |
| Z | spawn a zed in front of you (more spawn side by side); the HUD shows which |
| N | change what Z spawns (all ten specimens) |
| G | throw a frag grenade (HUD: FRAGS) |
| Q | quick heal: bring out the Syringe, inject, switch back (HUD: SYRINGE %) |
| H | spawn a Gorefast in front of you |
| X | pause / resume zeds |
| F1 | god mode on / off (the debug line shows “(GOD)”) |
| F2 | zed time now (debug) |
| F3 | show / hide the debug line at the top |
| Space (walking) | jump |
| E (in an open shop, between waves) | the trader’s menu (NuMenu): mouse, or Up/Down, Tab, Enter/B buy, S sell, R fill ammo, A refill all, V armour, G grenade, Esc close |
Each run writes logs/latest.log: what was loaded (counts, load time), camera
position once per second (Bevy metres and Unreal units), frame timings, and
exit status.
Multiplayer
Co-op for up to 6 players: one player hosts, the others join with just the
address and a name.
cargo run --release -- --map KF-Farm --mode waves --length short --host --name HostGuy
cargo run --release -- --join 127.0.0.1 --name ClientGal
Ports, what is shared, and known limits: MULTIPLAYER.md.
Building releases
Pushing a tag like v0.2.0 on a commit on main builds the Windows zip and
the Flatpak on GitHub and publishes them as a release
(.github/workflows/release.yml). To build them locally:
nix build .#open-kf # Linux (Nix): result/bin/open-kf
nix build .#windows -o result-windows # Windows: result-windows/open-kf-windows-x86_64.zip
nix run .#flatpak # Flatpak: work/flatpak/open-kf.flatpak
Release files contain only Open KF, never Killing Floor’s files.
Package inspection tool
cargo run --release -p ue-assets --bin kfpkg -- scan # parse every package
cargo run --release -p ue-assets --bin kfpkg -- info Maps/KF-Farm.rom # objects by class
cargo run --release -p ue-assets --bin kfpkg -- exports Maps/KF-Farm.rom Light
cargo run --release -p ue-assets --bin kfpkg -- props Maps/KF-Farm.rom Light # writes work/props/KF-Farm-Light.txt
cargo run --release -p ue-assets --bin kfpkg -- scanprops # read properties of every object
cargo run --release -p ue-assets --bin kfpkg -- scripts # UnrealScript source -> work/scripts/
cargo run --release -p ue-assets --bin kfpkg -- textures # decode every texture (checks)
cargo run --release -p ue-assets --bin kfpkg -- texture Textures/KillingFloorTextures.utx House2SkinNEW # -> work/textures/*.png
cargo run --release -p ue-assets --bin kfpkg -- meshes # decode every static mesh (checks)
cargo run --release -p ue-assets --bin kfpkg -- level KF-Farm # load a map like the viewer, report counts
cargo run --release -p ue-assets --bin kfpkg -- bspmaterials KF-WestLondon # per-material BSP report -> logs/
cargo run --release -p ue-assets --bin kfpkg -- zones KF-WestLondon [25] # BSP zones; with a number, that zone's polygons
cargo run --release -p ue-assets --bin kfpkg -- terrain KF-Farm [X,Y] # terrain layers, height check; ground height at X,Y
License
Dual-licensed under MIT (LICENSE-MIT) or Apache 2.0 (LICENSE-APACHE), at your
option. This covers the source code only, not Killing Floor’s game files.
License and provenance
The README and its translation retain MIT terms. Changes comprise translation, links and formatting. Editable Markdown, the original README, LICENSE and NOTICE files are included in the linked bundle. This grants no rights to the original games, their assets or trademarks.
LICENSE-APACHE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
LICENSE-MIT
MIT License
Copyright (c) 2026 Open KF contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Comments
…