Repo ↗ · 原始 README ↗ · 文件包(Markdown/授權)

封面參考(原作): Killing Floor · 原作宣傳圖,由 IGDB 提供。圖片版權屬原權利人,供辨識原作使用,不代表此重寫/模組專案的實際畫面。

來源維護者: Scronkfinkle · 版本: 8586d1f2d3a0 · 整理日期: 2026-10-12

文件授權: MIT · LICENSE-APACHE · LICENSE-MIT · 本文形式: README 翻譯

下文為來源 README 的繁中翻譯,由 Kirikirin 使用 AI 輔助整理;功能、完成度與測試結果均為原作者描述,本站未逐項實機驗證。圖片改為來源連結,指令與技術識別保留原文。


Open KF

一個從零開始、以 Rust + Bevy 重新實作的《Killing Floor》(2009),會從已安裝的遊戲複本讀取原版遊戲檔案。可單人遊玩,並有實驗性的合作多人模式(見 MULTIPLAYER.md)。此儲存庫不包含任何遊戲素材。

README 圖片:Open KF on KF-WestLondon: wave 1, Clots coming out of the tunnel, KF’s HUD

Open KF 中的 KF-WestLondon:第 1 波,手持霰彈槍,商人距離 29 公尺。

關於其運作方式與計畫,請見 docs/DESIGN.md。

需求

一份已安裝的《Killing Floor》(Steam)。Open KF 會透過 Steam 找到它(每個 Steam 媒體庫,包括 Steam Flatpak 與其他磁碟上的媒體庫)。將 KF_ROOT 設為其資料夾即可覆寫。如果你沒有原版遊戲檔案,這將無法運作。

遊玩

從 Releases 頁面 下載最新組建:

  • Windows: open-kf-windows-x86_64.zip。解壓縮並執行 open-kf.exe。
  • Linux: open-kf.flatpak。使用
    flatpak install --user open-kf.flatpak 安裝,然後從你的
    應用程式選單或使用 flatpak run io.github.scronkfinkle.OpenKF 啟動 Open KF。它可以讀取
    一般的 Steam 資料夾;若 Steam 媒體庫位於其他位置,請執行
    flatpak override --user --filesystem=/path/to/library:ro io.github.scronkfinkle.OpenKF
    一次。其日誌、設定與螢幕擷取畫面位於
    ~/.var/app/io.github.scronkfinkle.OpenKF/data/。

在任一系統上,啟動器會先開啟。選擇 Solo、Host 或 Join、地圖、你的名稱、技能與
角色,然後按下 PLAY。你的選擇會保留到下次使用。

README 圖片:The Open KF launcher: Solo / Host / Join, the map list, perk and character, game and display options

啟動器。它將執行的命令顯示於底部;相同
選項可在命令列輸入(如下)。

從原始碼建置

需要支援 flakes 的 Nix:direnv allow 或 nix develop 會提供你 Rust 與
Bevy 所需的系統函式庫。flake 檔案必須由 git 追蹤
(git add flake.nix flake.lock),否則 Nix 不會看到它們。在
開發期間,遊戲也會先查看 references/killing_floor(指向
你安裝位置的連結),再詢問 Steam。

cargo run --release   # opens the launcher, as above

命令列選項

發行組建接受相同選項:open-kf.exe --map KF-Offices,或
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)

用於檢查檢視器的已儲存視圖列於 docs/test-views.md。

控制 動作
滑鼠左鍵 擷取滑鼠(環顧四周所需)
Escape 釋放滑鼠
滑鼠 環顧
W A S D 移動
Space 或 E / Ctrl 或 Q 上升 / 下降
Shift 以 4 倍速度移動
F12 螢幕擷取畫面至 work/screenshots/,並附上可重現該視圖的 .txt 命令
F9 開始 / 停止錄影至 work/videos/(30 fps、H.264、寬度最高 1280);視窗標題會顯示 [REC]
V 在飛行與步行之間切換
1 2 3 4 5 武器欄位:近戰、手槍、主要、特殊、裝備;再次按下可在欄位內循環(KF 的規則)
滑鼠滾輪 下一把 / 上一把武器
滑鼠左鍵(已擷取滑鼠) 射擊
滑鼠中鍵(已擷取滑鼠) 次要射擊(KF 的按鍵):近戰重攻擊;步槍上的全自動 / 半自動切換(HUD 顯示 [AUTO] / [SEMI])
滑鼠右鍵(已擷取滑鼠) 瞄準器開啟 / 關閉;在 Crossbow 與 M99 上為 3D 瞄準鏡
R 重新裝填
Z 在你面前生成一隻 zed(更多會並排生成);HUD 會顯示哪一種
N 變更 Z 生成的對象(全部十種 specimen)
G 投擲破片手榴彈(HUD:FRAGS)
Q 快速治療:拿出 Syringe、注射、切換回來(HUD:SYRINGE %)
H 在你面前生成一隻 Gorefast
X 暫停 / 繼續 zeds
F1 無敵模式開啟 / 關閉(除錯行顯示 “(GOD)”)
F2 立即進入 zed time(除錯)
F3 顯示 / 隱藏頂端的除錯行
Space(步行時) 跳躍
E(在開放商店中、波次之間) 商人的選單(NuMenu):滑鼠,或 Up/Down、Tab、Enter/B 購買、S 販售、R 補滿彈藥、A 全部補充、V 護甲、G 手榴彈、Esc 關閉

每次執行都會寫入 logs/latest.log:載入了什麼(數量、載入時間)、相機
位置每秒一次(Bevy 公尺與 Unreal 單位)、影格計時,以及
結束狀態。

多人模式

最多 6 名玩家的合作模式:一名玩家主持,其他玩家只需
位址與名稱即可加入。

cargo run --release -- --map KF-Farm --mode waves --length short --host --name HostGuy
cargo run --release -- --join 127.0.0.1 --name ClientGal

連接埠、共享內容與已知限制:MULTIPLAYER.md。

建置發行版

在 main 上的某個提交推送像 v0.2.0 這樣的標籤,會在 GitHub 上建置 Windows zip 與
Flatpak,並將它們發布為一個 release
(.github/workflows/release.yml)。若要在本機建置它們:

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

發行檔案只包含 Open KF,絕不包含 Killing Floor 的檔案。

套件檢查工具

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

授權條款

依你的選擇,以 MIT(LICENSE-MIT)或 Apache 2.0(LICENSE-APACHE)雙重授權。這
僅涵蓋原始碼,不涵蓋 Killing Floor 的遊戲檔案。


授權與來源聲明

原始 README 與翻譯沿用 MIT 授權;本次修改為繁中翻譯、連結與排版調整。可修改的 Markdown、原始 README、LICENSE 與 NOTICE 收錄於頂部文件包。原作遊戲內容與商標不因此獲得授權。

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.