中文 | English
This is a Unity MOD for the game White Knuckle , implementing basic networked player mapping (currently only maps grabbable player capsules).
Important Disclaimer :
Known Issues:
Potential Future Goals:
graph RL
%% Module 1: Player Display
subgraph Player Display
1d[Display Other Players' Held Items]
end
%% Module 2: Player Interaction
subgraph Player Interaction
2b[Item Grabbing/Stealing]
2c[Add New Items]
2e[Respawn After Death]
end
%% Module 3: Data Synchronization
subgraph Data Synchronization
3a["Sync Man-made Structures (Rock Bolts, Rebars)"]
3c[Sync Pickup Items]
3e[Sync Entity Data]
end
%% Dependency Connections (cross-module and within modules)
1d --> 2b
Download the required .zip file from the Releases page, then extract it into the BepInEx/plugins folder in your game directory.
After enabling cheat mode (cheats) in-game, use the following commands:
host <lobby_name> [max_players] - Create a lobby.
host abcdegetlobbyid - Get the lobby room code.join <room_code> - Join a lobby using the room code.
join 109775241951624817talk <text> - Speak via the overhead label.
talk help megetallplayer - Get all player name and steamIdtpto <steamId(suffix match)> - Teleport between players
tpto 16422 or tpto 22 (target steamId: 561198279116422)Join lobbies using the main menu UI
New commands:
getalllobby – Get information about all lobbies, including lobby codes and current player countsjoin <name> – Join a lobby by its name. If multiple lobbies share the same name, joining by name will fail; please use the lobby code instead.
changename <name> – Change the lobby name. Can only be used by the host.
changename newnamechangemodel <model name> – Change the remote player model. Currently supports default and slugcat.
Example: changemodel slugcatAfter enabling cheat mode (cheats) in-game, use the following commands:
host <port> [max_players] - Host a server.
host 22222join <ip_address> <port> - Join an existing host server.
join 127.0.0.1 22222 or join [::1] 22222leave - Leave the current host server.In BepInEx/plugins/shenxl.MultiPlayerMod.cfg
[Network]
## Sets how many times per second data is sent to other players.
# Setting type: Int32
DataSendFrequency = 20
[RemotePlayer]
## This value sets the scale size for player name tags above their heads.
# Setting type: Single
NameTagScale = 1
## Sets the model used for remote players. Default is 'default', you can set it to 'slugcat' to use the slugcat model.
# Setting type: String
Model = default
[RemotePlayerPvP]
##
## DAMAGE TYPE REFERENCE:
## ---------------------
## Note: ×N means deals N instances of this damage type.
##
## * Hammer - Type: Hammer, Damage: 1 (Hammer)
## * Auto Piton - Type: piton, Damage: 3 (Auto Piton)
## * Brick - Type: , Damage: 3 (Brick)
## * Flare Gun - Type: flare, Damage: 6 (Flare Gun)
## * Rebar/Bone Spears - Type: rebar, Damage: 10 (Rebar/Bone spears)
## * Rope Rebar - Type: , Damage: 10 (Rope Rebar)
## * Artifact Spear (throw/return) - Type: returnrebar, Damage: 10 (Artifact Spear)
## * Explosive Rebar - Type: explosion, Damage: 10 - Type: rebarexplosion, Damage: 10 (Explosive Rebar)
## * Cryo-Gun (uncharged/charged) - Type: ice, Damage: 10 - Type: , Damage: 0 × 2 (Cryo-Gun)
##
## The Active configuration item controls the damage multiplier dealt by players.
## The Passive configuration item controls the damage multiplier received by players.
##
## Formula:
## Final Damage = Base Damage × AllActive Multiplier × AllPassive Multiplier × Corresponding Type Active Multiplier × Corresponding Type Passive Multiplier
## Multiplier for all damage dealt by the player.
# Setting type: Single
AllActive = 0.2
## Multiplier for all damage received by the player.
# Setting type: Single
AllPassive = 1
## Multiplier for hammer damage dealt by the player.
# Setting type: Single
HammerActive = 5
## Multiplier for hammer damage received by the player.
# Setting type: Single
HammerPassive = 1
## Multiplier for rebar damage dealt by the player.
# Setting type: Single
RebarActive = 1
## Multiplier for rebar damage received by the player.
# Setting type: Single
RebarPassive = 1
## Multiplier for auto-piton damage dealt by the player.
# Setting type: Single
PitonActive = 1
## Multiplier for auto-piton damage received by the player.
# Setting type: Single
PitonPassive = 1
## Multiplier for flare gun damage dealt by the player.
# Setting type: Single
FlareActive = 1
## Multiplier for flare gun damage received by the player.
# Setting type: Single
FlarePassive = 1
## Multiplier for artifact spear (returnrebar) damage dealt by the player.
# Setting type: Single
ReturnRebarActive = 1
## Multiplier for artifact spear (returnrebar) damage received by the player.
# Setting type: Single
ReturnRebarPassive = 1
## Multiplier for explosion shrapnel (rebarexplosion) damage dealt by the player.
# Setting type: Single
RebarExplosionActive = 1
## Multiplier for explosion shrapnel (rebarexplosion) damage received by the player.
# Setting type: Single
RebarExplosionPassive = 1
## Multiplier for explosion shrapnel (explosion) damage dealt by the player.
# Setting type: Single
ExplosionActive = 1
## Multiplier for explosion shrapnel (explosion) damage received by the player.
# Setting type: Single
ExplosionPassive = 1
## Multiplier for cryo-gun ice spike damage dealt by the player.
# Setting type: Single
IceActive = 1
## Multiplier for cryo-gun ice spike damage received by the player.
# Setting type: Single
IcePassive = 1
## Multiplier for other damage dealt by the player.
# Setting type: Single
OtherActive = 1
## Multiplier for other damage received by the player.
# Setting type: Single
OtherPassive = 1
bash
# 1. Clone this repository locally
git clone https://github.com/Shen-X-L/WKMultiMod.git
# 2. Build the MOD
# Method A: Open and build WhiteKnuckleMod.sln in Visual Studio
# Method B: Use the command line
dotnet build -c Release
text
WhiteKnuckleMod/
├── src/Core/ # Mod core logic
│ ├─ Asset/
│ │ └─ MPAssetManager.cs # Retrieves game prefabs via Resources.FindObjectsOfTypeAll<GameObject>()
│ ├─ Component/ # Components that depend on game libraries, cannot be moved to Unity project
│ │ ├─ LocalPlayer.cs # Component class, responsible for local player positioning
│ │ └─ RemoteEntity.cs # Component class, responsible for dealing damage to other players
│ ├─ Core/
│ │ ├─ MPConfig.cs # Reads configuration file data
│ │ ├─ MPCore.cs # Core class, handles main events
│ │ ├─ MPGameModeManager.cs # Manages network-transmittable game mode data and loads corresponding game modes
│ │ └─ MPMain.cs # Startup class, initializes patches
│ ├─ Data/
│ │ ├─ DataReader.cs # Reads data from ArraySegment<byte>/byte[]
│ │ ├─ DataWriter.cs # Writes data to ArraySegment<byte>
│ │ ├─ MPDataPool.cs # Manages thread-isolated read/write object pools to avoid frequent memory allocation
│ │ ├─ MPEventBusGame.cs # In-game data bus, handles in-game event publishing and subscription
│ │ └─ MPEventBusNet.cs # Network data bus, facilitates communication between MPCore and MPSteamworks
│ ├─ NetWork/
│ │ ├─ MPLiteNet.cs # IP-based connection (currently deprecated)
│ │ ├─ MPPacketHandler.cs # Class for processing received data packets, dispatches data based on protocol
│ │ ├─ MPPacketRouter.cs # Builds packet type → handler function dictionary via reflection, calls handler based on packet type
│ │ └─ MPSteamworks.cs # Separated Steam networking logic class
│ ├─ Patch/
│ │ ├─ Patch.cs # Patches for map synchronization via unlock progress + disabled flipping
│ │ ├─ Patch_ENT_Player.cs # Patches for capturing player events
│ │ └─ Patch_SteamManager.cs # Patches for initializing MPCore via SteamManager lifecycle
│ ├─ RemotePlayer/
│ │ ├─ Factory/
│ │ │ ├─ BaseRemoteFactory.cs # Base class for remote object factories, provides interface for creating remote objects by cloning prefabs
│ │ │ └─ SlugcatFactory.cs # Factory class with special handling for Slugcat prefab model
│ │ ├─ RPContainer.cs # Handles data updates and lifecycle for a single remote player object
│ │ ├─ RPFactoryManager.cs # Creates remote player objects and adds them to RPManager for management
│ │ └─ RPManager.cs # Manages data updates and lifecycle for all remote player objects
│ ├─ Test/
│ │ ├─ Test.cs # Non-game-impacting test functions, allows quick modifications
│ │ └─ TestMonoSingleton.cs # Test MonoSingleton, allows quick modifications
│ ├─ UI/
│ │ ├─ UI_LobbyButton.cs # Lobby option button component, handles the join lobby button functionality
│ │ ├─ UI_LobbyListPane.cs # Lobby list panel component, displays the lobby list UI
│ │ └─ UI_Manager.cs # UI Manager, creates and manages UI interfaces
│ └─ Util/
│ ├─ Localization/
│ │ ├─ Localization.cs # Localization utility class, retrieves localized console text
│ │ ├─ json_sort.py # Sorts JSON files in the Localization folder
│ │ ├─ texts_en.json # English texts
│ │ └─ texts_zh.json # Chinese texts
│ ├─ MonoSingleton.cs # Base class for Unity component singletons, provides singleton pattern implementation for Unity
│ └─ Singleton.cs # Base class for regular singletons, provides generic singleton pattern implementation
│
├── src/Shared/ # Extracted Unity component logic for sharing with Unity project for rapid prefab construction
│ ├─ Component/ # Components usable in Unity project
│ │ ├─ LookAt.cs # Forces label to face player, scales label to maintain constant size
│ │ ├─ ObjectIdentity.cs # Identifies the factory ID that created this object, used for proper destruction
│ │ ├─ RemoteHand.cs # Controls hand position via network data
│ │ ├─ RemotePlayer.cs # Controls player position via network data
│ │ ├─ RemoteTag.cs # Controls label content via network data
│ │ └─ SimpleArmIK.cs # Uses IK to connect arm to hand
│ ├─ Data/
│ │ ├─ HandData.cs # Hand position data
│ │ └─ PlayerData.cs # Player position data
│ ├─ MK_Component/ # Game-internal components, cannot be directly assigned, handled via mapping components
│ │ ├─ MK_CL_Handhold.cs # Mapping for in-game CL_Handhold
│ │ ├─ MK_ObjectTagger.cs # Mapping for in-game ObjectTagger
│ │ └─ MK_RemoteEntity.cs # Mapping for mod's RemoteEntity
│ └─ Util/
│ ├─ DictionaryExtensions.cs # Dictionary utility class, provides suffix matching, set difference operations, etc.
│ └─ TickTimer.cs # Debug output frequency controller
│
├── lib/ # External dependency directory (must be added manually)
│ └── README.md # Dependency acquisition guide
├── WhiteKnuckleMod.sln # Visual Studio solution file
├── WhiteKnuckleMod.csproj # Project configuration file
└── README.md # This document
dotnet restore in the project root directory.lib/README.md to acquire the necessary game DLL files and place them in the lib/ directory.Compiling this project requires referencing some DLL files from the game itself ( these files are copyrighted and must NOT be committed to this repository ), primarily including:
Assembly-CSharp.dllUnityEngine.dllUnityEngine.CoreModule.dlllib/README.md for details).The project file (WhiteKnuckleMod.csproj) is configured with key references and build targets, ensuring TargetFramework is set to netstandard2.1 and allowing unsafe code.
Welcome to submit Issues for bug reports or suggestions! Pull Requests are also welcome.
Reminder : The code quality in this project is inconsistent, and some is AI-generated. Please keep this in mind when contributing.
git checkout -b feature/YourAmazingFeature).git commit -m 'Add some AmazingFeature').git push origin feature/YourAmazingFeature).