White Knuckle Multi Player Mod - White Knuckle Online MOD

中文 | English

Overview

This is a Unity MOD for the game White Knuckle , implementing basic networked player mapping (currently only maps grabbable player capsules).

Important Disclaimer :

• I am not a Unity/C# developer by profession.
• Some code in this project is AI-generated.
• Consequently, the quality of much of the code is likely very poor . Please use with caution.
• The online multiplayer functionality code is forked from a previous online mod project .
• You are solely responsible for assessing and bearing any risks (including but not limited to security and stability issues) associated with using this MOD for development or hosting multiplayer ports.

Known Issues:

• Chaotic object lifecycle management, which may lead to unexpected behavior.
• Currently only supports mapping player capsules; synchronization for other objects is not yet implemented.
• Using LiteNetLib requires a public IP address, LAN penetration tools, or IPv6 support; otherwise, multiplayer connection is impossible.
• Log output contains extensive Chinese text and is quite messy, requiring manual filtering for relevant information.

Potential Future Goals:

• Implement Mass height synchronization.
• Implement remote hand display.
• Utilize Steam P2P for networking.
• Implement object synchronization.
• Implement player teleportation.

Installation

Download the required .dll files from the Releases page and place them into the BepInEx/plugins directory within your game folder.

Quick Start

Prerequisites

1. Game : White Knuckle
2. Framework : BepInEx (Use a version compatible with your game version)

Installation Steps

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

Manual Installation

1. Copy the built WhiteKnuckleMod.dll file into your game directory's BepInEx\plugins\ folder.
2. Copy the dependency LiteNetLib.dll file to the same BepInEx\plugins\ folder.
3. Launch the game and check the BepInEx console or log files to confirm the MOD loaded successfully.

Project Structure

text

WhiteKnuckleMod/
├── src/                          # Source code
│   └── Core/                     # Core logic module
│       ├── Patchers.cs           # Harmony patch class
│       ├── MultiPlayerMain.cs    # BepInEx plugin entry point, manages lifecycle
│       └── MultiPlayerCore.cs    # Core functionality class
├── lib/                          # External dependency libraries (must be added manually)
│   └── README.md                 # Instructions for obtaining dependencies
├── WhiteKnuckleMod.sln           # Visual Studio Solution file
├── WhiteKnuckleMod.csproj        # Project configuration file
└── README.md                     # This document

Development Guide

Environment Setup

1. Install .NET SDK : Download and install from the Microsoft .NET website.
2. Restore NuGet Packages : Run dotnet restore in the project root directory.
3. Obtain Game DLLs : It is essential to follow the instructions in lib/README.md to acquire the necessary game DLL files and place them in the lib/ directory.

Dependency Notes

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.dll
• UnityEngine.dll
• UnityEngine.CoreModule.dll
• etc. (See lib/README.md for details).

Key Build Configuration

The project file (WhiteKnuckleMod.csproj) is configured with key references and build targets, ensuring TargetFramework is set to netstandard2.1 and allowing unsafe code.

MOD Features Details

Online Functionality

After enabling cheats (cheats) in the game, use the following commands:

• host <port> [max players] - Create a host server.
  • Example: host 22222
• join <IP address> <port> - Join an existing host server.
  • Example: join 127.0.0.1 22222 or join [::1] 22222
• leave - Leave the current host server.

Configuration Options

There are no configurable options at this time.

Contributing

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.

Contribution Process

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/YourAmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/YourAmazingFeature).
5. Open a Pull Request.

Code Style Suggestions

• Try to follow common C# naming conventions.
• Add comments to explain critical sections.
• Please test new features thoroughly.

Important Copyright Notice:

• The game White Knuckle and its related DLL files are copyright of their respective developers/publishers.
• Use of this MOD requires you to own a legitimate copy of the game White Knuckle .

Acknowledgments

• Harmony - A powerful .NET runtime patching library.
• BepInEx - An excellent plugin framework for Unity games.
• White Knuckle Game Community - For inspiration and testing assistance.
• Original Online Mod Author(s) - For laying the groundwork with their open-source code.

Contact

• GitHub Issues : Submit issues or suggestions here
• Discord : https://discord.com/invite/f2CqdmUSap
• QQ Group : 596296577
• Author : Shenxl - [email protected]